Inherits Lucene.Net.Documents.IFieldable.

Inherited by Lucene.Net.Documents.Field, Lucene.Net.Documents.NumericField, and Lucene.Net.Index.FieldsReader.LazyField.

Public Member Functions
virtual byte[]	GetBinaryValue ()
	Return the raw byte[] for the binary field. Note that you must also call BinaryLength and BinaryOffset to know which range of bytes in this returned array belong to the field.

virtual byte[]	GetBinaryValue (byte[] result)
	Return the raw byte[] for the binary field. Note that you must also call BinaryLength and BinaryOffset to know which range of bytes in this returned array belong to the field.About reuse: if you pass in the result byte[] and it is used, likely the underlying implementation will hold onto this byte[] and return it in future calls to GetBinaryValue() or GetBinaryValue(). So if you subsequently re-use the same byte[] elsewhere it will alter this Fieldable's value.

override System.String	ToString ()
	Prints a Field for human consumption.

Properties
virtual float	Boost `[get, set]`
	Gets or sets the boost factor for hits for this field.

virtual string	Name `[get]`
	Returns the name of the field as an interned string. For example "date", "title", "body", ...

bool	IsStored `[get]`
	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.

bool	IsIndexed `[get]`
	True iff the value of the field is to be indexed, so that it may be searched on.

bool	IsTokenized `[get]`
	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.

bool	IsTermVectorStored `[get]`
	True iff the term or terms used to index this field are stored as a term vector, available from Lucene.Net.Index.IndexReader.GetTermFreqVector(int,String). These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the `stored` attribute instead.

virtual bool	IsStoreOffsetWithTermVector `[get]`
	True iff terms are stored as term vector together with their offsets (start and end position in source text).

virtual bool	IsStorePositionWithTermVector `[get]`
	True iff terms are stored as term vector together with their token positions.

bool	IsBinary `[get]`
	True iff the value of the filed is stored as binary

virtual int	BinaryLength `[get]`
	Returns length of byte[] segment that is used as value, if Field is not binary returned value is undefined

virtual int	BinaryOffset `[get]`
	Returns offset into byte[] segment that is used as value, if Field is not binary returned value is undefined

virtual bool	OmitNorms `[get, set]`
	True if norms are omitted for this indexed field

virtual bool	OmitTermFreqAndPositions `[get, set]`
	Expert:

virtual bool	IsLazy `[get]`

abstract TokenStream	TokenStreamValue `[get]`

abstract TextReader	ReaderValue `[get]`

abstract string	StringValue `[get]`

Properties inherited from Lucene.Net.Documents.IFieldable
float	Boost `[get, set]`
	Gets or sets the boost factor for hits for this field. This value will be multiplied into the score of all hits on this this field of this document.

string	Name `[get]`
	Returns the name of the field as an interned string. For example "date", "title", "body", ...

string	StringValue `[get]`
	The value of the field as a String, or null. For indexing, if isStored()==true, the stringValue() will be used as the stored field value unless isBinary()==true, in which case GetBinaryValue() will be used.

TextReader	ReaderValue `[get]`
	The value of the field as a Reader, which can be used at index time to generate indexed tokens.

TokenStream	TokenStreamValue `[get]`
	The TokenStream for this field to be used when indexing, or null.

bool	IsStored `[get]`
	True if the value of the field is to be stored in the index for return with search hits.

bool	IsIndexed `[get]`
	True if the value of the field is to be indexed, so that it may be searched on.

bool	IsTokenized `[get]`
	True if 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.

bool	IsTermVectorStored `[get]`
	True if the term or terms used to index this field are stored as a term vector, available from Lucene.Net.Index.IndexReader.GetTermFreqVector(int,String). These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the `stored` attribute instead.

bool	IsStoreOffsetWithTermVector `[get]`
	True if terms are stored as term vector together with their offsets (start and end positon in source text).

bool	IsStorePositionWithTermVector `[get]`
	True if terms are stored as term vector together with their token positions.

bool	IsBinary `[get]`
	True if the value of the field is stored as binary

bool	OmitNorms `[get, set]`
	True if norms are omitted for this indexed field.

bool	IsLazy `[get]`
	Indicates whether a Field is Lazy or not. The semantics of Lazy loading are such that if a Field is lazily loaded, retrieving it's values via StringValue() or GetBinaryValue() is only valid as long as the Lucene.Net.Index.IndexReader that retrieved the Document is still open.

int	BinaryOffset `[get]`
	Returns offset into byte[] segment that is used as value, if Field is not binary returned value is undefined

int	BinaryLength `[get]`
	Returns length of byte[] segment that is used as value, if Field is not binary returned value is undefined

bool	OmitTermFreqAndPositions `[get, set]`

Detailed Description

Definition at line 32 of file AbstractField.cs.

Member Function Documentation

virtual byte [] Lucene.Net.Documents.AbstractField.GetBinaryValue ( )

virtual

Return the raw byte[] for the binary field. Note that you must also call BinaryLength and BinaryOffset to know which range of bytes in this returned array belong to the field.

Returns: reference to the Field value as byte[].

Implements Lucene.Net.Documents.IFieldable.

Definition at line 172 of file AbstractField.cs.

virtual byte [] Lucene.Net.Documents.AbstractField.GetBinaryValue ( byte[] result )

virtual

Return the raw byte[] for the binary field. Note that you must also call BinaryLength and BinaryOffset to know which range of bytes in this returned array belong to the field.About reuse: if you pass in the result byte[] and it is used, likely the underlying implementation will hold onto this byte[] and return it in future calls to GetBinaryValue() or GetBinaryValue(). So if you subsequently re-use the same byte[] elsewhere it will alter this Fieldable's value.

Parameters

result User defined buffer that will be used if possible. If this is null or not large enough, a new buffer is allocated

Returns: reference to the Field value as byte[].

Implements Lucene.Net.Documents.IFieldable.

Reimplemented in Lucene.Net.Documents.NumericField.

Definition at line 177 of file AbstractField.cs.

override System.String Lucene.Net.Documents.AbstractField.ToString ( )

Prints a Field for human consumption.

Definition at line 240 of file AbstractField.cs.

Property Documentation

virtual int Lucene.Net.Documents.AbstractField.BinaryLength

get

Returns length of byte[] segment that is used as value, if Field is not binary returned value is undefined

length of byte[] segment that represents this Field value

Definition at line 190 of file AbstractField.cs.

virtual int Lucene.Net.Documents.AbstractField.BinaryOffset

get

Returns offset into byte[] segment that is used as value, if Field is not binary returned value is undefined

index of the first character in byte[] segment that represents this Field value

Definition at line 206 of file AbstractField.cs.

virtual float Lucene.Net.Documents.AbstractField.Boost

getset

Gets or sets the boost factor for hits for this field.

The default value is 1.0.

Note: this value is not stored directly with the document in the index. Documents returned from Lucene.Net.Index.IndexReader.Document(int) and Lucene.Net.Search.Searcher.Doc(int) may thus not have the same value present as when this field was indexed.

Definition at line 85 of file AbstractField.cs.

bool Lucene.Net.Documents.AbstractField.IsBinary

get

True iff the value of the filed is stored as binary

Definition at line 161 of file AbstractField.cs.

bool Lucene.Net.Documents.AbstractField.IsIndexed

get

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

Definition at line 118 of file AbstractField.cs.

virtual bool Lucene.Net.Documents.AbstractField.IsLazy

get

Definition at line 235 of file AbstractField.cs.

bool Lucene.Net.Documents.AbstractField.IsStored

get

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.

Definition at line 110 of file AbstractField.cs.

virtual bool Lucene.Net.Documents.AbstractField.IsStoreOffsetWithTermVector

get

True iff terms are stored as term vector together with their offsets (start and end position in source text).

Definition at line 149 of file AbstractField.cs.

virtual bool Lucene.Net.Documents.AbstractField.IsStorePositionWithTermVector

get

True iff terms are stored as term vector together with their token positions.

Definition at line 155 of file AbstractField.cs.

bool Lucene.Net.Documents.AbstractField.IsTermVectorStored

get

True iff the term or terms used to index this field are stored as a term vector, available from Lucene.Net.Index.IndexReader.GetTermFreqVector(int,String). These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the stored attribute instead.

See Also: Lucene.Net.Index.IndexReader.GetTermFreqVector(int, String)

Definition at line 141 of file AbstractField.cs.

bool Lucene.Net.Documents.AbstractField.IsTokenized

get

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.

Definition at line 127 of file AbstractField.cs.

virtual string Lucene.Net.Documents.AbstractField.Name

get

Returns the name of the field as an interned string. For example "date", "title", "body", ...

Definition at line 94 of file AbstractField.cs.

virtual bool Lucene.Net.Documents.AbstractField.OmitNorms

getset

True if norms are omitted for this indexed field

Definition at line 212 of file AbstractField.cs.

virtual bool Lucene.Net.Documents.AbstractField.OmitTermFreqAndPositions

getset

Expert:

If set, omit term freq, positions and payloads from postings for this field.

NOTE: While this option reduces storage space required in the index, it also means any query requiring positional information, such as PhraseQuery or SpanQuery subclasses will silently fail to find results.

Definition at line 229 of file AbstractField.cs.

abstract TextReader Lucene.Net.Documents.AbstractField.ReaderValue

get

Definition at line 309 of file AbstractField.cs.

abstract string Lucene.Net.Documents.AbstractField.StringValue

get

Definition at line 310 of file AbstractField.cs.

abstract TokenStream Lucene.Net.Documents.AbstractField.TokenStreamValue

get

Definition at line 308 of file AbstractField.cs.

The documentation for this class was generated from the following file:

core/Document/AbstractField.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation