org.apache.lucene.queries.function.valuesource
Class DocValuesFieldSource

java.lang.Object
  extended by org.apache.lucene.queries.function.ValueSource
      extended by org.apache.lucene.queries.function.valuesource.DocValuesFieldSource
Direct Known Subclasses:
DateDocValuesFieldSource, NumericDocValuesFieldSource, StrDocValuesFieldSource

public abstract class DocValuesFieldSource
extends ValueSource

A ValueSource that is based on a field's DocValues.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary
protected  boolean direct
           
protected  String fieldName
           
 
Constructor Summary
protected DocValuesFieldSource(String fieldName, boolean direct)
           
 
Method Summary
 String description()
          description of field, used in explain()
 boolean equals(Object o)
           
 String getFieldName()
           
protected  DocValues.Source getSource(AtomicReader reader, DocValues.Type defaultType)
           
 int hashCode()
           
 boolean isDirect()
           
 
Methods inherited from class org.apache.lucene.queries.function.ValueSource
createWeight, getSortField, getValues, newContext, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

fieldName

protected final String fieldName

direct

protected final boolean direct
Constructor Detail

DocValuesFieldSource

protected DocValuesFieldSource(String fieldName,
                               boolean direct)
Method Detail

getSource

protected final DocValues.Source getSource(AtomicReader reader,
                                           DocValues.Type defaultType)
                                    throws IOException
Throws:
IOException

isDirect

public boolean isDirect()
Returns:
whether or not a direct DocValues.Source is used.

getFieldName

public String getFieldName()
Returns:
the field name

equals

public boolean equals(Object o)
Specified by:
equals in class ValueSource

hashCode

public int hashCode()
Specified by:
hashCode in class ValueSource

description

public String description()
Description copied from class: ValueSource
description of field, used in explain()

Specified by:
description in class ValueSource


Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.