lucene-java-3.5.0/lucene/contrib/queryparser/src/java/org/apache/lucene/queryParser/core/processors/package.html

   1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
   2 <!--
   3  Licensed to the Apache Software Foundation (ASF) under one or more
   4  contributor license agreements.  See the NOTICE file distributed with
   5  this work for additional information regarding copyright ownership.
   6  The ASF licenses this file to You under the Apache License, Version 2.0
   7  (the "License"); you may not use this file except in compliance with
   8  the License.  You may obtain a copy of the License at
   9
  10      http://www.apache.org/licenses/LICENSE-2.0
  11
  12  Unless required by applicable law or agreed to in writing, software
  13  distributed under the License is distributed on an "AS IS" BASIS,
  14  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  See the License for the specific language governing permissions and
  16  limitations under the License.
  17 -->
  18 <html>
  19 <head>
  20    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  21 </head>
  22 <body>
  23
  24 Interfaces and implementations used by query node processors
  25
  26 <h2>Query Node Processors</h2>
  27 <p>
  28 The package <tt>org.apache.lucene.queryParser.processors</tt> contains interfaces
  29 that should be implemented by every query node processor.
  30 </p>
  31 <p>
  32 The interface that every query node processor should implement is {@link org.apache.lucene.queryParser.core.processors.QueryNodeProcessor}.
  33 </p>
  34 <p>
  35 A query node processor should be used to process a {@link org.apache.lucene.queryParser.core.nodes.QueryNode} tree.
  36 {@link org.apache.lucene.queryParser.core.nodes.QueryNode} trees can be programmatically created or generated by a
  37 text parser. See {@link org.apache.lucene.queryParser.core.parser} for more details about text parsers.
  38 </p>
  39
  40 <p>
  41 A query node processor should be used to process a {@link org.apache.lucene.queryParser.core.nodes.QueryNode} tree.
  42 {@link org.apache.lucene.queryParser.core.nodes.QueryNode} trees can be programmatically created or generated by a
  43 text parser. See {@link org.apache.lucene.queryParser.core.parser} for more details about text parsers.
  44 </p>
  45
  46 <p>
  47 A pipeline of processors can be assembled using {@link org.apache.lucene.queryParser.core.processors.QueryNodeProcessorPipeline}.
  48 </p>
  49
  50 <p>
  51 Implementors may want to extend {@link org.apache.lucene.queryParser.core.processors.QueryNodeProcessorImpl}, which simplifies
  52 the implementation, because it walks automatically the {@link org.apache.lucene.queryParser.core.nodes.QueryNode}. See
  53 {@link org.apache.lucene.queryParser.core.processors.QueryNodeProcessorImpl} for more details.
  54 </p>
  55
  56 </body>
  57 </html>