File	Doc	Category	Size	Date	Package
FieldCache.java	API Doc	Apache Lucene 2.2.0	10456	Sat Jun 16 22:20:34 BST 2007	org.apache.lucene.search

FieldCache

Fields Summary
public static final int	STRING_INDEX Indicator for StringIndex values in the cache.
public static FieldCache	DEFAULT Expert: The cache used internally by sorting and range query classes.

Constructors Summary

Methods Summary
public java.lang.Object	getAuto(org.apache.lucene.index.IndexReader reader, java.lang.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. 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. param reader Used to get field values. param field Which field contains the values. return int[], float[] or StringIndex. throws IOException If any error occurs.
public byte[]	getBytes(org.apache.lucene.index.IndexReader reader, java.lang.String field) Checks the internal cache for an appropriate entry, and if none is found, reads the terms in field as a single byte and returns an array of size reader.maxDoc() of the value each document has in the given field. param reader Used to get field values. param field Which field contains the single byte values. return The values in the given field for each document. throws IOException If any error occurs.
public byte[]	getBytes(org.apache.lucene.index.IndexReader reader, java.lang.String field, org.apache.lucene.search.FieldCache$ByteParser parser) Checks the internal cache for an appropriate entry, and if none is found, reads the terms in field as bytes and returns an array of size reader.maxDoc() of the value each document has in the given field. param reader Used to get field values. param field Which field contains the bytes. param parser Computes byte for string values. return The values in the given field for each document. throws IOException If any error occurs.
public java.lang.Comparable[]	getCustom(org.apache.lucene.index.IndexReader reader, java.lang.String field, org.apache.lucene.search.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. A hit in the cache will happen if reader, field, and comparator are the same (using equals()) as a previous call to this method. param reader Used to get field values. param field Which field contains the values. param comparator Used to convert terms into something to sort by. return Array of sort objects, one for each document. throws IOException If any error occurs.
public float[]	getFloats(org.apache.lucene.index.IndexReader reader, java.lang.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. param reader Used to get field values. param field Which field contains the floats. return The values in the given field for each document. throws IOException If any error occurs.
public float[]	getFloats(org.apache.lucene.index.IndexReader reader, java.lang.String field, org.apache.lucene.search.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. param reader Used to get field values. param field Which field contains the floats. param parser Computes float for string values. return The values in the given field for each document. throws IOException If any error occurs.
public int[]	getInts(org.apache.lucene.index.IndexReader reader, java.lang.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. param reader Used to get field values. param field Which field contains the integers. return The values in the given field for each document. throws IOException If any error occurs.
public int[]	getInts(org.apache.lucene.index.IndexReader reader, java.lang.String field, org.apache.lucene.search.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. param reader Used to get field values. param field Which field contains the integers. param parser Computes integer for string values. return The values in the given field for each document. throws IOException If any error occurs.
public short[]	getShorts(org.apache.lucene.index.IndexReader reader, java.lang.String field) Checks the internal cache for an appropriate entry, and if none is found, reads the terms in field as shorts and returns an array of size reader.maxDoc() of the value each document has in the given field. param reader Used to get field values. param field Which field contains the shorts. return The values in the given field for each document. throws IOException If any error occurs.
public short[]	getShorts(org.apache.lucene.index.IndexReader reader, java.lang.String field, org.apache.lucene.search.FieldCache$ShortParser parser) Checks the internal cache for an appropriate entry, and if none is found, reads the terms in field as shorts and returns an array of size reader.maxDoc() of the value each document has in the given field. param reader Used to get field values. param field Which field contains the shorts. param parser Computes short for string values. return The values in the given field for each document. throws IOException If any error occurs.
public org.apache.lucene.search.FieldCache$StringIndex	getStringIndex(org.apache.lucene.index.IndexReader reader, java.lang.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. param reader Used to get field values. param field Which field contains the strings. return Array of terms and index into the array for each document. throws IOException If any error occurs.
public java.lang.String[]	getStrings(org.apache.lucene.index.IndexReader reader, java.lang.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. param reader Used to get field values. param field Which field contains the strings. return The values in the given field for each document. throws IOException If any error occurs.