com.exalead.indexing.analysis.v10

Class CustomContentTarget

java.lang.Object

com.exalead.indexing.analysis.v10.Target

com.exalead.indexing.analysis.v10.ContentTarget

com.exalead.indexing.analysis.v10.CustomContentTarget

All Implemented Interfaces:

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

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

CustomerContentTarget defines indexing by a custom 'Index Kind'.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addBreakBetweenChunks
static boolean	DEFAULT_ADD_BREAK_BETWEEN_CHUNKS
static boolean	DEFAULT_RETRIEVABLE
static boolean	DEFAULT_SEARCHABLE
int	indexKind
boolean	retrievable
java.lang.String	retrieveField
boolean	searchable

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

DEFAULT_RANK_BOOST, forcedRank, indexField, rankBoost

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this CustomContentTarget.
static CustomContentTarget	fromString(java.lang.String s) String representation of this CustomContentTarget.
int	getIndexKind() Index 'Kind' to use for indexing content.
java.lang.String	getRetrieveField() The index field in which the content will be stored. If null, the content will be put in 'indexField'.
boolean	isAddBreakBetweenChunks() If true, the indexer introduces a break between document chunks. This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator.
boolean	isRetrievable() Stores the content of the DocumentChunk directly in the index, so that it can be retrieved. For numerical values, retrievability enables to sort results by field.
boolean	isSearchable() If true, the content of the DocumentChunk will be indexed and searchable.
CustomContentTarget	makeCopy() Creates and returns a deep copy of this CustomContentTarget.
static CustomContentTarget	readFrom(java.io.InputStream is) Read this CustomContentTarget from an XML fragment.
void	setAddBreakBetweenChunks(boolean addBreakBetweenChunks) If true, the indexer introduces a break between document chunks. This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator.
void	setIndexKind(int indexKind) Index 'Kind' to use for indexing content.
void	setRetrievable(boolean retrievable) Stores the content of the DocumentChunk directly in the index, so that it can be retrieved. For numerical values, retrievability enables to sort results by field.
void	setRetrieveField(java.lang.String retrieveField) The index field in which the content will be stored. If null, the content will be put in 'indexField'.
void	setSearchable(boolean searchable) If true, the content of the DocumentChunk will be indexed and searchable.
java.lang.String	toString() String representation of this CustomContentTarget.
CustomContentTarget	withAddBreakBetweenChunks(boolean addBreakBetweenChunks)
CustomContentTarget	withAddBreakBetweenChunks(java.lang.Boolean addBreakBetweenChunks)
CustomContentTarget	withForcedRank(long forcedRank)
CustomContentTarget	withForcedRank(java.lang.Long forcedRank)
CustomContentTarget	withIndexField(java.lang.String indexField)
CustomContentTarget	withIndexKind(int indexKind)
CustomContentTarget	withIndexKind(java.lang.Integer indexKind)
CustomContentTarget	withRankBoost(long rankBoost)
CustomContentTarget	withRankBoost(java.lang.Long rankBoost)
CustomContentTarget	withRetrievable(boolean retrievable)
CustomContentTarget	withRetrievable(java.lang.Boolean retrievable)
CustomContentTarget	withRetrieveField(java.lang.String retrieveField)
CustomContentTarget	withSearchable(boolean searchable)
CustomContentTarget	withSearchable(java.lang.Boolean searchable)
void	writeTo(java.io.OutputStream os) Write this CustomContentTarget as an XML fragment

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

getForcedRank, getIndexField, getRankBoost, setForcedRank, 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

retrieveField

public java.lang.String retrieveField

retrievable

public boolean retrievable

DEFAULT_RETRIEVABLE

public static final boolean DEFAULT_RETRIEVABLE

See Also:

Constant Field Values

indexKind

public int indexKind

addBreakBetweenChunks

public boolean addBreakBetweenChunks

DEFAULT_ADD_BREAK_BETWEEN_CHUNKS

public static final boolean DEFAULT_ADD_BREAK_BETWEEN_CHUNKS

See Also:

Constant Field Values

Constructor Detail

CustomContentTarget

public CustomContentTarget()

