de.hybris.platform.lucenesearch.jalo

Class LuceneIndex

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.GeneratedLuceneIndex

de.hybris.platform.lucenesearch.jalo.LuceneIndex

All Implemented Interfaces:

Serializable, Comparable

public class LuceneIndex
extends GeneratedLuceneIndex

A LuceneIndex is separately searchable and updateable. Multiple instance can be created to support distinct search spaces (e.g. one for each shop in a mall system).

See Also:

LucenesearchManager, IndexConfiguration, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LuceneIndex.CombinedFilter
protected static class	LuceneIndex.IndexProvider IndexProvider methods #lock(File) , #unlock(File) are guarded by a ReentrantReadWriteLock.writeLock() for every distinguish directory name.
protected class	LuceneIndex.MyQueryParser
static class	LuceneIndex.ResultBitSetCacheUnit Special cache unit caching facet value BitSets for a given index.

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.GeneratedLuceneIndex

CODE, DEFAULT_INITIAL_ATTRIBUTES, INDEXCONFIGURATIONS, LANGUAGECONFIGURATIONS, PENDINGUPDATESCOUNT, POSTQUERYFILTERCLASSNAME, REBUILDENDTIMESTAMP, REBUILDSTARTTIMESTAMP, TESTLOC, UPTODATE

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
LuceneIndex()

Method Summary

