de.hybris.platform.lucenesearch.jalo

Interface IndexedDataFactory

All Known Implementing Classes:

DefaultIndexedDataFactory

public interface IndexedDataFactory

A indexed data factory is required to provide all data of a lucene search index in form of IndexedData objects for one IndexConfiguration instance. It may also specify which item type attributes are actually available for indexing e.g. string attributes only. Nevertheless a indexed data factory is not limited to actual attribute values of items - it may add any (text) data which is required inside the index. For instance a PDFMedia factory may translate the raw PDF data into text and put it into a index field together with standard item attributes. The implementation class should be configured for each IndexConfiguration by setting the class name via GeneratedIndexConfiguration.setIndexedDataFactoryClassName(String). If nothing has been specified the default factory implementation DefaultIndexedDataFactory is used. Each implementations must provide a public no-arg constructor.

Method Summary

Modifier and Type	Method and Description
void	documentCreated(IndexConfiguration config, IndexedData data, Document doc) Called after all item fields has been put into a Document just before writing the document into the lucene index.
Collection<AttributeDescriptor>	getActivationAttributes(IndexConfiguration config) Deprecated.
Collection<AttributeDescriptor>	getGroupingAttributes(IndexConfiguration config) Deprecated.
Collection<AttributeDescriptor>	getIndexableAttributes(IndexConfiguration config) Provides all attributes of the composed type of the specified IndexConfiguration which this factory is able to translate into index data.
List<PK>	getIndexableItems(IndexConfiguration config) Provides all indexable items for a given index configuration object as one huge list of PK objects.
Collection<IndexedData>	getIndexedData(IndexConfiguration config, Collection<Item> item) Called upon index update process.
boolean	needUpdate(IndexConfiguration config, Date lastRebuildTimestamp) Tells whether or not the indexed data of a IndexConfiguration is up to date given the last build or update time stamp.

Method Detail

getIndexableAttributes

Collection<AttributeDescriptor> getIndexableAttributes(IndexConfiguration config)

Provides all attributes of the composed type of the specified IndexConfiguration which this factory is able to translate into index data.

Parameters:

config - the index configuration specifying the actual ComposedType

getGroupingAttributes

@Deprecated
Collection<AttributeDescriptor> getGroupingAttributes(IndexConfiguration config)

Deprecated.

Originally used for filtering queries by item type. Now simply add a search term for field 'type' to any query to achieve this goal.

getActivationAttributes

@Deprecated
Collection<AttributeDescriptor> getActivationAttributes(IndexConfiguration config)

Deprecated.

needUpdate

boolean needUpdate(IndexConfiguration config,
                   Date lastRebuildTimestamp)

Tells whether or not the indexed data of a IndexConfiguration is up to date given the last build or update time stamp.

Parameters:

config - the index configuration to check status for

lastRebuildTimestamp - the last index rebuild or update time

getIndexableItems

List<PK> getIndexableItems(IndexConfiguration config)

Provides all indexable items for a given index configuration object as one huge list of PK objects. This is called each time the whole index has to be rebuilt.

Parameters:

config - the index configuration to get all items for

getIndexedData

Collection<IndexedData> getIndexedData(IndexConfiguration config,
                                       Collection<Item> item)

Called upon index update process. The factory must return one IndexedData object for each specified item if it is covered by the specified IndexConfiguration.

documentCreated

void documentCreated(IndexConfiguration config,
                     IndexedData data,
                     Document doc)

Called after all item fields has been put into a Document just before writing the document into the lucene index.

Use this hook to perform document modifications like setting its boost factor.

Parameters:

config - the index configuration which this document has been created for

data - the data record which provided all document fields.

doc - the new document object