com.orchestranetworks.addon.tese

Class ParameterDefinition

java.lang.Object

com.orchestranetworks.addon.tese.ParameterDefinition

public final class ParameterDefinition
extends Object

Represents a parameter definition for an algorithm.

Since:

1.6.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOUBLE_METAPHONE_CODELENGTH
static String	FUZZY_PREFIXLENGTH
static String	FUZZY_SIMILARITY
static String	JAROWINKLER_THRESHOLD
static String	NGRAM_SIZE
static String	SEARCH_DATE_THRESHOLD
static String	SEARCH_NUMBER_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
ParameterDefinition(String name, com.orchestranetworks.schema.SchemaTypeName type, com.onwbp.base.text.UserMessage description, String value)
ParameterDefinition(String name, com.orchestranetworks.schema.SchemaTypeName type, com.onwbp.base.text.UserMessage description, String value, com.onwbp.base.text.UserMessage detailedDescription)

Method Summary

Modifier and Type	Method and Description
com.onwbp.base.text.UserMessage	getDescription() Returns a parameter's description.
com.onwbp.base.text.UserMessage	getDetailedDescription() Returns a parameter's detailDescription.
String	getName() Returns the name of this parameter.
com.orchestranetworks.schema.SchemaTypeName	getType() Returns a parameter's SchemaTypeName.
String	getValue() Returns the predefined value of a parameter.

Methods inherited from class java.lang.Object

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

Field Detail

FUZZY_SIMILARITY

public static final String FUZZY_SIMILARITY

See Also:

Constant Field Values

FUZZY_PREFIXLENGTH

public static final String FUZZY_PREFIXLENGTH

See Also:

Constant Field Values

DOUBLE_METAPHONE_CODELENGTH

public static final String DOUBLE_METAPHONE_CODELENGTH

See Also:

Constant Field Values

NGRAM_SIZE

public static final String NGRAM_SIZE

See Also:

Constant Field Values

JAROWINKLER_THRESHOLD

public static final String JAROWINKLER_THRESHOLD

See Also:

Constant Field Values

SEARCH_DATE_THRESHOLD

public static final String SEARCH_DATE_THRESHOLD

See Also:

Constant Field Values

SEARCH_NUMBER_THRESHOLD

public static final String SEARCH_NUMBER_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

ParameterDefinition

public ParameterDefinition(String name,
                           com.orchestranetworks.schema.SchemaTypeName type,
                           com.onwbp.base.text.UserMessage description,
                           String value)

ParameterDefinition

public ParameterDefinition(String name,
                           com.orchestranetworks.schema.SchemaTypeName type,
                           com.onwbp.base.text.UserMessage description,
                           String value,
                           com.onwbp.base.text.UserMessage detailedDescription)

Since:

1.7.0

Method Detail

getName

public String getName()

Returns the name of this parameter.

getType

public com.orchestranetworks.schema.SchemaTypeName getType()

Returns a parameter's SchemaTypeName.

getDescription

public com.onwbp.base.text.UserMessage getDescription()

Returns a parameter's description.

getDetailedDescription

public com.onwbp.base.text.UserMessage getDetailedDescription()

Returns a parameter's detailDescription.

Since:

1.7.0

getValue

public String getValue()

Returns the predefined value of a parameter.