com.esri.gpt.server.assertion.components
Class AsnValueType

java.lang.Object
  com.esri.gpt.server.assertion.components.AsnValueType

public class AsnValueType
extends Object

Represents an assertion value type.

Field Summary

static String	VALUE_TYPENAME_CONSTRAINED Value type name = "constrained"
static String	VALUE_TYPENAME_FREE Value type name = "free"

Constructor Summary

AsnValueType()
Default constructor.

AsnValueType(AsnValueType objectToDuplicate)
Construct by duplicating an existing object.

Method Summary

AsnValueType	duplicate() Produces a deep clone of the object.
boolean	getAnalyzePriorToIndexing() Gets the flag indicating whether or not the value should be analyzed prior to indexing.
int	getMaxCharacters() Gets the maximum number of characters allowed for the value.
String	getRdfPredicate() Gets the RDF predicate that will be indexed for this value type.
String	getRdfValueField() Gets the RDF value field name within the Lucene index.
boolean	getRequired() Gets the flag indicating whether or not a value is required.
AsnSupportedValues	getSupportedValues() Gets the domain values supported values.
String	getValueFilterClass() Gets the fully qualified class name of the value filter.
String	getValueTypeName() Gets the value type name.
AsnValueFilter	makeValueFilter(AsnContext context) Makes a value filter based upon the associated valueFilterClass.
void	setAnalyzePriorToIndexing(boolean analyze) Sets the flag indicating whether or not the value should be analyzed prior to indexing.
void	setMaxCharacters(int maxCharacters) Sets the maximum number of characters allowed for the value.
void	setRdfPredicate(String rdfPredicate) Sets the RDF predicate that will be indexed for this value type.
void	setRdfValueField(String rdfValueField) Sets the RDF value field name within the Lucene index.
void	setRequired(boolean required) Sets the flag indicating whether or not a value is required.
void	setSupportedValues(AsnSupportedValues supportedValues) Sets the domain values supported values.
void	setValueFilterClass(String valueFilterClass) Sets the fully qualified class name of the value filter.
void	setValueTypeName(String valueTypeName) Sets the value type name.

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_TYPENAME_CONSTRAINED

public static final String VALUE_TYPENAME_CONSTRAINED

Value type name = "constrained"

See Also:

Constant Field Values

VALUE_TYPENAME_FREE

public static final String VALUE_TYPENAME_FREE

Value type name = "free"

See Also:

Constant Field Values

Constructor Detail

AsnValueType

public AsnValueType()

Default constructor.

AsnValueType

public AsnValueType(AsnValueType objectToDuplicate)

Construct by duplicating an existing object.

Parameters:

objectToDuplicate - the object to duplicate

Method Detail

getAnalyzePriorToIndexing

public boolean getAnalyzePriorToIndexing()

Gets the flag indicating whether or not the value should be analyzed prior to indexing.

Returns:

true if the value should be analyzed

setAnalyzePriorToIndexing

public void setAnalyzePriorToIndexing(boolean analyze)

Sets the flag indicating whether or not the value should be analyzed prior to indexing.

Parameters:

analyze - true if the value should be analyzed

getMaxCharacters

public int getMaxCharacters()

Gets the maximum number of characters allowed for the value.
Default = 4000.

Returns:

the maximum number of characters allowed

setMaxCharacters

public void setMaxCharacters(int maxCharacters)

Sets the maximum number of characters allowed for the value.

Parameters:

maxCharacters - the maximum number of characters allowed

getRdfPredicate

public String getRdfPredicate()

Gets the RDF predicate that will be indexed for this value type.

Returns:

the RDF predicate (Lucene field rdf.predicate)

setRdfPredicate

public void setRdfPredicate(String rdfPredicate)

Sets the RDF predicate that will be indexed for this value type.

Parameters:

rdfPredicate - the RDF predicate (Lucene field rdf.predicate)

getRdfValueField

public String getRdfValueField()

Gets the RDF value field name within the Lucene index.

Returns:

the RDF value field name

setRdfValueField

public void setRdfValueField(String rdfValueField)

Sets the RDF value field name within the Lucene index.

Parameters:

rdfValueField - the RDF value field name

getRequired

public boolean getRequired()

Gets the flag indicating whether or not a value is required.

Returns:

true if required

setRequired

public void setRequired(boolean required)

Sets the flag indicating whether or not a value is required.

Parameters:

required - true if required

getSupportedValues

public AsnSupportedValues getSupportedValues()

Gets the domain values supported values.

Returns:

the supported values (null if unconstrained)

setSupportedValues

public void setSupportedValues(AsnSupportedValues supportedValues)

Sets the domain values supported values.

Parameters:

supportedValues - the supported values (null if unconstrained)

getValueFilterClass

public String getValueFilterClass()

Gets the fully qualified class name of the value filter.
(must extend AsnValueFilter)

Returns:

the value filter class

setValueFilterClass

public void setValueFilterClass(String valueFilterClass)

Sets the fully qualified class name of the value filter.
(must extend AsnValueAnalyzer)

Parameters:

valueFilterClass - the value filter class

getValueTypeName

public String getValueTypeName()

Gets the value type name.

Returns:

the value type name

setValueTypeName

public void setValueTypeName(String valueTypeName)

Sets the value type name.

Parameters:

valueTypeName - the value type name

duplicate

public AsnValueType duplicate()

Produces a deep clone of the object.
The duplication constructor is invoked.
return new AsnValueType(this);

Returns:

the duplicated object

makeValueFilter

public AsnValueFilter makeValueFilter(AsnContext context)
                               throws ClassNotFoundException,
                                      InstantiationException,
                                      IllegalAccessException

Makes a value filter based upon the associated valueFilterClass.

Parameters:

context - the assertion operation context

Returns:

the value filter (can be null)

Throws:

ClassNotFoundException - if the class was not found

InstantiationException - if the class could not be instantiated

IllegalAccessException - if the class could not be accessed