org.elasticsearch.index.field.data
Class FieldData<Doc extends DocFieldData>

java.lang.Object
  extended by org.elasticsearch.index.field.data.FieldData<Doc>
Direct Known Subclasses:
GeoPointFieldData, NumericFieldData, StringFieldData

public abstract class FieldData<Doc extends DocFieldData>
extends java.lang.Object


Nested Class Summary
static interface FieldData.StringValueInDocProc
           
static interface FieldData.StringValueProc
           
 
Constructor Summary
protected FieldData(java.lang.String fieldName)
           
 
Method Summary
protected abstract  Doc createFieldData()
           
 Doc docFieldData(int docId)
           
 java.lang.String fieldName()
          The field name of this field data.
abstract  void forEachValue(FieldData.StringValueProc proc)
           
abstract  void forEachValueInDoc(int docId, FieldData.StringValueInDocProc proc)
           
abstract  boolean hasValue(int docId)
          Is there a value associated with this document id.
static FieldData load(FieldDataType type, org.apache.lucene.index.IndexReader reader, java.lang.String fieldName)
           
abstract  boolean multiValued()
          Is the field data a multi valued one (has multiple values / terms per document id) or not.
abstract  java.lang.String stringValue(int docId)
           
abstract  FieldDataType type()
          The type of this field data.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FieldData

protected FieldData(java.lang.String fieldName)
Method Detail

fieldName

public final java.lang.String fieldName()
The field name of this field data.


docFieldData

public Doc docFieldData(int docId)

createFieldData

protected abstract Doc createFieldData()

multiValued

public abstract boolean multiValued()
Is the field data a multi valued one (has multiple values / terms per document id) or not.


hasValue

public abstract boolean hasValue(int docId)
Is there a value associated with this document id.


stringValue

public abstract java.lang.String stringValue(int docId)

forEachValue

public abstract void forEachValue(FieldData.StringValueProc proc)

forEachValueInDoc

public abstract void forEachValueInDoc(int docId,
                                       FieldData.StringValueInDocProc proc)

type

public abstract FieldDataType type()
The type of this field data.


load

public static FieldData load(FieldDataType type,
                             org.apache.lucene.index.IndexReader reader,
                             java.lang.String fieldName)
                      throws java.io.IOException
Throws:
java.io.IOException