Modifier and Type	Method and Description
protected void	clearAllScheduledUpdates()
Set<Facet>	cloneFacets(Set<Facet> facets)
protected IndexWriter	configureIndexWriter(IndexWriter writer, int indexConfigurationSize, boolean rebuild)
protected Map<Facet.FacetValue,Query>	createCountQueries(SessionContext ctx, Facet facet) This method provides a single query for each facet value which is being used for calculating the actual hit count of this value within the search result.
protected Query	createCountQuery(SessionContext ctx, Facet.FacetValue value) Creates the query for a single facet value.
IndexConfiguration	createIndexConfiguration(ComposedType indexedType) Create a new IndexConfiguration, without initial languages or indexed attributes.
IndexConfiguration	createIndexConfiguration(ComposedType indexedType, Collection<AttributeDescriptor> indexedAttributes) Create a new IndexConfiguration.
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
LanguageConfiguration	createLanguageConfiguration(Language lang)
LanguageConfiguration	createLanguageConfiguration(Language lang, String analyzerDefinition)
protected Filter	createMandatoryValuesFilter(SessionContext ctx, Set<Facet> facets)
protected Query	createMandatoryValuesQuery(SessionContext ctx, Facet facet) Optionally create a query to limit the actual search result to a set of facet values.
protected LuceneSearchResult	createResult(SessionContext ctx, TopDocs hits, Set<Facet> facets, int requestedStart, int requestedCount, IndexSearcher searcher)
protected String	createTemporaryDirectoryName(Language language)
protected String	createTenantAwarePrefix(String oldPrefix) wraps old index directory prefix name with current tenant id if only current tenant is not master tenant
protected Map<Language,IndexWriter>	createWriterMap(boolean rebuild, int indexConfigurationSize)
protected void	deleteRecursively(File file)
protected String	fileToString(File file)
protected Analyzer	getAnalyzer(SessionContext ctx)
protected DocIdSet	getFacetValueBitsCached(SessionContext ctx, int clusterNode, AtomicReader atomicReader, Facet.FacetValue facetValue) Fetches the bit set of all matching documents for a given facet value.
protected Map<String,Boolean>	getFieldMappings()
Collection<IndexConfiguration>	getIndexConfigurations() Generated method - Getter of the LuceneIndex.indexConfigurations attribute.
Collection<IndexConfiguration>	getIndexConfigurations(SessionContext ctx) Gets all IndexConfigurations in this index.
Collection<IndexConfiguration>	getIndexConfigurationsByIndexedType(ComposedType indexedType) Gets the IndexConfigurations in this index with the given indexedType.
Map<IndexConfiguration,Set<Item>>	getIndexConfigurationsUpdateMap(Collection<Item> items)
protected File	getIndexDirectory(String dirName)
protected File	getIndexDirectory(String dirName, boolean create)
protected static LuceneIndex.IndexProvider	getIndexProvider()
LanguageConfiguration	getLanguageConfiguration(Language language)
Collection<LanguageConfiguration>	getLanguageConfigurations() Generated method - Getter of the LuceneIndex.languageConfigurations attribute.
Collection<LanguageConfiguration>	getLanguageConfigurations(SessionContext ctx) Generated method - Getter of the LuceneIndex.languageConfigurations attribute.
Collection<Language>	getLanguages()
Integer	getPendingUpdatesCount(SessionContext ctx) Generated method - Getter of the LuceneIndex.pendingUpdatesCount attribute.
protected PostQueryFilter	getPostQueryFilter()
protected String	getProductiveDirectoryName(Language language) The name is constructed as prod- code .
protected Map<ComposedType,Set<IndexConfiguration>>	getType2IndexConfigMap()
boolean	hasAttributes() Checks if the index has at least one configuration containing at least one attribute.
protected void	invalidateQueryCaches()
Boolean	isUpToDate(SessionContext ctx) Generated method - Getter of the LuceneIndex.upToDate attribute.
protected void	notifyLanguageConfigurationRemoving(LanguageConfiguration cfg)
Query	parseQuery(SessionContext ctx, String pattern) Parses the given pattern and returns the corresponding lucene Query.
protected void	processFacets(SessionContext ctx, AtomicReader atomicReader, Query baseQuery, Filter filter, Set<Facet> facets)
protected DocIdSet	queryFacetBits(SessionContext ctx, AtomicReader atomicReader, Facet.FacetValue facetValue)
Set<Facet>	queryFacets(SessionContext ctx, Query query, Filter filter, Set<Facet> _facets) Shortcut for just getting facet information rather than fetching the whole result.
void	rebuildIndex() Completely rebuilds the index.
void	remove(SessionContext ctx) remove IndexConfigurations
void	removeItemFromIndex(Collection items)
void	removeItemFromIndex(Item item) Removes a an given Item from index configuration.
protected void	renameOrFail(File fileFrom, File fileTo)
LuceneSearchResult	searchItems(SessionContext ctx, Query query, Filter filter, Sort sort, int requestedStart, int requestedCount) Search in this lucene index; first define your own QueryParser where you interprete your own pattern, the result from the QueryParser (a query) is needed for this method.
LuceneSearchResult	searchItems(SessionContext ctx, Query query, Filter filter, Sort sort, Set<Facet> _facets, int requestedStart, int requestedCount)
LuceneSearchResult	searchItems(SessionContext ctx, String pattern, int requestedStart, int requestedCount) Search for the given pattern in this LuceneIndex, with no constraint on groups.
LuceneSearchResult	searchItems(SessionContext ctx, String pattern, List groups, Filter filter, Sort sort, int requestedStart, int requestedCount)
LuceneSearchResult	searchItems(SessionContext ctx, String pattern, List groups, Filter filter, Sort sort, Set<Facet> facets, int requestedStart, int requestedCount)
LuceneSearchResult	searchItems(SessionContext ctx, String pattern, List groups, int requestedStart, int requestedCount) Search in this LuceneIndex, default implementation of a search with a given pattern; the query is generated in this method and then the methods searchItems(ctx, query, int, int) is called.
LuceneSearchResult	searchItems(SessionContext ctx, String pattern, List groups, String orderBy, boolean ascending, int requestedStart, int requestedCount)
void	setIndexConfigurations(SessionContext ctx, Collection<IndexConfiguration> indexConfigurations) Set the IndexConfigurations of this index.
void	setLanguageConfigurations(SessionContext ctx, Collection<LanguageConfiguration> coll) Generated method - Setter of the LuceneIndex.languageConfigurations attribute.
protected void	setProductive(Language language, File tempDir) Sets a temporary index directory as a replace for current productive for given language.
protected void	setRebuildEndTimestamp(Date timestamp)
protected void	setRebuildStartTimestamp(Date timestamp)
void	updateIndexForItem(Collection<Item> items) Update the data for the given items in this index.
void	updateIndexForItem(Item item) Update the data for the given item in the index.
void	updateIndexForItem(Map<IndexConfiguration,Set<Item>> cfg2ItemsMap)

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