CustomContentTarget

public CustomContentTarget(CustomContentTarget o)

Copy constructor

Method Detail

withIndexField

public CustomContentTarget withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class ContentTarget

withForcedRank

public CustomContentTarget withForcedRank(long forcedRank)

Overrides:

withForcedRank in class ContentTarget

withForcedRank

public CustomContentTarget withForcedRank(java.lang.Long forcedRank)

Overrides:

withForcedRank in class ContentTarget

withRankBoost

public CustomContentTarget withRankBoost(long rankBoost)

Overrides:

withRankBoost in class ContentTarget

withRankBoost

public CustomContentTarget withRankBoost(java.lang.Long rankBoost)

Overrides:

withRankBoost in class ContentTarget

setSearchable

public void setSearchable(boolean searchable)

If true, the content of the DocumentChunk will be indexed and searchable.

isSearchable

public boolean isSearchable()

If true, the content of the DocumentChunk will be indexed and searchable.

withSearchable

public CustomContentTarget withSearchable(boolean searchable)

withSearchable

public CustomContentTarget withSearchable(java.lang.Boolean searchable)

setRetrieveField

public void setRetrieveField(java.lang.String retrieveField)

The index field in which the content will be stored.
If null, the content will be put in 'indexField'.

getRetrieveField

public java.lang.String getRetrieveField()

The index field in which the content will be stored.
If null, the content will be put in 'indexField'.

withRetrieveField

public CustomContentTarget withRetrieveField(java.lang.String retrieveField)

setRetrievable

public void setRetrievable(boolean retrievable)

Stores the content of the DocumentChunk directly in the index, so that it can be retrieved.
For numerical values, retrievability enables to sort results by field.

isRetrievable

public boolean isRetrievable()

Stores the content of the DocumentChunk directly in the index, so that it can be retrieved.
For numerical values, retrievability enables to sort results by field.

withRetrievable

public CustomContentTarget withRetrievable(boolean retrievable)

withRetrievable

public CustomContentTarget withRetrievable(java.lang.Boolean retrievable)

setIndexKind

public void setIndexKind(int indexKind)

Index 'Kind' to use for indexing content.

getIndexKind

public int getIndexKind()

Index 'Kind' to use for indexing content.

withIndexKind

public CustomContentTarget withIndexKind(int indexKind)

withIndexKind

public CustomContentTarget withIndexKind(java.lang.Integer indexKind)

setAddBreakBetweenChunks

public void setAddBreakBetweenChunks(boolean addBreakBetweenChunks)

If true, the indexer introduces a break between document chunks.
This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator. For example, if a document has a "title" chunk containing "foo" and a "text" chunk containing "bar", and they are both remapped to the text field:

• If addBreakBetweenChunks is false, then the document will match on the query "foo bar", foo NEXT bar
• If addBreakBetweenChunks is true, then the document will not match the query "foo bar" nor foo NEXT bar but will match the query foo AND bar

isAddBreakBetweenChunks

public boolean isAddBreakBetweenChunks()

If true, the indexer introduces a break between document chunks.
This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator. For example, if a document has a "title" chunk containing "foo" and a "text" chunk containing "bar", and they are both remapped to the text field:

• If addBreakBetweenChunks is false, then the document will match on the query "foo bar", foo NEXT bar
• If addBreakBetweenChunks is true, then the document will not match the query "foo bar" nor foo NEXT bar but will match the query foo AND bar

withAddBreakBetweenChunks

public CustomContentTarget withAddBreakBetweenChunks(boolean addBreakBetweenChunks)

withAddBreakBetweenChunks

public CustomContentTarget withAddBreakBetweenChunks(java.lang.Boolean addBreakBetweenChunks)

makeCopy

public CustomContentTarget makeCopy()

Creates and returns a deep copy of this CustomContentTarget.

Overrides:

makeCopy in class ContentTarget

readFrom

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

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

Overrides:

writeTo in class ContentTarget

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CustomContentTarget.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CustomContentTarget.

Overrides:

toString in class ContentTarget

check

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

Checks this CustomContentTarget.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class ContentTarget

Throws:

com.exalead.util.TypedException