de.hybris.platform.solrfacetsearch.indexer

Interface IndexerQueryContextFactory<T extends IndexerQueryContext>

All Known Implementing Classes:

DefaultIndexerQueryContextFactory

public interface IndexerQueryContextFactory<T extends IndexerQueryContext>

Implementations of this interface are responsible for creating and destroying instances of IndexerQueryContext.

Code creating/destroying contexts should normally use the following pattern:

 try
 {
        final IndexerQueryContext context = indexerQueryContextFactory.createContext(facetSearchConfig, indexedType, query,
                        queryParameters);
 
        // call additional setters on the context object
 
        indexerQueryContextFactory.initializeContext();
 
        // put your logic here
 
        indexerQueryContextFactory.destroyContext();
 }
 catch (final IndexerException | ... | RuntimeException exception)
 {
        indexerQueryContextFactory.destroyContext(exception);
        throw exception;
 }
 

Method Summary

Modifier and Type	Method and Description
T	createContext(FacetSearchConfig facetSearchConfig, IndexedType indexedType, java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> queryParameters) Creates a new indexer context and sets it as current.
void	destroyContext() Destroys the current context.
void	destroyContext(java.lang.Exception exception) Destroys the current context because an exception occurred.
T	getContext() Returns the current context.
void	initializeContext() Initializes the current context and executes the before index listeners (see IndexerListener.beforeIndex(IndexerContext)).

Method Detail

createContext

T createContext(FacetSearchConfig facetSearchConfig,
                IndexedType indexedType,
                java.lang.String query,
                java.util.Map<java.lang.String,java.lang.Object> queryParameters)
         throws IndexerException

Creates a new indexer context and sets it as current.

Parameters:

facetSearchConfig - - the facet search configuration

indexedType - - the indexed type

query - - the query

queryParameters - - the query parameters

Returns:

the new context

Throws:

IndexerException - if an error occurs during the listeners execution

initializeContext

void initializeContext()
                throws IndexerException

Initializes the current context and executes the before index listeners (see IndexerListener.beforeIndex(IndexerContext)).

Throws:

IndexerException - if an error occurs during the listeners execution

getContext

T getContext()

Returns the current context.

Returns:

the current context

destroyContext

void destroyContext()
             throws IndexerException

Destroys the current context. Before destroying an active context it executes the after query listeners (see IndexerQueryListener.afterQuery(IndexerQueryContext)).

Throws:

IndexerException - if an error occurs during the listeners execution

destroyContext

void destroyContext(java.lang.Exception exception)

Destroys the current context because an exception occurred. Before destroying an active context it executes the after query error listeners (see IndexerQueryListener.afterQueryError(IndexerQueryContext)).