getAllTestLoc, getAllTestLoc, getCode, getCode, getDefaultAttributeModes, getPendingUpdatesCount, getPendingUpdatesCountAsPrimitive, getPendingUpdatesCountAsPrimitive, getPostQueryFilterClassName, getPostQueryFilterClassName, getRebuildEndTimestamp, getRebuildEndTimestamp, getRebuildStartTimestamp, getRebuildStartTimestamp, getTestLoc, getTestLoc, isUpToDate, isUpToDateAsPrimitive, isUpToDateAsPrimitive, setAllTestLoc, setAllTestLoc, setCode, setCode, setIndexConfigurations, setLanguageConfigurations, setPostQueryFilterClassName, setPostQueryFilterClassName, setTestLoc, setTestLoc

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

LuceneIndex

public LuceneIndex()

Method Detail

getIndexProvider

protected static final LuceneIndex.IndexProvider getIndexProvider()

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

remove IndexConfigurations

Overrides:

remove in class Item

Parameters:

ctx - A SessionContext object

Throws:

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

createLanguageConfiguration

public LanguageConfiguration createLanguageConfiguration(Language lang)

createLanguageConfiguration

public LanguageConfiguration createLanguageConfiguration(Language lang,
                                                         String analyzerDefinition)

createIndexConfiguration

public IndexConfiguration createIndexConfiguration(ComposedType indexedType)

Create a new IndexConfiguration, without initial languages or indexed attributes.

createIndexConfiguration

public IndexConfiguration createIndexConfiguration(ComposedType indexedType,
                                                   Collection<AttributeDescriptor> indexedAttributes)

Create a new IndexConfiguration.

Parameters:

indexedType - the indexed type

indexedAttributes - a collection of AttributeDescriptors

setIndexConfigurations

public void setIndexConfigurations(SessionContext ctx,
                                   Collection<IndexConfiguration> indexConfigurations)

Set the IndexConfigurations of this index. This method can only be used to remove index configurations.

Specified by:

setIndexConfigurations in class GeneratedLuceneIndex

indexConfigurations - the indexConfigurations - The IndexConfiguration objects belonging to this LuceneIndex.

getIndexConfigurations

public Collection<IndexConfiguration> getIndexConfigurations()

Description copied from class: GeneratedLuceneIndex

Generated method - Getter of the LuceneIndex.indexConfigurations attribute.

Overrides:

getIndexConfigurations in class GeneratedLuceneIndex

Returns:

the indexConfigurations - The IndexConfiguration objects belonging to this LuceneIndex.

getIndexConfigurations

public Collection<IndexConfiguration> getIndexConfigurations(SessionContext ctx)

Gets all IndexConfigurations in this index.

Specified by:

getIndexConfigurations in class GeneratedLuceneIndex

Returns:

a collection of IndexConfigurations

getIndexConfigurationsByIndexedType

public Collection<IndexConfiguration> getIndexConfigurationsByIndexedType(ComposedType indexedType)

Gets the IndexConfigurations in this index with the given indexedType.

Returns:

a collection of IndexConfigurations

isUpToDate

public Boolean isUpToDate(SessionContext ctx)

Description copied from class: GeneratedLuceneIndex

Generated method - Getter of the LuceneIndex.upToDate attribute.

Specified by:

isUpToDate in class GeneratedLuceneIndex

Returns:

the upToDate - Indicates whether the LuceneIndex needs to be updated or not.

setRebuildStartTimestamp

protected void setRebuildStartTimestamp(Date timestamp)

setRebuildEndTimestamp

protected void setRebuildEndTimestamp(Date timestamp)

rebuildIndex

