de.hybris.platform.lucenesearch.jalo

Interface PostQueryFilter

All Known Implementing Classes:

DefaultPostQueryFilter, HMCPostQueryFilter, PassThroughQueryFilter, TestPostQueryFilter

public interface PostQueryFilter

Implementations of this class handle the lucenesearch's post-query filtering. Post-query filtering may be necessary because checks are to complex to be implemented in the query defined by the IndexedDataFactory, or because the checks are context-dependent.

The implementation class can be configured for each IndexConfiguration by calling GeneratedLuceneIndex.setPostQueryFilterClassName(String). No PostQueryFilter is set by default.

Implementations must provide a public no-arg constructor.

For each check (=call to filterItems), a new object of the implementation is instantiated. Implementations may rely on this, for example by using instance fields in a non-thread-safe manner.

Performance Warning: If a PostQueryFilter is installed, any search has to instantiate and access all found items (not only those in the requested search range). This may seriously affect search performance.

Method Summary

Modifier and Type	Method and Description
void	filterItems(SessionContext ctx, LuceneIndex index, Item[] items) Check whether the given items are visible.

Method Detail

filterItems

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

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.

Parameters:

index - the index which the result items belong to

items - all items found be a search