Package com.aquima.interactions.matching.impl.functions.fulltext

Class FullTextMatchFactory

java.lang.Object

com.aquima.interactions.matching.impl.functions.fulltext.FullTextMatchFactory

All Implemented Interfaces:

IMatchFunctionFactory

public class FullTextMatchFactory
extends Object
implements IMatchFunctionFactory

Factory capable of creating fulltext match functions.

Since:

6.2

Author:

O. Kerpershoek, F. van der Meer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_STOPWORD_RESOURCE	This member defines the name of the parameter which is used to locate the stopword list resource.

Constructor Summary

Constructors

Constructor	Description
FullTextMatchFactory()

Method Summary

Modifier and Type	Method	Description
IMatchFunction	getMatchFunction(String name, IMatchFunctionParameters parameters)	This method constructs a match function for a specific match type definition with the specified name and parameters.
String	getTypeName()	This method returns the type name of the match functions this factory can provide for.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PARAM_STOPWORD_RESOURCE

public static final String PARAM_STOPWORD_RESOURCE

This member defines the name of the parameter which is used to locate the stopword list resource. When this parameter is not provided, stopwords will not be used to filter index terms.

See Also:

• Constant Field Values

Constructor Details

FullTextMatchFactory

public FullTextMatchFactory()

Method Details

getTypeName

public String getTypeName()

Description copied from interface: IMatchFunctionFactory

This method returns the type name of the match functions this factory can provide for.

Specified by:

getTypeName in interface IMatchFunctionFactory

Returns:

the type name of the match functions this factory can provide for.

getMatchFunction

public IMatchFunction getMatchFunction(String name,
 IMatchFunctionParameters parameters)
                                throws InitializationException

Description copied from interface: IMatchFunctionFactory

This method constructs a match function for a specific match type definition with the specified name and parameters. After construction of this function the object is expected to be reentrant. When a match function could not be created the factory should throw an exception, when the match function could not be found a null pointer should be returned.

Specified by:

getMatchFunction in interface IMatchFunctionFactory

Parameters:

name - The name of the user created match function.

parameters - The parameters which can be used to initialize a match function with specific settings.

Returns:

A match function implementation object. If the match function was unknown null can be returned.

Throws:

InitializationException - This exception is thrown when the match function could not be initialized, for instance due to invalid parameters.