public void rebuildIndex()
                  throws IndexAccessException

Completely rebuilds the index. The index is written to a temporary directory and then renamed into the productive directory, to allow parallel searches.

The attributes GeneratedLuceneIndex.getRebuildStartTimestamp()and GeneratedLuceneIndex.getRebuildEndTimestamp()are updated before and after rebuilding the index, respectively.

Throws:

IndexAccessException

clearAllScheduledUpdates

protected void clearAllScheduledUpdates()

setProductive

protected void setProductive(Language language,
                             File tempDir)
                      throws IOException

Sets a temporary index directory as a replace for current productive for given language. Internally locks on newly created productive directory name.

Throws:

IOException

notifyLanguageConfigurationRemoving

protected void notifyLanguageConfigurationRemoving(LanguageConfiguration cfg)

createWriterMap

protected Map<Language,IndexWriter> createWriterMap(boolean rebuild,
                                                    int indexConfigurationSize)

configureIndexWriter

protected IndexWriter configureIndexWriter(IndexWriter writer,
                                           int indexConfigurationSize,
                                           boolean rebuild)

getIndexConfigurationsUpdateMap

public Map<IndexConfiguration,Set<Item>> getIndexConfigurationsUpdateMap(Collection<Item> items)

getType2IndexConfigMap

protected Map<ComposedType,Set<IndexConfiguration>> getType2IndexConfigMap()

removeItemFromIndex

public void removeItemFromIndex(Item item)

Removes a an given Item from index configuration. Is not thread safe for simultaneous removes for one index definition.

removeItemFromIndex

public void removeItemFromIndex(Collection items)

See Also:

removeItemFromIndex(Item)

updateIndexForItem

public void updateIndexForItem(Item item)

Update the data for the given item in the index. This may also result in a complete removal of the item.

The attributes GeneratedLuceneIndex.getRebuildStartTimestamp()and GeneratedLuceneIndex.getRebuildEndTimestamp()are updated before and after rebuilding the index, respectively.

updateIndexForItem

public void updateIndexForItem(Collection<Item> items)

Update the data for the given items in this index. This may also result in a complete removal of the item.

The attributes GeneratedLuceneIndex.getRebuildStartTimestamp() and GeneratedLuceneIndex.getRebuildEndTimestamp()are not updated before and after rebuilding the index, respectively.

updateIndexForItem

public void updateIndexForItem(Map<IndexConfiguration,Set<Item>> cfg2ItemsMap)

createTenantAwarePrefix

protected String createTenantAwarePrefix(String oldPrefix)

wraps old index directory prefix name with current tenant id if only current tenant is not master tenant

getProductiveDirectoryName

protected String getProductiveDirectoryName(Language language)

The name is constructed as prod- code .

createTemporaryDirectoryName

protected String createTemporaryDirectoryName(Language language)

getIndexDirectory

protected File getIndexDirectory(String dirName)

getIndexDirectory

protected File getIndexDirectory(String dirName,
                                 boolean create)

renameOrFail

protected void renameOrFail(File fileFrom,
                            File fileTo)
                     throws IOException

Throws:

IOException

fileToString

protected String fileToString(File file)

deleteRecursively

protected void deleteRecursively(File file)

getPostQueryFilter

protected PostQueryFilter getPostQueryFilter()

Returns:

an instance of DefaultPostQueryFilter if no filter is configured

searchItems

public LuceneSearchResult searchItems(SessionContext ctx,
                                      String pattern,
                                      int requestedStart,
                                      int requestedCount)

Search for the given pattern in this LuceneIndex, with no constraint on groups. As default the value of the group attribute is set to the itemtype of the indexed item.

Parameters:

ctx - defines the search language

pattern - see searchItems(SessionContext, String, List, int, int)

requestedCount - maximum number of found items to be returned; -1 for no limit

searchItems

public LuceneSearchResult searchItems(SessionContext ctx,
                                      String pattern,
                                      List groups,
                                      int requestedStart,
                                      int requestedCount)

