org.nuxeo.ecm.core.search.api.backend.indexing.resources
Interface ResolvedData

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ResolvedDataImpl

public interface ResolvedData
extends java.io.Serializable

Resolved data.

Holds the actual data to index along with its configuration. The backend will used the associated data configuration to know what to do backend side.

Author:

Julien Anguenot

Method Summary

java.lang.String	getAnalyzerName() Returns the analyzer to apply to this data.
java.lang.String	getName() Returns the name of the indexable data.
java.util.Map<java.lang.String,java.io.Serializable>	getProperties()
java.lang.String	getSortOption()
java.util.Map<java.lang.String,java.lang.String>	getTermVector() Returns whether and how a field should have term vectors.
java.lang.String	getTypeName() Returns the target data type.
java.lang.Object	getValue() Returns the actual indexable value.
boolean	isBinary() Does this data needs to be handled like a binary data ?
boolean	isIndexed() Is this indexable data aimed at being indexed ?
boolean	isMultiple() Is this data multivalued ?
boolean	isSortable()
boolean	isStored() Is this indexable data aimed at being stored ?

Method Detail

getName

java.lang.String getName()

Returns the name of the indexable data.

Returns:

the name of the indexable data.

getAnalyzerName

java.lang.String getAnalyzerName()

Returns the analyzer to apply to this data.

Returns:

the analyzer to apply to this data.

getTypeName

java.lang.String getTypeName()

Returns the target data type.

Returns:

the target data type.

getValue

java.lang.Object getValue()

Returns the actual indexable value.

Important : we do not ensure the value here as a serializable Object since this API is used at backend level. It will be the responsability of the backend to ensure it if the target search server is located on another node.

Returns:

the actual indexable value as a Java Object

isStored

boolean isStored()

Is this indexable data aimed at being stored ?

Returns:

true if stored / false if unstored.

isIndexed

boolean isIndexed()

Is this indexable data aimed at being indexed ?

Returns:

true if indexed / false if unindexed

getTermVector

java.util.Map<java.lang.String,java.lang.String> getTermVector()

Returns whether and how a field should have term vectors. If empty map then no vectorization.

Returns:

a map from term vector prop id to term vector prop value.

isBinary

boolean isBinary()

Does this data needs to be handled like a binary data ?

Returns:

true if binary / false if not.

isMultiple

boolean isMultiple()

Is this data multivalued ?

Returns:

true if multivalued / false if not.

isSortable

boolean isSortable()

See Also:

IndexableResourceDataConf.isSortable()

getSortOption

java.lang.String getSortOption()

See Also:

IndexableResourceDataConf.getSortOption()

getProperties

java.util.Map<java.lang.String,java.io.Serializable> getProperties()

See Also:

IndexableResourceDataConf.getProperties()