de.hybris.platform.lucenesearch.jalo

Class LucenesearchManager

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.extension.Extension

de.hybris.platform.lucenesearch.jalo.GeneratedLucenesearchManager

de.hybris.platform.lucenesearch.jalo.LucenesearchManager

All Implemented Interfaces:

Serializable

public class LucenesearchManager
extends GeneratedLucenesearchManager

This is the manager for the lucenesearch extension.

Lucenesearch stores information in indexes. Indexes are updated and searched separately. This allows to construct separate search spaces for frontend and backend searches.

For each index, a number of IndexConfigurations can be created. Each represents a type whos instances are added to the index. The AttributeConfigurations belonging to the IndexConfigurationdefine which fields of the type are indexed.

Additionally, IndexConfigurations can declare an activation attibute and a grouping attribute.

• Activation allows items to be excluded from the index completely unless a specified boolean attribute has the value true.
• Grouping puts an indexed item into one or several groups. When searching the index, the result can be restricted to those items contained in certain groups. (Please note that the default implementation does not support multiple groups.)

For performance reasons, the search information is kept in a filesystem, not the database. The root directory where lucenesearch stores information can be configured through the project.properties entry lucenesearch.indexdir of the lucenesearch extension. Make sure this points to a shared directory in a clustered environment.

If the possibilities offered by Index- and AttributeConfiguration are not sufficient, it is possible to replace the IndexedDataFactory, see setIndexedDataFactoryClassName and IndexedDataFactory.

Context-specific visibility checks can be implemented using a PostQueryFilter.

See Also:

Serialized Form

Nested Class Summary

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

Extension.RestrictedLanguagesProvider, Extension.RightsProvider

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

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Field Summary

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

DEFAULT_INITIAL_ATTRIBUTES, INDEXTYPERELATION_MARKMODIFIED, INDEXTYPERELATION_SRC_ORDERED, INDEXTYPERELATION_TGT_ORDERED

Constructor Summary

Constructors

Constructor and Description
LucenesearchManager()

Method Summary

Modifier and Type	Method and Description
protected void	abortAllUpdateCronjobs(boolean allNodes)
protected void	checkBeforeItemRemoval(SessionContext ctx, Item item) Superclass method overridden to avoid calls to ejb layer.
void	createEssentialData(Map values, JspContext jspc) installs the lucenesearch's RebuildIndexJob, and creates an LuceneIndex on product code and name if LucenesearchConstants.CREATE_PARAMETER_PRODUCTINDEXis set to true
void	createHMCIndex(Map values, JspContext jspc)
void	createHMCIndexOld(Map values, JspContext jspc)
LuceneIndex	createLuceneIndex(String code) Creates a new LuceneIndex with the given code, initially without any IndexConfigurations.
void	createProjectData(Map params, JspContext jspc)
protected void	createRebuildCronjob()
protected void	createUpdateCronjob()
protected Set<ComposedType>	getConcreteTypes(ComposedType indexedType, Map<ComposedType,Map<AttributeDescriptor,String>> indexedAttributes)
String	getCreatorParameterDefault(String param) Override this method to provide default value for the given creator parameter.
Collection	getCreatorParameterNames() Override this method to provide parameters for the system creator.
List	getCreatorParameterPossibleValues(String param) Override this method to provide a list of all possible values for the given creator parameter.
static LucenesearchManager	getInstance()
LuceneIndex	getLuceneIndex(String code) Gets the LuceneIndex with the given code.
Set<LuceneIndex>	getLuceneIndexes() Gets all LuceneIndexes.
protected int	getMaxClusterID()
CronJob	getRebuildIndexCronJob() Gets the CronJob that runs the RebuildIndexJob.
RebuildIndexJob	getRebuildIndexJob() Gets the single RebuildIndexJob instance.
UpdateIndexJob	getUpdateIndexJob()
void	notifyInitializationEnd(Map params, JspContext ctx)
protected void	notifyItemRemoval(SessionContext ctx, Item item) Superclass method overridden to avoid calls to ejb layer.
void	rebuildAllIndexes() calls LuceneIndex.rebuildIndex()on all indexes
protected boolean	rebuildIndexesRequested(Map params)
void	updateAllIndexesForItem(Item item) calls LuceneIndex.updateIndexForItem(Item)on all indexes
void	updateAllIndexesForItem(Item item, boolean remove)

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

createAttributeConfiguration, createAttributeConfiguration, createIndexConfiguration, createIndexConfiguration, createIndexUpdate, createIndexUpdate, createLanguageConfiguration, createLanguageConfiguration, createLuceneIndex, createLuceneIndex, createRebuildIndexJob, createRebuildIndexJob, createUpdateIndexJob, createUpdateIndexJob, getDefaultAttributeModes, getHmcIndexField, getHmcIndexField, getName, isForceLuceneIndexable, isForceLuceneIndexable, isForceLuceneIndexableAsPrimitive, isForceLuceneIndexableAsPrimitive, setForceLuceneIndexable, setForceLuceneIndexable, setForceLuceneIndexable, setForceLuceneIndexable, setHmcIndexField, setHmcIndexField