Search in this LuceneIndex, default implementation of a search with a given pattern; the query is generated in this method and then the methods searchItems(ctx, query, int, int) is called. If no groups are given, the default value for the group field in the index is set to the itemtype of the item.

Parameters:

ctx - defines the search language

pattern - search pattern, will be parsed by the lucene QueryParser

groups - may be null, for no constraint on groups; default value is the itemtype value

requestedCount - maximum number of found items to be returned; -1 for no limit

searchItems

public LuceneSearchResult searchItems(SessionContext ctx,
                                      String pattern,
                                      List groups,
                                      String orderBy,
                                      boolean ascending,
                                      int requestedStart,
                                      int requestedCount)

searchItems

public LuceneSearchResult searchItems(SessionContext ctx,
                                      String pattern,
                                      List groups,
                                      Filter filter,
                                      Sort sort,
                                      int requestedStart,
                                      int requestedCount)

searchItems

public LuceneSearchResult searchItems(SessionContext ctx,
                                      String pattern,
                                      List groups,
                                      Filter filter,
                                      Sort sort,
                                      Set<Facet> facets,
                                      int requestedStart,
                                      int requestedCount)

parseQuery

public Query parseQuery(SessionContext ctx,
                        String pattern)
                 throws org.apache.lucene.queryparser.classic.ParseException

Parses the given pattern and returns the corresponding lucene Query. The default implementation sets the default field according to the Language of the specified SessionContext and uses the StandardAnalyzer from lucene. If the search pattern is null or "", a "*" will be as default pattern assumed

Parameters:

ctx - the SessionContext, which will be used for retrieving the search language

pattern - the search pattern

Returns:

the resulting lucence Query

Throws:

ParseException - if an ParseException occurs during parsing

org.apache.lucene.queryparser.classic.ParseException

getFieldMappings

protected Map<String,Boolean> getFieldMappings()

getAnalyzer

protected Analyzer getAnalyzer(SessionContext ctx)

searchItems

public LuceneSearchResult searchItems(SessionContext ctx,
                                      Query query,
                                      Filter filter,
                                      Sort sort,
                                      int requestedStart,
                                      int requestedCount)
                               throws org.apache.lucene.queryparser.classic.ParseException

Search in this lucene index; first define your own QueryParser where you interprete your own pattern, the result from the QueryParser (a query) is needed for this method.

Parameters:

ctx - sessioncontext, defines the search language

query - result of a QueryParser

requestedStart - startnumber

requestedCount - maximum number of found items to be returned; -1 for no limit

sort - encapsulates sort criteria for returned hits

filter - base class providing a mechanism to restrict searches to a subset of an index

Returns:

the LuceneSearchResult

Throws:

org.apache.lucene.queryparser.classic.ParseException

cloneFacets

public Set<Facet> cloneFacets(Set<Facet> facets)

queryFacets

public Set<Facet> queryFacets(SessionContext ctx,
                              Query query,
                              Filter filter,
                              Set<Facet> _facets)
                       throws org.apache.lucene.queryparser.classic.ParseException

Shortcut for just getting facet information rather than fetching the whole result.

Parameters:

ctx -

query -

filter -

_facets -

Throws:

org.apache.lucene.queryparser.classic.ParseException

searchItems

public LuceneSearchResult searchItems(SessionContext ctx,
                                      Query query,
                                      Filter filter,
                                      Sort sort,
                                      Set<Facet> _facets,
                                      int requestedStart,
                                      int requestedCount)
                               throws org.apache.lucene.queryparser.classic.ParseException

Throws:

org.apache.lucene.queryparser.classic.ParseException

createMandatoryValuesFilter

protected Filter createMandatoryValuesFilter(SessionContext ctx,
                                             Set<Facet> facets)
                                      throws ParseException

Throws:

ParseException

createMandatoryValuesQuery

protected Query createMandatoryValuesQuery(SessionContext ctx,
                                           Facet facet)

Optionally create a query to limit the actual search result to a set of facet values. A facet value has to be hold a Occur object to contribute to this query. Otherwise it is ignored.

Throws:

ParseException

createCountQueries

protected Map<Facet.FacetValue,Query> createCountQueries(SessionContext ctx,
                                                         Facet facet)

This method provides a single query for each facet value which is being used for calculating the actual hit count of this value within the search result.

Throws:

ParseException

createCountQuery

protected Query createCountQuery(SessionContext ctx,
                                 Facet.FacetValue value)

Creates the query for a single facet value. It is called by createMandatoryValuesQuery(SessionContext, Facet) and createCountQueries(SessionContext, Facet).

Throws:

ParseException

invalidateQueryCaches

protected void invalidateQueryCaches()

queryFacetBits

protected DocIdSet queryFacetBits(SessionContext ctx,
                                  AtomicReader atomicReader,
                                  Facet.FacetValue facetValue)
                           throws IOException

Throws:

IOException

getFacetValueBitsCached

protected DocIdSet getFacetValueBitsCached(SessionContext ctx,
                                           int clusterNode,
                                           AtomicReader atomicReader,
                                           Facet.FacetValue facetValue)

Fetches the bit set of all matching documents for a given facet value. This result may be cached at least if the lucenesearch.facets.cache parameter is set to true inside the platform project.properties or local.properties.

Parameters:

ctx - the current session context - required to read session language from

clusterNode - the current cluster node because results are cached per code only

atomicReader - the index reader to run the query upon in case no cached result is available

facetValue - the facet value

Returns:

a bit set containing all matching document positions

processFacets

protected void processFacets(SessionContext ctx,
                             AtomicReader atomicReader,
                             Query baseQuery,
                             Filter filter,
                             Set<Facet> facets)
                      throws IOException

Throws:

IOException

createResult

protected LuceneSearchResult createResult(SessionContext ctx,
                                          TopDocs hits,
                                          Set<Facet> facets,
                                          int requestedStart,
                                          int requestedCount,
                                          IndexSearcher searcher)
                                   throws IOException

Throws:

IOException

getLanguages

public Collection<Language> getLanguages()

getLanguageConfigurations

public Collection<LanguageConfiguration> getLanguageConfigurations()

Description copied from class: GeneratedLuceneIndex

Generated method - Getter of the LuceneIndex.languageConfigurations attribute.

Overrides:

getLanguageConfigurations in class GeneratedLuceneIndex

Returns:

the languageConfigurations - The LanguageConfiguration objects belonging to this LuceneIndex.

getLanguageConfigurations

public Collection<LanguageConfiguration> getLanguageConfigurations(SessionContext ctx)

Description copied from class: GeneratedLuceneIndex

Generated method - Getter of the LuceneIndex.languageConfigurations attribute.

Specified by:

getLanguageConfigurations in class GeneratedLuceneIndex

Returns:

the languageConfigurations - The LanguageConfiguration objects belonging to this LuceneIndex.

getLanguageConfiguration

public LanguageConfiguration getLanguageConfiguration(Language language)

setLanguageConfigurations

public void setLanguageConfigurations(SessionContext ctx,
                                      Collection<LanguageConfiguration> coll)

Description copied from class: GeneratedLuceneIndex

Generated method - Setter of the LuceneIndex.languageConfigurations attribute.

Specified by:

setLanguageConfigurations in class GeneratedLuceneIndex

coll - the languageConfigurations - The LanguageConfiguration objects belonging to this LuceneIndex.

getPendingUpdatesCount

public Integer getPendingUpdatesCount(SessionContext ctx)

Description copied from class: GeneratedLuceneIndex

Generated method - Getter of the LuceneIndex.pendingUpdatesCount attribute.

Specified by:

getPendingUpdatesCount in class GeneratedLuceneIndex

Returns:

the pendingUpdatesCount - The number of all IndexUpdate objects belonging to this index.

hasAttributes

public boolean hasAttributes()

Checks if the index has at least one configuration containing at least one attribute.

Returns:

true if there is a index configuration with at least one attribute, otherwise false