- java.lang.Object
-
- org.apache.lucene.index.Fields
-
- All Implemented Interfaces:
java.lang.Iterable<java.lang.String>
- Direct Known Subclasses:
FieldsProducer
,FilterLeafReader.FilterFields
,FreqProxFields
,Lucene50CompressingTermVectorsReader.TVFields
,Lucene90CompressingTermVectorsReader.TVFields
,MemoryIndex.MemoryIndexReader.MemoryFields
,MultiFields
,ParallelLeafReader.ParallelFields
,SimpleTextTermVectorsReader.SimpleTVFields
public abstract class Fields extends java.lang.Object implements java.lang.Iterable<java.lang.String>
Provides aTerms
index for fields that have it, and lists which fields do. This is primarily an internal/experimental API (seeFieldsProducer
), although it is also used to expose the set of term vectors per document.
-
-
Field Summary
Fields Modifier and Type Field Description static Fields[]
EMPTY_ARRAY
Zero-lengthFields
array.
-
Constructor Summary
Constructors Modifier Constructor Description protected
Fields()
Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract java.util.Iterator<java.lang.String>
iterator()
Returns an iterator that will step through all fields names.abstract int
size()
Returns the number of fields or -1 if the number of distinct field names is unknown.abstract Terms
terms(java.lang.String field)
Get theTerms
for this field.
-
-
-
Field Detail
-
EMPTY_ARRAY
public static final Fields[] EMPTY_ARRAY
Zero-lengthFields
array.
-
-
Method Detail
-
iterator
public abstract java.util.Iterator<java.lang.String> iterator()
Returns an iterator that will step through all fields names. This will not return null.- Specified by:
iterator
in interfacejava.lang.Iterable<java.lang.String>
-
terms
public abstract Terms terms(java.lang.String field) throws java.io.IOException
Get theTerms
for this field. This will return null if the field does not exist.- Throws:
java.io.IOException
-
size
public abstract int size()
Returns the number of fields or -1 if the number of distinct field names is unknown. If >= 0,iterator()
will return as many field names.
-
-