de.hybris.platform.lucenesearch.jalo

Class DefaultIndexedDataFactory

java.lang.Object

de.hybris.platform.lucenesearch.jalo.DefaultIndexedDataFactory

All Implemented Interfaces:

IndexedDataFactory

public class DefaultIndexedDataFactory
extends Object
implements IndexedDataFactory

The default implementation of IndexedDataFactory(see GeneratedIndexConfiguration.setIndexedDataFactoryClassName(String)).

Subclasses can overwrite the protected methods to adapt the IndexedDataFactory's behaviour.

Constructor Summary

Constructors

Constructor and Description
DefaultIndexedDataFactory()

Method Summary

Modifier and Type	Method and Description
protected void	addGroupingSearchFields(IndexConfiguration config, StringBuilder query, List classes) Adds the grouping attribute, if one is set.
protected List	buildIndexedDataList(IndexConfiguration config, List rows) Convert the FlexibleSearch result into a list of IndexedData objects.
void	documentCreated(IndexConfiguration config, IndexedData data, Document doc) Does nothing right now.
Collection	getActivationAttributes(IndexConfiguration config) Deprecated.
protected String	getActivationClause(IndexConfiguration config, Map searchValues) Subclasses may overwrite this method to restrict which items are included in the index.
protected List<de.hybris.platform.lucenesearch.jalo.DefaultIndexedDataFactory.LangIndexSearchBunch>	getDataSearchFields(IndexConfiguration config) Gets the list of the LangIndexSearchBunches
Collection	getGroupingAttributes(IndexConfiguration config) Deprecated.
Collection	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 the specified configuration.
Collection<IndexedData>	getIndexedData(IndexConfiguration config, Collection<Item> items) Calls searchIndexedData(de.hybris.platform.lucenesearch.jalo.IndexConfiguration, java.lang.String, java.util.Map)with an additional condition restricting the query to the given item, and passes the result to buildIndexedDataList(de.hybris.platform.lucenesearch.jalo.IndexConfiguration, java.util.List).
protected Collection<AttributeConfiguration>	getNonSelectableAttributes(Collection<AttributeConfiguration> cfgs)
protected List<AttributeConfiguration>	getSelectableAttributes(Collection<AttributeConfiguration> cfgs)
protected boolean	isAttributeIndexable(AttributeDescriptor attributeDescriptor) A attribute is indexable only if its attribute type is String, or the attribute has been explicitely marked indexable via GeneratedLucenesearchConstants.Attributes.AttributeDescriptor.FORCELUCENEINDEXABLE
protected boolean	isFlexibleSearchSelectable(AttributeConfiguration cfg)
protected boolean	isNextBunchNeeded() Returns true if next bunch must be created increases index only for MySQL
boolean	needUpdate(IndexConfiguration config, Date lastRebuildTimestamp) Determines update status by counting all indexable items which Item.MODIFIED_TIME is empty or newer than the given rebuild timestamp.
protected List<PK>	searchIndexableItens(IndexConfiguration config, String additionalConditionQuery, Map additionalConditionValues)
protected List	searchIndexedData(IndexConfiguration config, String additionalConditionQuery, Map additionalConditionValues) Build and execute a FlexibleSearch query, using the methods addGroupingSearchFields, getActivationClause.
protected String	valueToString(SessionContext locCtx, Object rowValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIndexedDataFactory

public DefaultIndexedDataFactory()

Method Detail

getIndexableAttributes

public Collection getIndexableAttributes(IndexConfiguration config)

Description copied from interface: IndexedDataFactory

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

Specified by:

getIndexableAttributes in interface IndexedDataFactory

Parameters:

config - the index configuration specifying the actual ComposedType

getGroupingAttributes

@Deprecated
public Collection getGroupingAttributes(IndexConfiguration config)

Deprecated.

Description copied from interface: IndexedDataFactory

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

Specified by:

getGroupingAttributes in interface IndexedDataFactory

getActivationAttributes

@Deprecated
public Collection getActivationAttributes(IndexConfiguration config)

Deprecated.

Specified by:

getActivationAttributes in interface IndexedDataFactory

isAttributeIndexable

protected boolean isAttributeIndexable(AttributeDescriptor attributeDescriptor)

A attribute is indexable only if

• its attribute type is String, or
• the attribute has been explicitely marked indexable via GeneratedLucenesearchConstants.Attributes.AttributeDescriptor.FORCELUCENEINDEXABLE

Parameters:

attributeDescriptor -

Returns:

true if the attribute allows beeing indexed

needUpdate

public boolean needUpdate(IndexConfiguration config,
                          Date lastRebuildTimestamp)

Determines update status by counting all indexable items which Item.MODIFIED_TIME is empty or newer than the given rebuild timestamp.

Please note that this does not reflect changes which do not alter the Item.MODIFIED_TIME attribute!

Specified by:

needUpdate in interface IndexedDataFactory

Parameters:

config - the index configuration to check status for

lastRebuildTimestamp - the last index rebuild or update time

searchIndexedData

protected List searchIndexedData(IndexConfiguration config,
                                 String additionalConditionQuery,
                                 Map additionalConditionValues)

Build and execute a FlexibleSearch query, using the methods

• addGroupingSearchFields,
• getActivationClause.

The query is built as SELECT PK dataSearchFields groupingSearchFields FROM { fromClause } [ WHERE ] activationClause [ AND ] additionalCondition ORDER BY PK .

searchIndexableItens

protected List<PK> searchIndexableItens(IndexConfiguration config,
                                        String additionalConditionQuery,
                                        Map additionalConditionValues)

getSelectableAttributes

protected List<AttributeConfiguration> getSelectableAttributes(Collection<AttributeConfiguration> cfgs)

getNonSelectableAttributes

protected Collection<AttributeConfiguration> getNonSelectableAttributes(Collection<AttributeConfiguration> cfgs)

isFlexibleSearchSelectable

protected boolean isFlexibleSearchSelectable(AttributeConfiguration cfg)

getDataSearchFields

protected List<de.hybris.platform.lucenesearch.jalo.DefaultIndexedDataFactory.LangIndexSearchBunch> getDataSearchFields(IndexConfiguration config)

Gets the list of the LangIndexSearchBunches

Parameters:

config - the IndexConfiguration query that is the list of the LangIndexSearchBunch being built of

isNextBunchNeeded

protected boolean isNextBunchNeeded()

Returns true if next bunch must be created increases index only for MySQL

If the limit of BUNCH_SIZE is reached returns true else returns false

valueToString

protected String valueToString(SessionContext locCtx,
                               Object rowValue)

buildIndexedDataList

protected List buildIndexedDataList(IndexConfiguration config,
                                    List rows)

Convert the FlexibleSearch result into a list of IndexedData objects.

Consecutive data lists in searchResult for the same PK are merged into a single IndexedData. They are expected to be identical in all data fields, and to differ only in the grouping field. This allows subclasses to get n-to-m grouping information from joined tables (see addGroupingSearchFields(de.hybris.platform.lucenesearch.jalo.IndexConfiguration, java.lang.StringBuilder, java.util.List)).

Parameters:

config - IndexConfiguration

rows - a List of rows

Returns:

a list of IndexedDataobjects

addGroupingSearchFields

protected void addGroupingSearchFields(IndexConfiguration config,
                                       StringBuilder query,
                                       List classes)

Adds the grouping attribute, if one is set. If this method is overridden for a custom grouping implementation, it is still necessary to set a (arbitrary) grouping attribute; otherwise buildIndexedDataList(de.hybris.platform.lucenesearch.jalo.IndexConfiguration, java.util.List)will not be able to read the search result. Additionaly, the hmc lucenesearch screen will not be able to determine the possible grouping values unless the grouping attribute is set appropriately.

Parameters:

query - the FlexibleSearch query that is being built

classes - the result classes of the FlexibleSearch

getActivationClause

protected String getActivationClause(IndexConfiguration config,
                                     Map searchValues)

Subclasses may overwrite this method to restrict which items are included in the index. The default implementation uses the IndexConfiguration's activation attribute, if it is set.

Parameters:

searchValues - the search values of the FlexibleSearch

Returns:

a part of the FlexibleSearch query that is being built; will be inserted in the 'WHERE ...' part of the query

getIndexedData

public Collection<IndexedData> getIndexedData(IndexConfiguration config,
                                              Collection<Item> items)

Calls searchIndexedData(de.hybris.platform.lucenesearch.jalo.IndexConfiguration, java.lang.String, java.util.Map)with an additional condition restricting the query to the given item, and passes the result to buildIndexedDataList(de.hybris.platform.lucenesearch.jalo.IndexConfiguration, java.util.List).

Specified by:

getIndexedData in interface IndexedDataFactory

Returns:

null if the item should not be indexed

getIndexableItems

public List<PK> getIndexableItems(IndexConfiguration config)

Provides all indexable items for the specified configuration.

Specified by:

getIndexableItems in interface IndexedDataFactory

Parameters:

config - the index configuration to get all items for

documentCreated

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

Does nothing right now.

Specified by:

documentCreated in interface IndexedDataFactory

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