com.exalead.datamodel.v10

Class AlphanumProperty

java.lang.Object

com.exalead.datamodel.v10.Property

com.exalead.datamodel.v10.DataProperty

com.exalead.datamodel.v10.AlphanumProperty

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class AlphanumProperty
extends DataProperty
implements com.exalead.util.Checkable, java.io.Serializable

Alphanumerical property.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.datamodel.v10.Property

Property.Arity, Property.Tags

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENUMERATED
static boolean	DEFAULT_INDEX_IN_TEXT_FIELD
boolean	enumerated
boolean	indexInTextField
java.lang.String	queryExpansionConfig
java.lang.String	semanticType

Fields inherited from class com.exalead.datamodel.v10.DataProperty

additionalMetaNames, advancedParams, dedicatedField, DEFAULT_DEDICATED_FIELD, DEFAULT_DISJUNCTIVE_REFINES, DEFAULT_FACET, DEFAULT_OVERRIDE_CLASS_EXPANSION_PARAMS, DEFAULT_RAM_BASED, DEFAULT_RETRIEVABLE, DEFAULT_SEARCHABLE, defaultValue, disjunctiveRefines, dynamicProperty, facet, overrideClassExpansionParams, ramBased, retrievable, searchable

Fields inherited from class com.exalead.datamodel.v10.Property

arity, ARITY_MANY, ARITY_ONE, ARITY_ZERO_OR_ONE, comment, DEFAULT_ARITY, keyValue, label, name, tags

Constructor Summary

Constructors

Constructor and Description
AlphanumProperty()
AlphanumProperty(AlphanumProperty o) Copy constructor
AlphanumProperty(java.lang.String name)
AlphanumProperty(java.lang.String name, java.lang.String semanticType)

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AlphanumProperty.
static AlphanumProperty	fromString(java.lang.String s) String representation of this AlphanumProperty.
java.lang.String	getQueryExpansionConfig() Search-time query expansion config to use for this property. This follows the 'QEC' format specification.
java.lang.String	getSemanticType() Defines how the text is processed and indexed (tokenization, normalization and indexing-time semantic processing). This value must refer to a valid !SemanticType object in the DataModel.
boolean	isEnumerated() Is there a controlled and limited set of values for this property? Enumerated properties are indexed using a specific "Value" field, which stores entire values in an optimized way. Thus, performing faceting on this kind of field is faster than on a category field. It is not possible to perform any semantic processing on value fields.
boolean	isIndexInTextField() Allows users to search for matches in this property without using a prefix, by mapping the values to the generic "text" index field, as invisible text. For example, to search for "API" in a document, enter the search query
AlphanumProperty	makeCopy() Creates and returns a deep copy of this AlphanumProperty.
static AlphanumProperty	readFrom(java.io.InputStream is) Read this AlphanumProperty from an XML fragment.
void	setEnumerated(boolean enumerated) Is there a controlled and limited set of values for this property? Enumerated properties are indexed using a specific "Value" field, which stores entire values in an optimized way. Thus, performing faceting on this kind of field is faster than on a category field. It is not possible to perform any semantic processing on value fields.
void	setIndexInTextField(boolean indexInTextField) Allows users to search for matches in this property without using a prefix, by mapping the values to the generic "text" index field, as invisible text. For example, to search for "API" in a document, enter the search query
void	setQueryExpansionConfig(java.lang.String queryExpansionConfig) Search-time query expansion config to use for this property. This follows the 'QEC' format specification.
void	setSemanticType(java.lang.String semanticType) Defines how the text is processed and indexed (tokenization, normalization and indexing-time semantic processing). This value must refer to a valid !SemanticType object in the DataModel.
java.lang.String	toString() String representation of this AlphanumProperty.
AlphanumProperty	withAdditionalMetaNames(java.lang.String additionalMetaNames)
AlphanumProperty	withAdvancedParams(AdvancedParams advancedParams)
AlphanumProperty	withArity(java.lang.String arity)
AlphanumProperty	withComment(java.lang.String comment)
AlphanumProperty	withDedicatedField(boolean dedicatedField)
AlphanumProperty	withDedicatedField(java.lang.Boolean dedicatedField)
AlphanumProperty	withDefaultValue(java.lang.String defaultValue)
AlphanumProperty	withDisjunctiveRefines(boolean disjunctiveRefines)
AlphanumProperty	withDisjunctiveRefines(java.lang.Boolean disjunctiveRefines)
AlphanumProperty	withDynamicProperty(java.lang.String dynamicProperty)
AlphanumProperty	withEnumerated(boolean enumerated)
AlphanumProperty	withEnumerated(java.lang.Boolean enumerated)
AlphanumProperty	withFacet(boolean facet)
AlphanumProperty	withFacet(java.lang.Boolean facet)
AlphanumProperty	withIndexInTextField(boolean indexInTextField)
AlphanumProperty	withIndexInTextField(java.lang.Boolean indexInTextField)
AlphanumProperty	withKeyValue(java.util.Collection<KeyValue> __values)
AlphanumProperty	withKeyValue(KeyValue... __values)
AlphanumProperty	withLabel(java.util.Collection<Label> __values)
AlphanumProperty	withLabel(Label... __values) Labels for the internationalization of this property's name
AlphanumProperty	withName(java.lang.String name)
AlphanumProperty	withOverrideClassExpansionParams(boolean overrideClassExpansionParams)
AlphanumProperty	withOverrideClassExpansionParams(java.lang.Boolean overrideClassExpansionParams)
AlphanumProperty	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
AlphanumProperty	withRamBased(boolean ramBased)
AlphanumProperty	withRamBased(java.lang.Boolean ramBased)
AlphanumProperty	withRetrievable(boolean retrievable)
AlphanumProperty	withRetrievable(java.lang.Boolean retrievable)
AlphanumProperty	withSearchable(boolean searchable)
AlphanumProperty	withSearchable(java.lang.Boolean searchable)
AlphanumProperty	withSemanticType(java.lang.String semanticType)
AlphanumProperty	withTags(java.util.Collection<KeyValue> __values)
AlphanumProperty	withTags(KeyValue... __values) User-defined tags for this property.
void	writeTo(java.io.OutputStream os) Write this AlphanumProperty as an XML fragment

Methods inherited from class com.exalead.datamodel.v10.DataProperty

getAdditionalMetaNames, getAdvancedParams, getDefaultValue, getDynamicProperty, isDedicatedField, isDisjunctiveRefines, isFacet, isOverrideClassExpansionParams, isRamBased, isRetrievable, isSearchable, setAdditionalMetaNames, setAdvancedParams, setDedicatedField, setDefaultValue, setDisjunctiveRefines, setDynamicProperty, setFacet, setOverrideClassExpansionParams, setRamBased, setRetrievable, setSearchable

Methods inherited from class com.exalead.datamodel.v10.Property

addKeyValue, getArity, getArityAsEnum, getComment, getKeyValue, getLabel, getName, getTags, isA, isOneOf, setArity, setArity, setComment, setName, setTags, withTags

Methods inherited from class java.lang.Object

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

Field Detail

semanticType

public java.lang.String semanticType

indexInTextField

public boolean indexInTextField

DEFAULT_INDEX_IN_TEXT_FIELD

public static final boolean DEFAULT_INDEX_IN_TEXT_FIELD

See Also:

Constant Field Values

queryExpansionConfig

public java.lang.String queryExpansionConfig

enumerated

public boolean enumerated

DEFAULT_ENUMERATED

public static final boolean DEFAULT_ENUMERATED

See Also:

Constant Field Values

Constructor Detail

AlphanumProperty

public AlphanumProperty()

AlphanumProperty

public AlphanumProperty(AlphanumProperty o)

Copy constructor

AlphanumProperty

public AlphanumProperty(java.lang.String name,
                        java.lang.String semanticType)

AlphanumProperty

public AlphanumProperty(java.lang.String name)

Method Detail

withAdvancedParams

public AlphanumProperty withAdvancedParams(AdvancedParams advancedParams)

Overrides:

withAdvancedParams in class DataProperty

withOverrideClassExpansionParams

public AlphanumProperty withOverrideClassExpansionParams(boolean overrideClassExpansionParams)

Overrides:

withOverrideClassExpansionParams in class DataProperty

withOverrideClassExpansionParams

public AlphanumProperty withOverrideClassExpansionParams(java.lang.Boolean overrideClassExpansionParams)

Overrides:

withOverrideClassExpansionParams in class DataProperty

withDedicatedField

public AlphanumProperty withDedicatedField(boolean dedicatedField)

Overrides:

withDedicatedField in class DataProperty

withDedicatedField

public AlphanumProperty withDedicatedField(java.lang.Boolean dedicatedField)

Overrides:

withDedicatedField in class DataProperty

withDynamicProperty

public AlphanumProperty withDynamicProperty(java.lang.String dynamicProperty)

Overrides:

withDynamicProperty in class DataProperty

withSearchable

public AlphanumProperty withSearchable(boolean searchable)

Overrides:

withSearchable in class DataProperty

withSearchable

public AlphanumProperty withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class DataProperty

withRetrievable

public AlphanumProperty withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class DataProperty

withRetrievable

public AlphanumProperty withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class DataProperty

withRamBased

public AlphanumProperty withRamBased(boolean ramBased)

Overrides:

withRamBased in class DataProperty

withRamBased

public AlphanumProperty withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class DataProperty

withFacet

public AlphanumProperty withFacet(boolean facet)

Overrides:

withFacet in class DataProperty

withFacet

public AlphanumProperty withFacet(java.lang.Boolean facet)

Overrides:

withFacet in class DataProperty

withDisjunctiveRefines

public AlphanumProperty withDisjunctiveRefines(boolean disjunctiveRefines)

Overrides:

withDisjunctiveRefines in class DataProperty

withDisjunctiveRefines

public AlphanumProperty withDisjunctiveRefines(java.lang.Boolean disjunctiveRefines)

Overrides:

withDisjunctiveRefines in class DataProperty

withDefaultValue

public AlphanumProperty withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class DataProperty

withAdditionalMetaNames

public AlphanumProperty withAdditionalMetaNames(java.lang.String additionalMetaNames)

Overrides:

withAdditionalMetaNames in class DataProperty

withKeyValue

public AlphanumProperty withKeyValue(KeyValue... __values)

Overrides:

withKeyValue in class DataProperty

withKeyValue

public AlphanumProperty withKeyValue(java.util.Collection<KeyValue> __values)

Overrides:

withKeyValue in class DataProperty

withArity

public AlphanumProperty withArity(java.lang.String arity)

Overrides:

withArity in class DataProperty

withName

public AlphanumProperty withName(java.lang.String name)

Overrides:

withName in class DataProperty

withComment

public AlphanumProperty withComment(java.lang.String comment)

Overrides:

withComment in class DataProperty

withLabel

public AlphanumProperty withLabel(Label... __values)

Labels for the internationalization of this property's name

Overrides:

withLabel in class DataProperty

withLabel

public AlphanumProperty withLabel(java.util.Collection<Label> __values)

Overrides:

withLabel in class DataProperty

withTags

public AlphanumProperty withTags(KeyValue... __values)

User-defined tags for this property. This can be used for example to implement 6W faceting of the data model.

Overrides:

withTags in class DataProperty

withTags

public AlphanumProperty withTags(java.util.Collection<KeyValue> __values)

Overrides:

withTags in class DataProperty

setSemanticType

public void setSemanticType(java.lang.String semanticType)

Defines how the text is processed and indexed (tokenization, normalization and indexing-time semantic processing).

This value must refer to a valid !SemanticType object in the DataModel.

getSemanticType

public java.lang.String getSemanticType()

Defines how the text is processed and indexed (tokenization, normalization and indexing-time semantic processing).

This value must refer to a valid !SemanticType object in the DataModel.

withSemanticType

public AlphanumProperty withSemanticType(java.lang.String semanticType)

setIndexInTextField

public void setIndexInTextField(boolean indexInTextField)

Allows users to search for matches in this property without using a prefix, by mapping the values to the
generic "text" index field, as invisible text.

For example, to search for "API" in a document, enter the search query

API

isIndexInTextField

public boolean isIndexInTextField()

Allows users to search for matches in this property without using a prefix, by mapping the values to the
generic "text" index field, as invisible text.

For example, to search for "API" in a document, enter the search query

API

withIndexInTextField

public AlphanumProperty withIndexInTextField(boolean indexInTextField)

withIndexInTextField

public AlphanumProperty withIndexInTextField(java.lang.Boolean indexInTextField)

setQueryExpansionConfig

public void setQueryExpansionConfig(java.lang.String queryExpansionConfig)

Search-time query expansion config to use for this property.
This follows the 'QEC' format specification.

getQueryExpansionConfig

public java.lang.String getQueryExpansionConfig()

Search-time query expansion config to use for this property.
This follows the 'QEC' format specification.

withQueryExpansionConfig

public AlphanumProperty withQueryExpansionConfig(java.lang.String queryExpansionConfig)

setEnumerated

public void setEnumerated(boolean enumerated)

Is there a controlled and limited set of values for this property?

Enumerated properties are indexed using a specific "Value" field, which stores
entire values in an optimized way.

Thus, performing faceting on this kind of field is faster than on a category field.
It is not possible to perform any semantic processing on value fields.

isEnumerated

public boolean isEnumerated()

Is there a controlled and limited set of values for this property?

Enumerated properties are indexed using a specific "Value" field, which stores
entire values in an optimized way.

Thus, performing faceting on this kind of field is faster than on a category field.
It is not possible to perform any semantic processing on value fields.

withEnumerated

public AlphanumProperty withEnumerated(boolean enumerated)

withEnumerated

public AlphanumProperty withEnumerated(java.lang.Boolean enumerated)

makeCopy

public AlphanumProperty makeCopy()

Creates and returns a deep copy of this AlphanumProperty.

Overrides:

makeCopy in class DataProperty

readFrom

public static AlphanumProperty readFrom(java.io.InputStream is)
                                 throws javax.xml.bind.JAXBException

Read this AlphanumProperty from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this AlphanumProperty as an XML fragment

Overrides:

writeTo in class DataProperty

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static AlphanumProperty fromString(java.lang.String s)
                                   throws javax.xml.bind.JAXBException,
                                          java.io.UnsupportedEncodingException

String representation of this AlphanumProperty.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AlphanumProperty.

Overrides:

toString in class DataProperty

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this AlphanumProperty.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DataProperty

Throws:

com.exalead.util.TypedException