org.apache.lucene.search
Interface FieldCache
public interface FieldCache
Expert: Maintains caches of term values.
Created: May 19, 2004 11:13:14 AM
$Id: FieldCache.java 179605 2005-06-02 16:48:40Z cutting $- Tim Jones (Nacimiento Software)
static FieldCache | DEFAULT - Expert: The cache used internally by sorting and range query classes.
|
static int | STRING_INDEX - Indicator for StringIndex values in the cache.
|
Object | getAuto(IndexReader reader, String field) - Checks the internal cache for an appropriate entry, and if
none is found reads
field to see if it contains integers, floats
or strings, and then calls one of the other methods in this class to get the
values.
|
Comparable[] | getCustom(IndexReader reader, String field, SortComparator comparator) - Checks the internal cache for an appropriate entry, and if none
is found reads the terms out of
field and calls the given SortComparator
to get the sort values.
|
float[] | getFloats(IndexReader reader, String field) - Checks the internal cache for an appropriate entry, and if
none is found, reads the terms in
field as floats and returns an array
of size reader.maxDoc() of the value each document
has in the given field.
|
float[] | getFloats(IndexReader reader, String field, FieldCache.FloatParser parser) - Checks the internal cache for an appropriate entry, and if
none is found, reads the terms in
field as floats and returns an array
of size reader.maxDoc() of the value each document
has in the given field.
|
int[] | getInts(IndexReader reader, String field) - Checks the internal cache for an appropriate entry, and if none is
found, reads the terms in
field as integers and returns an array
of size reader.maxDoc() of the value each document
has in the given field.
|
int[] | getInts(IndexReader reader, String field, FieldCache.IntParser parser) - Checks the internal cache for an appropriate entry, and if none is found,
reads the terms in
field as integers and returns an array of
size reader.maxDoc() of the value each document has in the
given field.
|
FieldCache.StringIndex | getStringIndex(IndexReader reader, String field) - Checks the internal cache for an appropriate entry, and if none
is found reads the term values in
field and returns
an array of them in natural order, along with an array telling
which element in the term array each document uses.
|
String[] | getStrings(IndexReader reader, String field) - Checks the internal cache for an appropriate entry, and if none
is found, reads the term values in
field and returns an array
of size reader.maxDoc() containing the value each document
has in the given field.
|
DEFAULT
public static final FieldCache DEFAULT
Expert: The cache used internally by sorting and range query classes.
STRING_INDEX
public static final int STRING_INDEX
Indicator for StringIndex values in the cache.
getAuto
public Object getAuto(IndexReader reader,
String field)
throws IOException
Checks the internal cache for an appropriate entry, and if
none is found reads field
to see if it contains integers, floats
or strings, and then calls one of the other methods in this class to get the
values. For string values, a StringIndex is returned. After
calling this method, there is an entry in the cache for both
type AUTO
and the actual found type.
reader
- Used to get field values.field
- Which field contains the values.
- int[], float[] or StringIndex.
getCustom
public Comparable[] getCustom(IndexReader reader,
String field,
SortComparator comparator)
throws IOException
Checks the internal cache for an appropriate entry, and if none
is found reads the terms out of field
and calls the given SortComparator
to get the sort values. A hit in the cache will happen if reader
,
field
, and comparator
are the same (using equals()
)
as a previous call to this method.
reader
- Used to get field values.field
- Which field contains the values.comparator
- Used to convert terms into something to sort by.
- Array of sort objects, one for each document.
getFloats
public float[] getFloats(IndexReader reader,
String field)
throws IOException
Checks the internal cache for an appropriate entry, and if
none is found, reads the terms in field
as floats and returns an array
of size reader.maxDoc()
of the value each document
has in the given field.
reader
- Used to get field values.field
- Which field contains the floats.
- The values in the given field for each document.
getFloats
public float[] getFloats(IndexReader reader,
String field,
FieldCache.FloatParser parser)
throws IOException
Checks the internal cache for an appropriate entry, and if
none is found, reads the terms in field
as floats and returns an array
of size reader.maxDoc()
of the value each document
has in the given field.
reader
- Used to get field values.field
- Which field contains the floats.parser
- Computes float for string values.
- The values in the given field for each document.
getInts
public int[] getInts(IndexReader reader,
String field)
throws IOException
Checks the internal cache for an appropriate entry, and if none is
found, reads the terms in field
as integers and returns an array
of size reader.maxDoc()
of the value each document
has in the given field.
reader
- Used to get field values.field
- Which field contains the integers.
- The values in the given field for each document.
getInts
public int[] getInts(IndexReader reader,
String field,
FieldCache.IntParser parser)
throws IOException
Checks the internal cache for an appropriate entry, and if none is found,
reads the terms in field
as integers and returns an array of
size reader.maxDoc()
of the value each document has in the
given field.
reader
- Used to get field values.field
- Which field contains the integers.parser
- Computes integer for string values.
- The values in the given field for each document.
getStringIndex
public FieldCache.StringIndex getStringIndex(IndexReader reader,
String field)
throws IOException
Checks the internal cache for an appropriate entry, and if none
is found reads the term values in field
and returns
an array of them in natural order, along with an array telling
which element in the term array each document uses.
reader
- Used to get field values.field
- Which field contains the strings.
- Array of terms and index into the array for each document.
getStrings
public String[] getStrings(IndexReader reader,
String field)
throws IOException
Checks the internal cache for an appropriate entry, and if none
is found, reads the term values in field
and returns an array
of size reader.maxDoc()
containing the value each document
has in the given field.
reader
- Used to get field values.field
- Which field contains the strings.
- The values in the given field for each document.
Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.