org.nuxeo.ecm.core.search.api.backend.indexing.resources.impl
Class ResolvedDataImpl

java.lang.Object
  org.nuxeo.ecm.core.search.api.backend.indexing.resources.impl.ResolvedDataImpl

All Implemented Interfaces:

java.io.Serializable, ResolvedData

public class ResolvedDataImpl
extends java.lang.Object
implements ResolvedData

Resolved data implementation.

Author:

Julien Anguenot

See Also:

Serialized Form

Constructor Summary

ResolvedDataImpl()

ResolvedDataImpl(java.lang.String name, java.lang.String analyzerName, java.lang.String typeName, java.lang.Object value, boolean stored, boolean indexed, boolean multiple, boolean sortable, java.util.Map<java.lang.String,java.lang.String> termVector, boolean binary, java.util.Map<java.lang.String,java.io.Serializable> properties)
Deprecated. Use #ResolvedDataImpl(String,String,String,Object,boolean,boolean,boolean,boolean,Map,boolean,Map,String) instead

ResolvedDataImpl(java.lang.String name, java.lang.String analyzerName, java.lang.String typeName, java.lang.Object value, boolean stored, boolean indexed, boolean multiple, boolean sortable, java.lang.String sortOption, java.util.Map<java.lang.String,java.lang.String> termVector, boolean binary, java.util.Map<java.lang.String,java.io.Serializable> properties)

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 ?

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResolvedDataImpl

public ResolvedDataImpl()

ResolvedDataImpl

@Deprecated
public ResolvedDataImpl(java.lang.String name,
                                   java.lang.String analyzerName,
                                   java.lang.String typeName,
                                   java.lang.Object value,
                                   boolean stored,
                                   boolean indexed,
                                   boolean multiple,
                                   boolean sortable,
                                   java.util.Map<java.lang.String,java.lang.String> termVector,
                                   boolean binary,
                                   java.util.Map<java.lang.String,java.io.Serializable> properties)

Deprecated. Use #ResolvedDataImpl(String,String,String,Object,boolean,boolean,boolean,boolean,Map,boolean,Map,String) instead

ResolvedDataImpl

public ResolvedDataImpl(java.lang.String name,
                        java.lang.String analyzerName,
                        java.lang.String typeName,
                        java.lang.Object value,
                        boolean stored,
                        boolean indexed,
                        boolean multiple,
                        boolean sortable,
                        java.lang.String sortOption,
                        java.util.Map<java.lang.String,java.lang.String> termVector,
                        boolean binary,
                        java.util.Map<java.lang.String,java.io.Serializable> properties)

Method Detail

getAnalyzerName

public java.lang.String getAnalyzerName()

Description copied from interface: ResolvedData

Returns the analyzer to apply to this data.

Specified by:

getAnalyzerName in interface ResolvedData

Returns:

the analyzer to apply to this data.

getName

public java.lang.String getName()

Description copied from interface: ResolvedData

Returns the name of the indexable data.

Specified by:

getName in interface ResolvedData

Returns:

the name of the indexable data.

getTypeName

public java.lang.String getTypeName()

Description copied from interface: ResolvedData

Returns the target data type.

Specified by:

getTypeName in interface ResolvedData

Returns:

the target data type.

getValue

public java.lang.Object getValue()

Description copied from interface: ResolvedData

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.

Specified by:

getValue in interface ResolvedData

Returns:

the actual indexable value as a Java Object

isStored

public boolean isStored()

Description copied from interface: ResolvedData

Is this indexable data aimed at being stored ?

Specified by:

isStored in interface ResolvedData

Returns:

true if stored / false if unstored.

getTermVector

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

Description copied from interface: ResolvedData

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

Specified by:

getTermVector in interface ResolvedData

Returns:

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

isIndexed

public boolean isIndexed()

Description copied from interface: ResolvedData

Is this indexable data aimed at being indexed ?

Specified by:

isIndexed in interface ResolvedData

Returns:

true if indexed / false if unindexed

isBinary

public boolean isBinary()

Description copied from interface: ResolvedData

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

Specified by:

isBinary in interface ResolvedData

Returns:

true if binary / false if not.

isMultiple

public boolean isMultiple()

Description copied from interface: ResolvedData

Is this data multivalued ?

Specified by:

isMultiple in interface ResolvedData

Returns:

true if multivalued / false if not.

isSortable

public boolean isSortable()

Specified by:

isSortable in interface ResolvedData

See Also:

IndexableResourceDataConf.isSortable()

getSortOption

public java.lang.String getSortOption()

Specified by:

getSortOption in interface ResolvedData

See Also:

IndexableResourceDataConf.getSortOption()

getProperties

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

Specified by:

getProperties in interface ResolvedData

See Also:

IndexableResourceDataConf.getProperties()