de.hybris.platform.lucenesearch.jalo

Class IndexConfiguration

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.lucenesearch.jalo.GeneratedAbstractLuceneItem

de.hybris.platform.lucenesearch.jalo.AbstractLuceneItem

de.hybris.platform.lucenesearch.jalo.GeneratedIndexConfiguration

de.hybris.platform.lucenesearch.jalo.IndexConfiguration

All Implemented Interfaces:

Serializable, Comparable

public class IndexConfiguration
extends GeneratedIndexConfiguration

An IndexConfiguration adds items of a given type to a LuceneIndex, indexing some specified attributes. There can be several IndexConfigurations for one LuceneIndex, so you can for example store product and category descriptions in one index.
As default the GroupingAttribute is set to the itemtype of the item .

You can create a new IndexConfiguration by calling LuceneIndex#createIndexConfiguration.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields inherited from class de.hybris.platform.lucenesearch.jalo.GeneratedIndexConfiguration

ACTIVATIONATTRIBUTE, ALLAVAILABLEATTRIBUTES, ATTRIBUTECONFIGURATIONS, AVAILABLEACTIVATIONATTRIBUTES, AVAILABLEGROUPINGATTRIBUTES, AVAILABLEINDEXABLEATTRIBUTES, DEFAULT_INITIAL_ATTRIBUTES, GROUPINGATTRIBUTE, INCLUDEDTYPES, INDEXEDDATAFACTORYCLASSNAME, INDEXEDDATAPARAMS, INDEXEDTYPE, INDEXTYPERELATION_MARKMODIFIED, INDEXTYPERELATION_SRC_ORDERED, INDEXTYPERELATION_TGT_ORDERED, LUCENEINDEX, PENDINGUPDATES

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
IndexConfiguration()

Method Summary

Modifier and Type	Method and Description
protected void	addToIndex(Map<Language,IndexWriter> writers)
AttributeConfiguration	createAttributeConfiguration(AttributeDescriptor descr)
AttributeConfiguration	createAttributeConfiguration(AttributeDescriptor descr, String fieldName, Double weight, boolean exact)
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
protected Field	createPKField(IndexedData data)
protected Field	createTypeField(IndexedData data)
Collection	getAllAvailableAttributes(SessionContext ctx) Generated method - Getter of the IndexConfiguration.allAvailableAttributes attribute.
protected Collection<IndexUpdate>	getAllUpdates(SessionContext ctx)
Collection<AttributeConfiguration>	getAttributeConfigurations() Generated method - Getter of the IndexConfiguration.attributeConfigurations attribute.
Collection<AttributeConfiguration>	getAttributeConfigurations(SessionContext ctx) Generated method - Getter of the IndexConfiguration.attributeConfigurations attribute.
Collection	getAvailableActivationAttributes(SessionContext ctx) Generated method - Getter of the IndexConfiguration.availableActivationAttributes attribute.
Collection	getAvailableGroupingAttributes(SessionContext ctx) Generated method - Getter of the IndexConfiguration.availableGroupingAttributes attribute.
Collection	getAvailableIndexableAttributes(SessionContext ctx) Generated method - Getter of the IndexConfiguration.availableIndexableAttributes attribute.
Collection<ComposedType>	getIncludedTypes() Generated method - Getter of the IndexConfiguration.includedTypes attribute.
Collection<ComposedType>	getIncludedTypes(SessionContext ctx) Generated method - Getter of the IndexConfiguration.includedTypes attribute.
Collection<AttributeDescriptor>	getIndexedAttributes()
protected IndexedDataFactory	getIndexedDataFactory()
protected Map<String,List<AttributeConfiguration>>	getIndexFieldMap()
Collection<IndexUpdate>	getPendingUpdates() Generated method - Getter of the IndexConfiguration.pendingUpdates attribute.
Collection<IndexUpdate>	getPendingUpdates(SessionContext ctx) Generated method - Getter of the IndexConfiguration.pendingUpdates attribute.
protected Collection<ComposedType>	getPermittedTypes(ComposedType type)
IndexUpdate	getScheduledUpdate(CronJob cronJob, PK itemPK)
protected String	getTypeFieldString(PK typePK)
protected Map<PK,String>	getTypeStringCache()
boolean	hasLocalizedAttribute() Checks whether the index configuration contains a localized attribute configuration.
protected void	indexItem(Language lang, IndexWriter writer, IndexedData itemData, IndexedDataFactory dataFactory)
boolean	isUpToDate() Checks whether or not the underlying IndexedDataFactory reports that the index needs to be updated.
void	remove(SessionContext ctx) Removes this item.
Collection<IndexUpdate>	scheduleUpdate(Collection<CronJob> performingCronJobs, Collection<Item> items, boolean remove)
void	setActivationAttribute(SessionContext ctx, AttributeDescriptor descr) Generated method - Setter of the IndexConfiguration.activationAttribute attribute.
void	setAttributeConfigurations(SessionContext ctx, Collection<AttributeConfiguration> attributeConfigurations) Generated method - Setter of the IndexConfiguration.attributeConfigurations attribute.
void	setIncludedTypes(SessionContext ctx, Collection<ComposedType> types) Generated method - Setter of the IndexConfiguration.includedTypes attribute.
protected void	setIndexedType(SessionContext ctx, ComposedType type) overwrites the generated setIndexedType Method and set the grouping attribute to 'itemtype'
void	setPendingUpdates(SessionContext ctx, Collection<IndexUpdate> updates) Generated method - Setter of the IndexConfiguration.pendingUpdates attribute.
protected void	updateIndexForItem(Map<Language,IndexWriter> writers, Collection<Item> item)

