de.hybris.platform.lucenesearch.jalo

Class DefaultPostQueryFilter

java.lang.Object

de.hybris.platform.lucenesearch.jalo.DefaultPostQueryFilter

All Implemented Interfaces:

PostQueryFilter

Direct Known Subclasses:

HMCPostQueryFilter

public class DefaultPostQueryFilter
extends Object
implements PostQueryFilter

A default implementation of the interface PostQueryFilter
This Filter gets a list with items which are sorted out in the lucene search if this filter is used.

Constructor Summary

Constructors

Constructor and Description
DefaultPostQueryFilter()

Method Summary

Modifier and Type	Method and Description
void	filterItems(SessionContext ctx, LuceneIndex idx, Item[] items) Check whether the given items are visible.
protected Collection<IndexConfiguration>	findRestrictedIndexConfigurations(FlexibleSearch flexibleSearch, SessionContext ctx, LuceneIndex index) Checks the specified index whether or not there are active search restrictions for it within the current session context.
protected Map<IndexConfiguration,BitSet>	groupItemsByIndexedType(SessionContext ctx, Collection<IndexConfiguration> indexedTypes, Item[] items) Groups all given items by their types resp.
protected boolean	isTypeVisible(SessionContext ctx, ComposedType type) Additional hook for filtering invisible indexed types.
protected void	processInvisibleTypes(SessionContext ctx, LuceneIndex idx, Item[] items) Clears all items which belong to invisible types.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPostQueryFilter

public DefaultPostQueryFilter()

Method Detail

filterItems

public void filterItems(SessionContext ctx,
                        LuceneIndex idx,
                        Item[] items)

Description copied from interface: PostQueryFilter

Check whether the given items are visible. Items that are not visible should be removed from the array (i.e., overwritten with null). Visibility may depend on the given SessionContext and the current JaloSession.

Specified by:

filterItems in interface PostQueryFilter

idx - the index which the result items belong to

items - all items found be a search

findRestrictedIndexConfigurations

protected Collection<IndexConfiguration> findRestrictedIndexConfigurations(FlexibleSearch flexibleSearch,
                                                                           SessionContext ctx,
                                                                           LuceneIndex index)

Checks the specified index whether or not there are active search restrictions for it within the current session context.

Parameters:

flexibleSearch - the flexible search manager

ctx - the current session context

index - index to check

Returns:

configuration which have restrictions

groupItemsByIndexedType

protected Map<IndexConfiguration,BitSet> groupItemsByIndexedType(SessionContext ctx,
                                                                 Collection<IndexConfiguration> indexedTypes,
                                                                 Item[] items)

Groups all given items by their types resp. supertypes. This avoids searching on types without any possible item belonging to them.

Returns a map { ComposedType -> [ item PK string + ] }.

Parameters:

indexedTypes - all indexed types

items - all possible items

Since:

2.10

processInvisibleTypes

protected void processInvisibleTypes(SessionContext ctx,
                                     LuceneIndex idx,
                                     Item[] items)

Clears all items which belong to invisible types.

Parameters:

ctx - the enclosing session context

idx - the lucene search index

items - the items to filter

See Also:

isTypeVisible(SessionContext, ComposedType)

isTypeVisible

protected boolean isTypeVisible(SessionContext ctx,
                                ComposedType type)

Additional hook for filtering invisible indexed types. This is much faster because all items of these types are cleared without doing any database lookup.

Parameters:

type -

Returns:

true if the type is visible or false if not