Lucene example source code file (ParametricQueryNode.java)

This example Lucene source code file (ParametricQueryNode.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Lucene tags/keywords

charsequence, clonenotsupportedexception, compareoperator, compareoperator, eq, fieldquerynode, gt, le, override, override, parametricquerynode, parametricquerynode, string, string

The Lucene ParametricQueryNode.java source code

package org.apache.lucene.queryParser.core.nodes;

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import org.apache.lucene.queryParser.core.parser.EscapeQuerySyntax;

/**
 * A {@link ParametricQueryNode} represents LE, LT, GE, GT, EQ, NE query.
 * Example: date >= "2009-10-10" OR price = 200
 */
public class ParametricQueryNode extends FieldQueryNode {

  private static final long serialVersionUID = -5770038129741218116L;

  private CompareOperator operator;

  public enum CompareOperator {
    LE { 
      @Override
      public String toString() { return "<="; }
    },
    LT {
      @Override
      public String toString() { return "<";  }
    },
    GE {
      @Override
      public String toString() { return ">="; }
    },
    GT {
      @Override
      public String toString() { return ">";  }
    },
    EQ {
      @Override
      public String toString() { return "=";  }
    },
    NE {
      @Override
      public String toString() { return "!="; }
    };
  }

  /**
   * @param field
   *          - field name
   * @param comp
   *          - CompareOperator
   * @param value
   *          - text value
   * @param begin
   *          - position in the query string
   * @param end
   *          - position in the query string
   */
  public ParametricQueryNode(CharSequence field, CompareOperator comp,
      CharSequence value, int begin, int end) {
    super(field, value, begin, end);
    this.operator = comp;
    setLeaf(true);
  }

  public CharSequence getOperand() {
    return getText();
  }

  @Override
  public CharSequence toQueryString(EscapeQuerySyntax escapeSyntaxParser) {
    return this.field + "" + this.operator.toString() + "\"" + this.text + "\"";
  }

  @Override
  public String toString() {
    return "<parametric field='" + this.field + "' operator='"
        + this.operator.toString() + "' text='" + this.text + "'/>";
  }

  @Override
  public ParametricQueryNode cloneTree() throws CloneNotSupportedException {
    ParametricQueryNode clone = (ParametricQueryNode) super.cloneTree();

    clone.operator = this.operator;

    return clone;
  }

  /**
   * @return the operator
   */
  public CompareOperator getOperator() {
    return this.operator;
  }
}