Methods inherited from class de.hybris.platform.lucenesearch.jalo.GeneratedIndexConfiguration

addToIncludedTypes, addToIncludedTypes, getActivationAttribute, getActivationAttribute, getAllAvailableAttributes, getAvailableActivationAttributes, getAvailableGroupingAttributes, getAvailableIndexableAttributes, getDefaultAttributeModes, getGroupingAttribute, getGroupingAttribute, getIncludedTypesCount, getIncludedTypesCount, getIndexedDataFactoryClassName, getIndexedDataFactoryClassName, getIndexedDataParams, getIndexedDataParams, getIndexedType, getIndexedType, getLuceneIndex, getLuceneIndex, removeFromIncludedTypes, removeFromIncludedTypes, setActivationAttribute, setAttributeConfigurations, setGroupingAttribute, setGroupingAttribute, setIncludedTypes, setIndexedDataFactoryClassName, setIndexedDataFactoryClassName, setIndexedDataParams, setIndexedDataParams, setIndexedType, setLuceneIndex, setLuceneIndex, setPendingUpdates

Methods inherited from class de.hybris.platform.jalo.GenericItem

getInitialProperties, getNonInitialAttributes

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

getImplementation, setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexConfiguration

public IndexConfiguration()

Method Detail

createItem

protected Item createItem(SessionContext ctx,
                          ComposedType type,
                          Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Description copied from class: Item

Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
Sn example:

 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }

 

Overrides:

createItem in class GenericItem

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Description copied from class: Item

Removes this item.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
n/a (this is a setter method)		no, language doesn't matter for removal		yes if called on a StageableItem, no otherwise

Overrides:

remove in class Item

Parameters:

ctx - A SessionContext object

Throws:

ConsistencyCheckException - if this item could not be removed for some reason

getIndexedDataFactory

protected IndexedDataFactory getIndexedDataFactory()

isUpToDate

public boolean isUpToDate()

Checks whether or not the underlying IndexedDataFactory reports that the index needs to be updated.

addToIndex

protected void addToIndex(Map<Language,IndexWriter> writers)

createPKField

protected Field createPKField(IndexedData data)

getTypeStringCache

protected Map<PK,String> getTypeStringCache()

getTypeFieldString

protected String getTypeFieldString(PK typePK)

createTypeField

protected Field createTypeField(IndexedData data)

indexItem

protected void indexItem(Language lang,
                         IndexWriter writer,
                         IndexedData itemData,
                         IndexedDataFactory dataFactory)
                  throws IOException

Throws:

IOException

updateIndexForItem

protected void updateIndexForItem(Map<Language,IndexWriter> writers,
                                  Collection<Item> item)

setActivationAttribute

public void setActivationAttribute(SessionContext ctx,
                                   AttributeDescriptor descr)

Description copied from class: GeneratedIndexConfiguration

Generated method - Setter of the IndexConfiguration.activationAttribute attribute.

Overrides:

setActivationAttribute in class GeneratedIndexConfiguration

descr - the activationAttribute - Optional descriptor of boolean attribute. Instances must have the value true in this attribute to be indexed. Is limited to the values of the availableActivationAttributes attribute.

getIndexFieldMap

protected Map<String,List<AttributeConfiguration>> getIndexFieldMap()

getAttributeConfigurations

public Collection<AttributeConfiguration> getAttributeConfigurations()

Description copied from class: GeneratedIndexConfiguration

Generated method - Getter of the IndexConfiguration.attributeConfigurations attribute.

Overrides:

getAttributeConfigurations in class GeneratedIndexConfiguration

Returns:

the attributeConfigurations - All AttributeConfiguration objects that belong to this IndexConfiguration. Jalo-only attribute.

getAttributeConfigurations

public Collection<AttributeConfiguration> getAttributeConfigurations(SessionContext ctx)

Description copied from class: GeneratedIndexConfiguration

Generated method - Getter of the IndexConfiguration.attributeConfigurations attribute.

Specified by:

getAttributeConfigurations in class GeneratedIndexConfiguration

Returns:

the attributeConfigurations - All AttributeConfiguration objects that belong to this IndexConfiguration. Jalo-only attribute.

getIndexedAttributes

public Collection<AttributeDescriptor> getIndexedAttributes()

setAttributeConfigurations

public void setAttributeConfigurations(SessionContext ctx,
                                       Collection<AttributeConfiguration> attributeConfigurations)

Description copied from class: GeneratedIndexConfiguration

Generated method - Setter of the IndexConfiguration.attributeConfigurations attribute.

Specified by:

setAttributeConfigurations in class GeneratedIndexConfiguration

attributeConfigurations - the attributeConfigurations - All AttributeConfiguration objects that belong to this IndexConfiguration. Jalo-only attribute.

createAttributeConfiguration

public AttributeConfiguration createAttributeConfiguration(AttributeDescriptor descr)

createAttributeConfiguration

public AttributeConfiguration createAttributeConfiguration(AttributeDescriptor descr,
                                                           String fieldName,
                                                           Double weight,
                                                           boolean exact)

getAllAvailableAttributes

public Collection getAllAvailableAttributes(SessionContext ctx)

Description copied from class: GeneratedIndexConfiguration

Generated method - Getter of the IndexConfiguration.allAvailableAttributes attribute.

Specified by:

getAllAvailableAttributes in class GeneratedIndexConfiguration

Returns:

the allAvailableAttributes - Returns all attributes of the type specified by the indexedType attribute. Jalo-only attribute.

getAvailableActivationAttributes

public Collection getAvailableActivationAttributes(SessionContext ctx)

Description copied from class: GeneratedIndexConfiguration

Generated method - Getter of the IndexConfiguration.availableActivationAttributes attribute.

Specified by:

getAvailableActivationAttributes in class GeneratedIndexConfiguration

Returns:

the availableActivationAttributes - all AttributeDescriptors of the indexed type. Jalo-only attribute. Deprecated.

getAvailableIndexableAttributes

public Collection getAvailableIndexableAttributes(SessionContext ctx)

Description copied from class: GeneratedIndexConfiguration

Generated method - Getter of the IndexConfiguration.availableIndexableAttributes attribute.

Specified by:

getAvailableIndexableAttributes in class GeneratedIndexConfiguration

Returns:

the availableIndexableAttributes - Gets all available attributes of the specified type which are indexable. Jalo-only attribute.

getAvailableGroupingAttributes

public Collection getAvailableGroupingAttributes(SessionContext ctx)

Description copied from class: GeneratedIndexConfiguration

Generated method - Getter of the IndexConfiguration.availableGroupingAttributes attribute.

Specified by:

getAvailableGroupingAttributes in class GeneratedIndexConfiguration

Returns:

the availableGroupingAttributes - all groupable AttributeDescriptors of the indexed type. Jalo-only attribute. Deprecated.

setIndexedType

protected void setIndexedType(SessionContext ctx,
                              ComposedType type)

overwrites the generated setIndexedType Method and set the grouping attribute to 'itemtype'

Overrides:

setIndexedType in class GeneratedIndexConfiguration

type - the indexedType - The item type whose instances will be indexed. Initial attribute, cannot be edited after the IndexConfiguration has been created.

getPermittedTypes

protected Collection<ComposedType> getPermittedTypes(ComposedType type)

scheduleUpdate

public Collection<IndexUpdate> scheduleUpdate(Collection<CronJob> performingCronJobs,
                                              Collection<Item> items,
                                              boolean remove)

getScheduledUpdate

public IndexUpdate getScheduledUpdate(CronJob cronJob,
                                      PK itemPK)

getIncludedTypes

public Collection<ComposedType> getIncludedTypes()

Description copied from class: GeneratedIndexConfiguration

Generated method - Getter of the IndexConfiguration.includedTypes attribute.

Overrides:

getIncludedTypes in class GeneratedIndexConfiguration

Returns:

the includedTypes - Only types specified here will be used within the index. Types not specified will not be indexed. Attribute created via the IndexTypeRelation relation.

getIncludedTypes

public Collection<ComposedType> getIncludedTypes(SessionContext ctx)

Description copied from class: GeneratedIndexConfiguration

Generated method - Getter of the IndexConfiguration.includedTypes attribute.

Overrides:

getIncludedTypes in class GeneratedIndexConfiguration

Returns:

the includedTypes - Only types specified here will be used within the index. Types not specified will not be indexed. Attribute created via the IndexTypeRelation relation.

setIncludedTypes

public void setIncludedTypes(SessionContext ctx,
                             Collection<ComposedType> types)

Description copied from class: GeneratedIndexConfiguration

Generated method - Setter of the IndexConfiguration.includedTypes attribute.

Overrides:

setIncludedTypes in class GeneratedIndexConfiguration

types - the includedTypes - Only types specified here will be used within the index. Types not specified will not be indexed. Attribute created via the IndexTypeRelation relation.

getPendingUpdates

public Collection<IndexUpdate> getPendingUpdates()

Description copied from class: GeneratedIndexConfiguration

Generated method - Getter of the IndexConfiguration.pendingUpdates attribute.

Overrides:

getPendingUpdates in class GeneratedIndexConfiguration

Returns:

the pendingUpdates - A collection of all IndexUpdate objects that refer to objects of the given type which currently exist and which have to be updated. Jalo-only attribute. Entries are retrieved via a FlexibleSearch statement.

getAllUpdates

protected Collection<IndexUpdate> getAllUpdates(SessionContext ctx)

getPendingUpdates

public Collection<IndexUpdate> getPendingUpdates(SessionContext ctx)

Description copied from class: GeneratedIndexConfiguration

Generated method - Getter of the IndexConfiguration.pendingUpdates attribute.

Specified by:

getPendingUpdates in class GeneratedIndexConfiguration

Returns:

the pendingUpdates - A collection of all IndexUpdate objects that refer to objects of the given type which currently exist and which have to be updated. Jalo-only attribute. Entries are retrieved via a FlexibleSearch statement.

setPendingUpdates

public void setPendingUpdates(SessionContext ctx,
                              Collection<IndexUpdate> updates)

Description copied from class: GeneratedIndexConfiguration

Generated method - Setter of the IndexConfiguration.pendingUpdates attribute.

Specified by:

setPendingUpdates in class GeneratedIndexConfiguration

updates - the pendingUpdates - A collection of all IndexUpdate objects that refer to objects of the given type which currently exist and which have to be updated. Jalo-only attribute. Entries are retrieved via a FlexibleSearch statement.

hasLocalizedAttribute

public boolean hasLocalizedAttribute()

Checks whether the index configuration contains a localized attribute configuration.

Returns:

true if it contains a localized attribute configuration. false otherwise