com.exalead.indexing.analysis.v10

Class AnnotationTarget

java.lang.Object

com.exalead.indexing.analysis.v10.AnnotationTarget

All Implemented Interfaces:

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

Direct Known Subclasses:

CategoryAnnotationTarget, EnumFacetAnnotationTarget, StandardAnnotationTarget

public abstract class AnnotationTarget
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Target for the mapping of a SemanticAnnotation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotationTarget.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	dataModelClass
java.lang.String	dataModelProperty
java.lang.String	dataModelState
static java.lang.String	DEFAULT_FORM
static long	DEFAULT_RANK_BOOST
long	forcedRank
java.lang.String	form
protected AnnotationTarget.FromDataModel	fromDataModel
java.lang.String	indexField
long	rankBoost

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AnnotationTarget.
static AnnotationTarget	fromString(java.lang.String s) String representation of this AnnotationTarget.
java.lang.String	getDataModelClass() If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this AnnotationTarget.
java.lang.String	getDataModelProperty() If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this AnnotationTarget.
java.lang.String	getDataModelState() Is this annotation target managed by a data model?
long	getForcedRank()
java.lang.String	getForm() Which form of SemanticAnnotation value should we index? enum(exact,normalized)
AnnotationTarget.FromDataModel	getFromDataModel()
java.lang.String	getIndexField()
long	getRankBoost()
AnnotationTarget	makeCopy()
static AnnotationTarget	readFrom(java.io.InputStream is) Read this AnnotationTarget from an XML fragment.
void	setDataModelClass(java.lang.String dataModelClass) If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this AnnotationTarget.
void	setDataModelProperty(java.lang.String dataModelProperty) If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this AnnotationTarget.
void	setDataModelState(java.lang.String dataModelState) Is this annotation target managed by a data model?
void	setForcedRank(long forcedRank)
void	setForm(java.lang.String form) Which form of SemanticAnnotation value should we index? enum(exact,normalized)
void	setFromDataModel(AnnotationTarget.FromDataModel __value)
void	setIndexField(java.lang.String indexField)
void	setRankBoost(long rankBoost)
java.lang.String	toString() String representation of this AnnotationTarget.
AnnotationTarget	withDataModelClass(java.lang.String dataModelClass)
AnnotationTarget	withDataModelProperty(java.lang.String dataModelProperty)
AnnotationTarget	withDataModelState(java.lang.String dataModelState)
AnnotationTarget	withForcedRank(long forcedRank)
AnnotationTarget	withForcedRank(java.lang.Long forcedRank)
AnnotationTarget	withForm(java.lang.String form)
AnnotationTarget	withIndexField(java.lang.String indexField)
AnnotationTarget	withRankBoost(long rankBoost)
AnnotationTarget	withRankBoost(java.lang.Long rankBoost)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

indexField

public java.lang.String indexField

forcedRank

public long forcedRank

rankBoost

public long rankBoost

DEFAULT_RANK_BOOST

public static final long DEFAULT_RANK_BOOST

See Also:

Constant Field Values

form

public java.lang.String form

DEFAULT_FORM

public static final java.lang.String DEFAULT_FORM

See Also:

Constant Field Values

dataModelState

public java.lang.String dataModelState

fromDataModel

protected AnnotationTarget.FromDataModel fromDataModel

dataModelClass

public java.lang.String dataModelClass

dataModelProperty

public java.lang.String dataModelProperty

Constructor Detail

AnnotationTarget

public AnnotationTarget()

AnnotationTarget

public AnnotationTarget(AnnotationTarget o)

Copy constructor

Method Detail

setIndexField

public void setIndexField(java.lang.String indexField)

getIndexField

public java.lang.String getIndexField()

withIndexField

public AnnotationTarget withIndexField(java.lang.String indexField)

setForcedRank

public void setForcedRank(long forcedRank)

getForcedRank

public long getForcedRank()

withForcedRank

public AnnotationTarget withForcedRank(long forcedRank)

withForcedRank

public AnnotationTarget withForcedRank(java.lang.Long forcedRank)

setRankBoost

public void setRankBoost(long rankBoost)

getRankBoost

public long getRankBoost()

withRankBoost

public AnnotationTarget withRankBoost(long rankBoost)

withRankBoost

public AnnotationTarget withRankBoost(java.lang.Long rankBoost)

setForm

public void setForm(java.lang.String form)

Which form of SemanticAnnotation value should we index?
enum(exact,normalized)

getForm

public java.lang.String getForm()

Which form of SemanticAnnotation value should we index?
enum(exact,normalized)

withForm

public AnnotationTarget withForm(java.lang.String form)

setDataModelState

public void setDataModelState(java.lang.String dataModelState)

Is this annotation target managed by a data model?

getDataModelState

public java.lang.String getDataModelState()

Is this annotation target managed by a data model?

withDataModelState

public AnnotationTarget withDataModelState(java.lang.String dataModelState)

getFromDataModel

public AnnotationTarget.FromDataModel getFromDataModel()

setFromDataModel

public void setFromDataModel(AnnotationTarget.FromDataModel __value)

setDataModelClass

public void setDataModelClass(java.lang.String dataModelClass)

If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this AnnotationTarget.

getDataModelClass

public java.lang.String getDataModelClass()

If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this AnnotationTarget.

withDataModelClass

public AnnotationTarget withDataModelClass(java.lang.String dataModelClass)

setDataModelProperty

public void setDataModelProperty(java.lang.String dataModelProperty)

If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this AnnotationTarget.

getDataModelProperty

public java.lang.String getDataModelProperty()

If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this AnnotationTarget.

withDataModelProperty

public AnnotationTarget withDataModelProperty(java.lang.String dataModelProperty)

makeCopy

public AnnotationTarget makeCopy()

readFrom

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

Read this AnnotationTarget 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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AnnotationTarget.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AnnotationTarget.

Overrides:

toString in class java.lang.Object

check

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

Checks this AnnotationTarget.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException