de.hybris.platform.solrfacetsearch.indexer.spi

Interface InputDocument

All Known Implementing Classes:

DefaultSolrInputDocument, DefaultSolrPartialUpdateInputDocument

public interface InputDocument

This interface represents a document to be indexed.

Method Summary

Modifier and Type	Method and Description
void	addField(IndexedProperty indexedProperty, java.lang.Object value) Same as addField(IndexedProperty, Object, String) with implied null value for the qualifier.
void	addField(IndexedProperty indexedProperty, java.lang.Object value, java.lang.String qualifier) Adds a field for the given indexed property, value and qualifier.
void	addField(java.lang.String fieldName, java.lang.Object value) Adds a field with the given name and value.
java.util.Collection<java.lang.String>	getFieldNames() Get collection of field names
java.lang.Object	getFieldValue(java.lang.String fieldName) Gets the value for a certain field name.

Method Detail

addField

void addField(java.lang.String fieldName,
              java.lang.Object value)
       throws FieldValueProviderException

Adds a field with the given name and value. If a field with the same name already exists, then the given value is appended to the value of that field. If the value is a collection, then each of its values will be added to the field.

Parameters:

fieldName - - the field name

value - - the field value

Throws:

FieldValueProviderException

addField

void addField(IndexedProperty indexedProperty,
              java.lang.Object value)
       throws FieldValueProviderException

Same as addField(IndexedProperty, Object, String) with implied null value for the qualifier.

Parameters:

indexedProperty - - the indexed property

value - - the field value

Throws:

FieldValueProviderException

See Also:

addField(IndexedProperty, Object)

addField

void addField(IndexedProperty indexedProperty,
              java.lang.Object value,
              java.lang.String qualifier)
       throws FieldValueProviderException

Adds a field for the given indexed property, value and qualifier. If a field for the same indexed property and qualifier already exists, then the given value is appended to the value of that field. If the value is a collection, then each of its values will be added to the field.

Parameters:

indexedProperty - - the indexed property

value - - the field value

qualifier - - the qualifier

Throws:

FieldValueProviderException

getFieldValue

java.lang.Object getFieldValue(java.lang.String fieldName)

Gets the value for a certain field name.

Parameters:

fieldName - - the field name

Returns:

the field value.

getFieldNames

java.util.Collection<java.lang.String> getFieldNames()

Get collection of field names

Returns:

field name collection