com.exalead.indexing.analysis.v10

Class ContentTarget

java.lang.Object

com.exalead.indexing.analysis.v10.Target

com.exalead.indexing.analysis.v10.ContentTarget

All Implemented Interfaces:

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

Direct Known Subclasses:

CategoryContentTarget, CustomContentTarget, EnumFacetContentTarget, StandardContentTarget

public abstract class ContentTarget
extends Target
implements com.exalead.util.Checkable, java.io.Serializable

A ContentTarget specifies how a DocumentChunk or semantic annotation is processed to populate the index.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_RANK_BOOST
long	forcedRank
java.lang.String	indexField
long	rankBoost

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ContentTarget.
static ContentTarget	fromString(java.lang.String s) String representation of this ContentTarget.
long	getForcedRank() Sets the ranking value for chunks in this mapping. -1 means that the chunk internal ranking value is kept.
java.lang.String	getIndexField() The indexField to populate with this content. If null, the contextName of the DocumentChunk will be used for the index field.
long	getRankBoost() Offsets the chunk internal ranking value.
ContentTarget	makeCopy()
static ContentTarget	readFrom(java.io.InputStream is) Read this ContentTarget from an XML fragment.
void	setForcedRank(long forcedRank) Sets the ranking value for chunks in this mapping. -1 means that the chunk internal ranking value is kept.
void	setIndexField(java.lang.String indexField) The indexField to populate with this content. If null, the contextName of the DocumentChunk will be used for the index field.
void	setRankBoost(long rankBoost) Offsets the chunk internal ranking value.
java.lang.String	toString() String representation of this ContentTarget.
ContentTarget	withForcedRank(long forcedRank)
ContentTarget	withForcedRank(java.lang.Long forcedRank)
ContentTarget	withIndexField(java.lang.String indexField)
ContentTarget	withRankBoost(long rankBoost)
ContentTarget	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

Constructor Detail

ContentTarget

public ContentTarget()

ContentTarget

public ContentTarget(ContentTarget o)

Copy constructor

Method Detail

setIndexField

public void setIndexField(java.lang.String indexField)

The indexField to populate with this content.
If null, the contextName of the DocumentChunk will be used for the index field.

getIndexField

public java.lang.String getIndexField()

The indexField to populate with this content.
If null, the contextName of the DocumentChunk will be used for the index field.

withIndexField

public ContentTarget withIndexField(java.lang.String indexField)

setForcedRank

public void setForcedRank(long forcedRank)

Sets the ranking value for chunks in this mapping.
-1 means that the chunk internal ranking value is kept.

getForcedRank

public long getForcedRank()

Sets the ranking value for chunks in this mapping.
-1 means that the chunk internal ranking value is kept.

withForcedRank

public ContentTarget withForcedRank(long forcedRank)

withForcedRank

public ContentTarget withForcedRank(java.lang.Long forcedRank)

setRankBoost

public void setRankBoost(long rankBoost)

Offsets the chunk internal ranking value.
Use it only when forcedRank = -1
For example, if forcedRank=-1, rankBoost=2, and the chunk internal ranking value is 4, the final rank will be 6.

getRankBoost

public long getRankBoost()

Offsets the chunk internal ranking value.
Use it only when forcedRank = -1
For example, if forcedRank=-1, rankBoost=2, and the chunk internal ranking value is 4, the final rank will be 6.

withRankBoost

public ContentTarget withRankBoost(long rankBoost)

withRankBoost

public ContentTarget withRankBoost(java.lang.Long rankBoost)

makeCopy

public ContentTarget makeCopy()

Overrides:

makeCopy in class Target

readFrom

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

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

Overrides:

writeTo in class Target

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ContentTarget.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ContentTarget.

Overrides:

toString in class Target

check

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

Checks this ContentTarget.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Target

Throws:

com.exalead.util.TypedException