com.exalead.indexing.analysis.v10

Class StandardAnnotationTarget

java.lang.Object

com.exalead.indexing.analysis.v10.AnnotationTarget

com.exalead.indexing.analysis.v10.StandardAnnotationTarget

All Implemented Interfaces:

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

public class StandardAnnotationTarget
extends AnnotationTarget
implements com.exalead.util.Checkable, java.io.Serializable

StandardAnnotationTarget is used to index the textual content of a SemanticAnnotation.
The selected 'form' of the SemanticAnnotation is used to populate an index field.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.AnnotationTarget

AnnotationTarget.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
int	customIndexKind
static boolean	DEFAULT_RETRIEVABLE
static boolean	DEFAULT_SEARCHABLE
java.lang.String	indexLevel
boolean	retrievable
java.lang.String	retrieveField
boolean	searchable

Fields inherited from class com.exalead.indexing.analysis.v10.AnnotationTarget

dataModelClass, dataModelProperty, dataModelState, DEFAULT_FORM, DEFAULT_RANK_BOOST, forcedRank, form, fromDataModel, indexField, rankBoost

Constructor Summary

Constructors

Constructor and Description
StandardAnnotationTarget()
StandardAnnotationTarget(StandardAnnotationTarget o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this StandardAnnotationTarget.
static StandardAnnotationTarget	fromString(java.lang.String s) String representation of this StandardAnnotationTarget.
int	getCustomIndexKind() If indexLevel = "custom", this index kind will be used.
java.lang.String	getIndexLevel() If searchable, index kind where data will be indexed. Can be "exact", "lowercase", "normalized" or "custom".
java.lang.String	getRetrieveField() The field where the SemanticAnnotation is stored for retrieval, if 'retrievable' is set to true. If null, 'indexField' will be used to store the SemanticAnnotation for retrieval.
boolean	isRetrievable() If true, the SemanticAnnotation can be retrieved.
boolean	isSearchable() If true, the SemanticAnnotation can be searched for.
StandardAnnotationTarget	makeCopy() Creates and returns a deep copy of this StandardAnnotationTarget.
static StandardAnnotationTarget	readFrom(java.io.InputStream is) Read this StandardAnnotationTarget from an XML fragment.
void	setCustomIndexKind(int customIndexKind) If indexLevel = "custom", this index kind will be used.
void	setIndexLevel(java.lang.String indexLevel) If searchable, index kind where data will be indexed. Can be "exact", "lowercase", "normalized" or "custom".
void	setRetrievable(boolean retrievable) If true, the SemanticAnnotation can be retrieved.
void	setRetrieveField(java.lang.String retrieveField) The field where the SemanticAnnotation is stored for retrieval, if 'retrievable' is set to true. If null, 'indexField' will be used to store the SemanticAnnotation for retrieval.
void	setSearchable(boolean searchable) If true, the SemanticAnnotation can be searched for.
java.lang.String	toString() String representation of this StandardAnnotationTarget.
StandardAnnotationTarget	withCustomIndexKind(int customIndexKind)
StandardAnnotationTarget	withCustomIndexKind(java.lang.Integer customIndexKind)
StandardAnnotationTarget	withDataModelClass(java.lang.String dataModelClass)
StandardAnnotationTarget	withDataModelProperty(java.lang.String dataModelProperty)
StandardAnnotationTarget	withDataModelState(java.lang.String dataModelState)
StandardAnnotationTarget	withForcedRank(long forcedRank)
StandardAnnotationTarget	withForcedRank(java.lang.Long forcedRank)
StandardAnnotationTarget	withForm(java.lang.String form)
StandardAnnotationTarget	withFromDataModel(AnnotationTarget fromDataModel)
StandardAnnotationTarget	withIndexField(java.lang.String indexField)
StandardAnnotationTarget	withIndexLevel(java.lang.String indexLevel)
StandardAnnotationTarget	withRankBoost(long rankBoost)
StandardAnnotationTarget	withRankBoost(java.lang.Long rankBoost)
StandardAnnotationTarget	withRetrievable(boolean retrievable)
StandardAnnotationTarget	withRetrievable(java.lang.Boolean retrievable)
StandardAnnotationTarget	withRetrieveField(java.lang.String retrieveField)
StandardAnnotationTarget	withSearchable(boolean searchable)
StandardAnnotationTarget	withSearchable(java.lang.Boolean searchable)
void	writeTo(java.io.OutputStream os) Write this StandardAnnotationTarget as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.AnnotationTarget

getDataModelClass, getDataModelProperty, getDataModelState, getForcedRank, getForm, getFromDataModel, getIndexField, getRankBoost, setDataModelClass, setDataModelProperty, setDataModelState, setForcedRank, setForm, setFromDataModel, setIndexField, setRankBoost

Methods inherited from class java.lang.Object

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

Field Detail

searchable

public boolean searchable

DEFAULT_SEARCHABLE

public static final boolean DEFAULT_SEARCHABLE

See Also:

Constant Field Values

indexLevel

public java.lang.String indexLevel

customIndexKind

public int customIndexKind

retrievable

public boolean retrievable

DEFAULT_RETRIEVABLE

public static final boolean DEFAULT_RETRIEVABLE

See Also:

Constant Field Values

retrieveField

public java.lang.String retrieveField

Constructor Detail

StandardAnnotationTarget

public StandardAnnotationTarget()

StandardAnnotationTarget

public StandardAnnotationTarget(StandardAnnotationTarget o)

Copy constructor

Method Detail

withIndexField

public StandardAnnotationTarget withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class AnnotationTarget

withForcedRank

public StandardAnnotationTarget withForcedRank(long forcedRank)

Overrides:

withForcedRank in class AnnotationTarget

withForcedRank

public StandardAnnotationTarget withForcedRank(java.lang.Long forcedRank)

Overrides:

withForcedRank in class AnnotationTarget

withRankBoost

public StandardAnnotationTarget withRankBoost(long rankBoost)

Overrides:

withRankBoost in class AnnotationTarget

withRankBoost

public StandardAnnotationTarget withRankBoost(java.lang.Long rankBoost)

Overrides:

withRankBoost in class AnnotationTarget

withForm

public StandardAnnotationTarget withForm(java.lang.String form)

Overrides:

withForm in class AnnotationTarget

withDataModelState

public StandardAnnotationTarget withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class AnnotationTarget

withFromDataModel

public StandardAnnotationTarget withFromDataModel(AnnotationTarget fromDataModel)

withDataModelClass

public StandardAnnotationTarget withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class AnnotationTarget

withDataModelProperty

public StandardAnnotationTarget withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class AnnotationTarget

setSearchable

public void setSearchable(boolean searchable)

If true, the SemanticAnnotation can be searched for.

isSearchable

public boolean isSearchable()

If true, the SemanticAnnotation can be searched for.

withSearchable

public StandardAnnotationTarget withSearchable(boolean searchable)

withSearchable

public StandardAnnotationTarget withSearchable(java.lang.Boolean searchable)

setIndexLevel

public void setIndexLevel(java.lang.String indexLevel)

If searchable, index kind where data will be indexed.
Can be "exact", "lowercase", "normalized" or "custom".

getIndexLevel

public java.lang.String getIndexLevel()

If searchable, index kind where data will be indexed.
Can be "exact", "lowercase", "normalized" or "custom".

withIndexLevel

public StandardAnnotationTarget withIndexLevel(java.lang.String indexLevel)

setCustomIndexKind

public void setCustomIndexKind(int customIndexKind)

If indexLevel = "custom", this index kind will be used.

getCustomIndexKind

public int getCustomIndexKind()

If indexLevel = "custom", this index kind will be used.

withCustomIndexKind

public StandardAnnotationTarget withCustomIndexKind(int customIndexKind)

withCustomIndexKind

public StandardAnnotationTarget withCustomIndexKind(java.lang.Integer customIndexKind)

setRetrievable

public void setRetrievable(boolean retrievable)

If true, the SemanticAnnotation can be retrieved.

isRetrievable

public boolean isRetrievable()

If true, the SemanticAnnotation can be retrieved.

withRetrievable

public StandardAnnotationTarget withRetrievable(boolean retrievable)

withRetrievable

public StandardAnnotationTarget withRetrievable(java.lang.Boolean retrievable)

setRetrieveField

public void setRetrieveField(java.lang.String retrieveField)

The field where the SemanticAnnotation is stored for retrieval, if 'retrievable' is set to true.
If null, 'indexField' will be used to store the SemanticAnnotation for retrieval.

getRetrieveField

public java.lang.String getRetrieveField()

The field where the SemanticAnnotation is stored for retrieval, if 'retrievable' is set to true.
If null, 'indexField' will be used to store the SemanticAnnotation for retrieval.

withRetrieveField

public StandardAnnotationTarget withRetrieveField(java.lang.String retrieveField)

makeCopy

public StandardAnnotationTarget makeCopy()

Creates and returns a deep copy of this StandardAnnotationTarget.

Overrides:

makeCopy in class AnnotationTarget

readFrom

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

Read this StandardAnnotationTarget 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 StandardAnnotationTarget as an XML fragment

Overrides:

writeTo in class AnnotationTarget

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this StandardAnnotationTarget.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this StandardAnnotationTarget.

Overrides:

toString in class AnnotationTarget

check

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

Checks this StandardAnnotationTarget.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AnnotationTarget

Throws:

com.exalead.util.TypedException