org.nuxeo.ecm.core.search.api.indexing.resources.configuration
Interface IndexableResourceDataConf

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IndexableFieldDescriptor

public interface IndexableResourceDataConf
extends java.io.Serializable

Indexable resource data configuration.

Holds the properties specifying the way data from a given resource will be indexed. An indexable resource data configuration is bound to an IndexableResourceConf instance.

Author:

Julien Anguenot

See Also:

IndexableResourceConf

Method Summary

java.lang.String	getIndexingAnalyzer() Returns the analyzer that must be applied on the indexable data at backend level.
java.lang.String	getIndexingName() Returns the name of the target indexable data once indexed.
java.lang.String	getIndexingType() Returns the target indexing field type.
java.util.Map<java.lang.String,java.io.Serializable>	getProperties() Returns a map from of properties bound to this field.
java.lang.String	getSortOption() Get a string describing behaviour of this data with respect to sort queries, e.g., case insensitivity.
java.util.Map<java.lang.String,java.lang.String>	getTermVector() Returns whether and how a field should have term vectors.
boolean	isBinary() Does this data needs to be handled like a binary data?
boolean	isIndexed() Returns if whether or not the value will be indexed.
boolean	isMultiple() Returns whether or not the value is a multiple one.
boolean	isSortable() Say if special care must be taken to make the field sortable.
boolean	isStored() Returns if whether or not the value will be stored.

Method Detail

getIndexingName

java.lang.String getIndexingName()

Returns the name of the target indexable data once indexed.

The name here is not necessarily bound to the resource data key(s).This is the name that aimed at being used at backend level for the target index.

Returns:

the name of the target indexable data index in the backend

getIndexingType

java.lang.String getIndexingType()

Returns the target indexing field type.

Returns:

the field type

getIndexingAnalyzer

java.lang.String getIndexingAnalyzer()

Returns the analyzer that must be applied on the indexable data at backend level.

Returns:

the analyzer name

isStored

boolean isStored()

Returns if whether or not the value will be stored.

Returns:

true if stored false if unstored.

isIndexed

boolean isIndexed()

Returns if whether or not the value will be indexed.

Returns:

true if indexed, false if unindexed.

isMultiple

boolean isMultiple()

Returns whether or not the value is a multiple one.

Returns:

true if multiple, false otherwise

isSortable

boolean isSortable()

Say if special care must be taken to make the field sortable.

Typically (e.g., with Lucene) a tokenized/stemmed/analyzed field would not be sortable out of the box. The special treatment to restore sortability being potentially very costly, it should be applied only to fields for which isSortable() is true.

A false value doesn't forbid sortability for fields whose indexing digestion doesn't technically prevent sortability.

Returns:

a boolean

getSortOption

java.lang.String getSortOption()

Get a string describing behaviour of this data with respect to sort queries, e.g., case insensitivity.

Compatibility issues This is new in 5.1.2. Customized implementations of this interface can simply return null, the behavior will then be exactly the same as before.

Returns:

the sort option

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.

getProperties

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

Returns a map from of properties bound to this field.

Returns:

a map from string to serializable.