/*
 * 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.queries.function.docvalues;

import java.io.IOException;

import org.apache.lucene.index.LeafReaderContext;
import org.apache.lucene.queries.function.FunctionValues;
import org.apache.lucene.queries.function.ValueSource;
import org.apache.lucene.queries.function.ValueSourceScorer;
import org.apache.lucene.search.Weight;
import org.apache.lucene.util.mutable.MutableValue;
import org.apache.lucene.util.mutable.MutableValueLong;

Abstract FunctionValues implementation which supports retrieving long values. Implementations can control how the long values are loaded through longVal(int)}
/** * Abstract {@link FunctionValues} implementation which supports retrieving long values. * Implementations can control how the long values are loaded through {@link #longVal(int)}} */
public abstract class LongDocValues extends FunctionValues { protected final ValueSource vs; public LongDocValues(ValueSource vs) { this.vs = vs; } @Override public byte byteVal(int doc) throws IOException { return (byte)longVal(doc); } @Override public short shortVal(int doc) throws IOException { return (short)longVal(doc); } @Override public float floatVal(int doc) throws IOException { return (float)longVal(doc); } @Override public int intVal(int doc) throws IOException { return (int)longVal(doc); } @Override public abstract long longVal(int doc) throws IOException; @Override public double doubleVal(int doc) throws IOException { return (double)longVal(doc); } @Override public boolean boolVal(int doc) throws IOException { return longVal(doc) != 0; } @Override public String strVal(int doc) throws IOException { return Long.toString(longVal(doc)); } @Override public Object objectVal(int doc) throws IOException { return exists(doc) ? longVal(doc) : null; } @Override public String toString(int doc) throws IOException { return vs.description() + '=' + strVal(doc); } protected long externalToLong(String extVal) { return Long.parseLong(extVal); } @Override public ValueSourceScorer getRangeScorer(Weight weight, LeafReaderContext readerContext, String lowerVal, String upperVal, boolean includeLower, boolean includeUpper) { long lower,upper; // instead of using separate comparison functions, adjust the endpoints. if (lowerVal==null) { lower = Long.MIN_VALUE; } else { lower = externalToLong(lowerVal); if (!includeLower && lower < Long.MAX_VALUE) lower++; } if (upperVal==null) { upper = Long.MAX_VALUE; } else { upper = externalToLong(upperVal); if (!includeUpper && upper > Long.MIN_VALUE) upper--; } final long ll = lower; final long uu = upper; return new ValueSourceScorer(weight, readerContext, this) { @Override public boolean matches(int doc) throws IOException { if (!exists(doc)) return false; long val = longVal(doc); return val >= ll && val <= uu; } }; } @Override public ValueFiller getValueFiller() { return new ValueFiller() { private final MutableValueLong mval = new MutableValueLong(); @Override public MutableValue getValue() { return mval; } @Override public void fillValue(int doc) throws IOException { mval.value = longVal(doc); mval.exists = exists(doc); } }; } }