org.apache.lucene.document

Class LazyDocument.LazyField

java.lang.Object

org.apache.lucene.document.LazyDocument.LazyField

All Implemented Interfaces:

IndexableField

Enclosing class:

LazyDocument

public class LazyDocument.LazyField
extends Object
implements IndexableField

Method Summary

Modifier and Type	Method and Description
BytesRef	binaryValue() Non-null if this field has a binary value
float	boost() Returns the field's index-time boost.
IndexableFieldType	fieldType() IndexableFieldType describing the properties of this field.
boolean	hasBeenLoaded() non-private for test only access
String	name() Field name
Number	numericValue() Non-null if this field has a numeric value
Reader	readerValue() Non-null if this field has a Reader value
String	stringValue() Non-null if this field has a string value
TokenStream	tokenStream(Analyzer analyzer) Creates the TokenStream used for indexing this field.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

hasBeenLoaded

public boolean hasBeenLoaded()

non-private for test only access

name

public String name()

Description copied from interface: IndexableField

Field name

Specified by:

name in interface IndexableField

boost

public float boost()

Description copied from interface: IndexableField

Returns the field's index-time boost.

Only fields can have an index-time boost, if you want to simulate a "document boost", then you must pre-multiply it across all the relevant fields yourself.

The boost is used to compute the norm factor for the field. By default, in the Similarity.computeNorm(FieldInvertState) method, the boost value is multiplied by the length normalization factor and then rounded by DefaultSimilarity.encodeNormValue(float) before it is stored in the index. One should attempt to ensure that this product does not overflow the range of that encoding.

It is illegal to return a boost other than 1.0f for a field that is not indexed (IndexableFieldType.indexed() is false) or omits normalization values (IndexableFieldType.omitNorms() returns true).

Specified by:

boost in interface IndexableField

See Also:

Similarity.computeNorm(FieldInvertState), DefaultSimilarity.encodeNormValue(float)

binaryValue

public BytesRef binaryValue()

Description copied from interface: IndexableField

Non-null if this field has a binary value

Specified by:

binaryValue in interface IndexableField

stringValue

public String stringValue()

Description copied from interface: IndexableField

Non-null if this field has a string value

Specified by:

stringValue in interface IndexableField

readerValue

public Reader readerValue()

Description copied from interface: IndexableField

Non-null if this field has a Reader value

Specified by:

readerValue in interface IndexableField

numericValue

public Number numericValue()

Description copied from interface: IndexableField

Non-null if this field has a numeric value

Specified by:

numericValue in interface IndexableField

fieldType

public IndexableFieldType fieldType()

Description copied from interface: IndexableField

IndexableFieldType describing the properties of this field.

Specified by:

fieldType in interface IndexableField

tokenStream

public TokenStream tokenStream(Analyzer analyzer)
                        throws IOException

Description copied from interface: IndexableField

Creates the TokenStream used for indexing this field. If appropriate, implementations should use the given Analyzer to create the TokenStreams.

Specified by:

tokenStream in interface IndexableField

Parameters:

analyzer - Analyzer that should be used to create the TokenStreams from

Returns:

TokenStream value for indexing the document. Should always return a non-null value if the field is to be indexed

Throws:

IOException - Can be thrown while creating the TokenStream