org.apache.lucene.document
Class Field

java.lang.Object
  |
  +--org.apache.lucene.document.Field

public final class Field

extends Object

A field is a section of a Document. Each field has two parts, a name and a value. Values may be free text, provided as a String or as a Reader, or they may be atomic keywords, which are not further processed. Such keywords may be used to represent dates, urls, etc. Fields are optionally stored in the index, so that they may be returned with hits on the document.

Constructor Summary

Field(String name, String string, boolean store, boolean index, boolean token)

Method Summary

boolean	isIndexed() True iff the value of the field is to be indexed, so that it may be searched on.
boolean	isStored() True iff the value of the field is to be stored in the index for return with search hits.
boolean	isTokenized() True iff the value of the field should be tokenized as text prior to indexing.
static Field	Keyword(String name, String value) Constructs a String-valued Field that is not tokenized, but is indexed and stored.
String	name() The name of the field (e.g., "date", "subject", "title", "body", etc.) as an interned string.
Reader	readerValue() The value of the field as a Reader, or null.
String	stringValue() The value of the field as a String, or null.
static Field	Text(String name, Reader value) Constructs a Reader-valued Field that is tokenized and indexed, but is not stored in the index verbatim.
static Field	Text(String name, String value) Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits.
String	toString() Prints a Field for human consumption.
static Field	UnIndexed(String name, String value) Constructs a String-valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.
static Field	UnStored(String name, String value) Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Field

public Field(String name,
             String string,
             boolean store,
             boolean index,
             boolean token)

Method Detail

Keyword

public static final Field Keyword(String name,
                                  String value)

Constructs a String-valued Field that is not tokenized, but is indexed and stored. Useful for non-text fields, e.g. date or url.

UnIndexed

public static final Field UnIndexed(String name,
                                    String value)

Constructs a String-valued Field that is not tokenized nor indexed, but is stored in the index, for return with hits.

Text

public static final Field Text(String name,
                               String value)

Constructs a String-valued Field that is tokenized and indexed, and is stored in the index, for return with hits. Useful for short text fields, like "title" or "subject".

UnStored

public static final Field UnStored(String name,
                                   String value)

Constructs a String-valued Field that is tokenized and indexed, but that is not stored in the index.

Text

public static final Field Text(String name,
                               Reader value)

Constructs a Reader-valued Field that is tokenized and indexed, but is not stored in the index verbatim. Useful for longer text fields, like "body".

name

public String name()

The name of the field (e.g., "date", "subject", "title", "body", etc.) as an interned string.

stringValue

public String stringValue()

The value of the field as a String, or null. If null, the Reader value is used. Exactly one of stringValue() and readerValue() must be set.

readerValue

public Reader readerValue()

The value of the field as a Reader, or null. If null, the String value is used. Exactly one of stringValue() and readerValue() must be set.

isStored

public final boolean isStored()

True iff the value of the field is to be stored in the index for return with search hits. It is an error for this to be true if a field is Reader-valued.

isIndexed

public final boolean isIndexed()

True iff the value of the field is to be indexed, so that it may be searched on.

isTokenized

public final boolean isTokenized()

True iff the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are indexed as a single word and may not be Reader-valued.

toString

public final String toString()

Prints a Field for human consumption.

Overrides:

toString in class Object