Methods inherited from class de.hybris.platform.jalo.extension.Extension

createSampleData, getCreatorDescription, getCreatorName, getRemote, isCreatorDisabled, notifyInitializationStart, onFirstSessionCreation, writeReplace

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

afterItemCreation, beforeItemCreation, destroy, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, unwrap, unwrap, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

LucenesearchManager

public LucenesearchManager()

Method Detail

getInstance

public static LucenesearchManager getInstance()

Returns:

instance of this manager

checkBeforeItemRemoval

protected void checkBeforeItemRemoval(SessionContext ctx,
                                      Item item)
                               throws ConsistencyCheckException

Superclass method overridden to avoid calls to ejb layer.

Overrides:

checkBeforeItemRemoval in class Extension

Parameters:

ctx - the current session context

item - the item which should be removed

Throws:

ConsistencyCheckException - thrown to abort removal due to consistency errors

Since:

2.10

notifyItemRemoval

protected void notifyItemRemoval(SessionContext ctx,
                                 Item item)

Superclass method overridden to avoid calls to ejb layer.

Overrides:

notifyItemRemoval in class Extension

Parameters:

ctx - the currency session context

item - the item which is going to be removed

Since:

2.10

createLuceneIndex

public LuceneIndex createLuceneIndex(String code)

Creates a new LuceneIndex with the given code, initially without any IndexConfigurations.

getLuceneIndex

public LuceneIndex getLuceneIndex(String code)
                           throws JaloItemNotFoundException

Gets the LuceneIndex with the given code.

Throws:

JaloItemNotFoundException - if there is no such index

getLuceneIndexes

public Set<LuceneIndex> getLuceneIndexes()

Gets all LuceneIndexes.

Returns:

a set of LuceneIndexes

updateAllIndexesForItem

public void updateAllIndexesForItem(Item item)

calls LuceneIndex.updateIndexForItem(Item)on all indexes

updateAllIndexesForItem

public void updateAllIndexesForItem(Item item,
                                    boolean remove)

abortAllUpdateCronjobs

protected void abortAllUpdateCronjobs(boolean allNodes)

rebuildAllIndexes

public void rebuildAllIndexes()

calls LuceneIndex.rebuildIndex()on all indexes

getRebuildIndexJob

public RebuildIndexJob getRebuildIndexJob()

Gets the single RebuildIndexJob instance.

getUpdateIndexJob

public UpdateIndexJob getUpdateIndexJob()

getRebuildIndexCronJob

public CronJob getRebuildIndexCronJob()

Gets the CronJob that runs the RebuildIndexJob.

Throws:

JaloItemNotFoundException - if the RebuildIndex CronJob does not exist

getCreatorParameterNames

public Collection getCreatorParameterNames()

Description copied from class: Extension

Override this method to provide parameters for the system creator.

Overrides:

getCreatorParameterNames in class Extension

Returns:

parameter names for the creator

getCreatorParameterDefault

public String getCreatorParameterDefault(String param)

Description copied from class: Extension

Override this method to provide default value for the given creator parameter.

Overrides:

getCreatorParameterDefault in class Extension

Parameters:

param - the name of the parameter

Returns:

default value for the given creator parameter; use null when the parameter should have no default value

getCreatorParameterPossibleValues

public List getCreatorParameterPossibleValues(String param)

Description copied from class: Extension

Override this method to provide a list of all possible values for the given creator parameter. If not null the list of these values will be shown to the user of system creator and no other values will be possible to set.

Overrides:

getCreatorParameterPossibleValues in class Extension

Parameters:

param - the name of the parameter

Returns:

list of all possible values for the given creator parameter; use null when this parameter should have no restriction of possible values

createEssentialData

public void createEssentialData(Map values,
                                JspContext jspc)
                         throws Exception

installs the lucenesearch's RebuildIndexJob, and creates an LuceneIndex on product code and name if LucenesearchConstants.CREATE_PARAMETER_PRODUCTINDEXis set to true

Overrides:

createEssentialData in class Extension

Throws:

Exception

rebuildIndexesRequested

protected boolean rebuildIndexesRequested(Map params)

notifyInitializationEnd

public void notifyInitializationEnd(Map params,
                                    JspContext ctx)
                             throws Exception

Overrides:

notifyInitializationEnd in class Extension

Throws:

Exception

createRebuildCronjob

protected void createRebuildCronjob()

Since:

2.10

createUpdateCronjob

protected void createUpdateCronjob()

getMaxClusterID

protected int getMaxClusterID()

createHMCIndexOld

public void createHMCIndexOld(Map values,
                              JspContext jspc)
                       throws Exception

Throws:

Exception

Since:

2.10

createHMCIndex

public void createHMCIndex(Map values,
                           JspContext jspc)
                    throws Exception

Throws:

Exception

Since:

2.10

getConcreteTypes

protected Set<ComposedType> getConcreteTypes(ComposedType indexedType,
                                             Map<ComposedType,Map<AttributeDescriptor,String>> indexedAttributes)

createProjectData

public void createProjectData(Map params,
                              JspContext jspc)

Overrides:

createProjectData in class Extension