org.apache.lucene.queryparser.xml.builders.LegacyNumericRangeQueryBuilder Maven / Gradle / Ivy

Go to download
/*
 * 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.
 */
package org.apache.lucene.queryparser.xml.builders;

import org.apache.lucene.search.LegacyNumericRangeQuery;
import org.apache.lucene.search.Query;
import org.apache.lucene.util.LegacyNumericUtils;
import org.apache.lucene.queryparser.xml.DOMUtils;
import org.apache.lucene.queryparser.xml.ParserException;
import org.apache.lucene.queryparser.xml.QueryBuilder;
import org.w3c.dom.Element;

/**
 * Creates a {@link org.apache.lucene.search.LegacyNumericRangeQuery}. The table below specifies the required
 * attributes and the defaults if optional attributes are omitted. For more
 * detail on what each of the attributes actually do, consult the documentation
 * for {@link org.apache.lucene.search.LegacyNumericRangeQuery}:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Attribute name Values Required Default
fieldName String Yes N/A
lowerTerm Specified by type No Null
upperTerm Specified by type No Null
type int, long, float, double No int
includeLower true, false No true
includeUpper true, false No true
precisionStep Integer No 4
 * 
 * A {@link ParserException} will be thrown if an error occurs parsing the
 * supplied lowerTerm or upperTerm into the numeric type
 * specified by type.
 * @deprecated Index with points and use {@link PointRangeQueryBuilder} instead 
 */
@Deprecated
public class LegacyNumericRangeQueryBuilder implements QueryBuilder {

  @Override
  public Query getQuery(Element e) throws ParserException {
    String field = DOMUtils.getAttributeWithInheritanceOrFail(e, "fieldName");
    final String lowerTerm = DOMUtils.getAttribute(e, "lowerTerm", null);
    final String upperTerm = DOMUtils.getAttribute(e, "upperTerm", null);
    boolean lowerInclusive = DOMUtils.getAttribute(e, "includeLower", true);
    boolean upperInclusive = DOMUtils.getAttribute(e, "includeUpper", true);
    int precisionStep = DOMUtils.getAttribute(e, "precisionStep", LegacyNumericUtils.PRECISION_STEP_DEFAULT);

    String type = DOMUtils.getAttribute(e, "type", "int");
    try {
      Query filter;
      if (type.equalsIgnoreCase("int")) {
        filter = LegacyNumericRangeQuery.newIntRange(field, precisionStep,
            (lowerTerm == null ? null : Integer.valueOf(lowerTerm)),
            (upperTerm == null ? null : Integer.valueOf(upperTerm)),
            lowerInclusive,
            upperInclusive);
      } else if (type.equalsIgnoreCase("long")) {
        filter = LegacyNumericRangeQuery.newLongRange(field, precisionStep,
            (lowerTerm == null ? null : Long.valueOf(lowerTerm)),
            (upperTerm == null ? null : Long.valueOf(upperTerm)),
            lowerInclusive,
            upperInclusive);
      } else if (type.equalsIgnoreCase("double")) {
        filter = LegacyNumericRangeQuery.newDoubleRange(field, precisionStep,
            (lowerTerm == null ? null : Double.valueOf(lowerTerm)),
            (upperTerm == null ? null : Double.valueOf(upperTerm)),
            lowerInclusive,
            upperInclusive);
      } else if (type.equalsIgnoreCase("float")) {
        filter = LegacyNumericRangeQuery.newFloatRange(field, precisionStep,
            (lowerTerm == null ? null : Float.valueOf(lowerTerm)),
            (upperTerm == null ? null : Float.valueOf(upperTerm)),
            lowerInclusive,
            upperInclusive);
      } else {
        throw new ParserException("type attribute must be one of: [long, int, double, float]");
      }
      return filter;
    } catch (NumberFormatException nfe) {
      throw new ParserException("Could not parse lowerTerm or upperTerm into a number", nfe);
    }
  }
}
Attribute name	Values	Required	Default
fieldName	String	Yes	N/A
lowerTerm	Specified by `type`	No	Null
upperTerm	Specified by `type`	No	Null
type	int, long, float, double	No	int
includeLower	true, false	No	true
includeUpper	true, false	No	true
precisionStep	Integer	No	4