QueryNodeProcessor (Lucene 3.6.2 API)
Keywords: org.apache.lucene.queryParser.core.processors.QueryNodeProcessor interface

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.lucene.queryParser.core.processors
Interface QueryNodeProcessor

All Known Implementing Classes:
  AllowLeadingWildcardProcessor, AnalyzerQueryNodeProcessor, BooleanModifiersQueryNodeProcessor, BooleanQuery2ModifierNodeProcessor, BooleanSingleChildOptimizationQueryNodeProcessor, BoostQueryNodeProcessor, DefaultPhraseSlopQueryNodeProcessor, FuzzyQueryNodeProcessor, GroupQueryNodeProcessor, LowercaseExpandedTermsQueryNodeProcessor, MatchAllDocsQueryNodeProcessor, MultiFieldQueryNodeProcessor, MultiTermRewriteMethodProcessor, NoChildOptimizationQueryNodeProcessor, NumericQueryNodeProcessor, NumericRangeQueryNodeProcessor, ParametricRangeQueryNodeProcessor, PhraseSlopQueryNodeProcessor, PrecedenceQueryNodeProcessorPipeline, QueryNodeProcessorImpl, QueryNodeProcessorPipeline, RemoveDeletedQueryNodesProcessor, RemoveEmptyNonLeafQueryNodeProcessor, StandardQueryNodeProcessorPipeline, WildcardQueryNodeProcessor

    public interface QueryNodeProcessor

A `QueryNodeProcessor` is an interface for classes that process a `QueryNode` tree.

The implementor of this class should perform some operation on a query node tree and return the same or another query node tree.

It also may carry a `QueryConfigHandler` object that contains configuration about the query represented by the query tree or the collection/index where it's intended to be executed.

In case there is any `QueryConfigHandler` associated to the query tree to be processed, it should be set using `setQueryConfigHandler(QueryConfigHandler)` before `process(QueryNode)` is invoked.

See Also:
  `QueryNode`, `QueryNodeProcessor`, `QueryConfigHandler`

Method Summary
`QueryConfigHandler` | `getQueryConfigHandler()` Returns the `QueryConfigHandler` associated to the query tree if any, otherwise it returns `null`
`QueryNode` | `process(QueryNode queryTree)` Processes a query node tree.
`void` | `setQueryConfigHandler(QueryConfigHandler queryConfigHandler)` Sets the `QueryConfigHandler` associated to the query tree.

Method Detail

### process

    QueryNode process(QueryNode queryTree)
                      throws QueryNodeException

  Processes a query node tree. It may return the same or another query tree. I should never return `null`.

  Parameters:
    `queryTree` - tree root node
  Returns:
    the processed query tree
  Throws:
    `QueryNodeException`

### setQueryConfigHandler

    void setQueryConfigHandler(QueryConfigHandler queryConfigHandler)

  Sets the `QueryConfigHandler` associated to the query tree.

  Parameters:
    `queryConfigHandler` -

### getQueryConfigHandler

    QueryConfigHandler getQueryConfigHandler()

  Returns the `QueryConfigHandler` associated to the query tree if any, otherwise it returns `null`

  Returns:
    the `QueryConfigHandler` associated to the query tree if any, otherwise it returns `null`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD