C# Class Lucene.Net.Documents.Field

Show file Open project: synhershko/lucene.net Class Usage Examples

Public Methods

Method	Description
Field ( System name, Lucene.Net.Analysis.TokenStream tokenStream ) : System	Create a tokenized and indexed field that is not stored. Term vectors will not be stored. This is useful for pre-analyzed fields. The TokenStream is read only when the Document is added to the index, i.e. you may not close the TokenStream until IndexWriter.AddDocument(Document) has been called.
Field ( System name, Lucene.Net.Analysis.TokenStream tokenStream, TermVector termVector ) : System	Create a tokenized and indexed field that is not stored, optionally with storing term vectors. This is useful for pre-analyzed fields. The TokenStream is read only when the Document is added to the index, i.e. you may not close the TokenStream until IndexWriter.AddDocument(Document) has been called.
Field ( System name, System reader ) : System	Create a tokenized and indexed field that is not stored. Term vectors will not be stored. The Reader is read only when the Document is added to the index, i.e. you may not close the Reader until IndexWriter.AddDocument(Document) has been called.
Field ( System name, System value_Renamed, Store store, Index index ) : System	Create a field by specifying its name, value and how it will be saved in the index. Term vectors will not be stored in the index.
Field ( System name, System value_Renamed, Store store, Index index, TermVector termVector ) : System	Create a field by specifying its name, value and how it will be saved in the index. the field is neither stored nor indexed the field is not indexed but termVector is `TermVector.YES`
Field ( System name, System reader, TermVector termVector ) : System	Create a tokenized and indexed field that is not stored, optionally with storing term vectors. The Reader is read only when the Document is added to the index, i.e. you may not close the Reader until IndexWriter.AddDocument(Document) has been called.
Field ( System name, bool internName, System value_Renamed, Store store, Index index, TermVector termVector ) : System	Create a field by specifying its name, value and how it will be saved in the index. the field is neither stored nor indexed the field is not indexed but termVector is `TermVector.YES`
Field ( System name, byte value_Renamed, Store store ) : System	Create a stored field with binary value. Optionally the value may be compressed.
Field ( System name, byte value_Renamed, int offset, int length, Store store ) : System	Create a stored field with binary value. Optionally the value may be compressed.
SetTokenStream ( Lucene.Net.Analysis.TokenStream tokenStream ) : void	Expert: sets the token stream to be used for indexing and causes isIndexed() and isTokenized() to return true. May be combined with stored values from stringValue() or GetBinaryValue()
SetValue ( System value_Renamed ) : void	Expert: change the value of this field. This can be used during indexing to re-use a single Field instance to improve indexing speed by avoiding GC cost of new'ing and reclaiming Field instances. Typically a single Document instance is re-used as well. This helps most on small documents. Each Field instance should only be used once within a single Document instance. See ImproveIndexingSpeed for details.
SetValue ( byte value_Renamed ) : void	Expert: change the value of this field. See setValue(String).
SetValue ( byte value_Renamed, int offset, int length ) : void	Expert: change the value of this field. See setValue(String).

Method Details

Field() public method

Create a tokenized and indexed field that is not stored. Term vectors will not be stored. This is useful for pre-analyzed fields. The TokenStream is read only when the Document is added to the index, i.e. you may not close the TokenStream until IndexWriter.AddDocument(Document) has been called.

public Field ( System name, Lucene.Net.Analysis.TokenStream tokenStream ) : System
name	System	The name of the field ///
tokenStream	Lucene.Net.Analysis.TokenStream	The TokenStream with the content ///
return	System

Field() public method

Create a tokenized and indexed field that is not stored, optionally with storing term vectors. This is useful for pre-analyzed fields. The TokenStream is read only when the Document is added to the index, i.e. you may not close the TokenStream until IndexWriter.AddDocument(Document) has been called.

public Field ( System name, Lucene.Net.Analysis.TokenStream tokenStream, TermVector termVector ) : System
name	System	The name of the field ///
tokenStream	Lucene.Net.Analysis.TokenStream	The TokenStream with the content ///
termVector	TermVector	Whether term vector should be stored ///
return	System

Field() public method

Create a tokenized and indexed field that is not stored. Term vectors will not be stored. The Reader is read only when the Document is added to the index, i.e. you may not close the Reader until IndexWriter.AddDocument(Document) has been called.

public Field ( System name, System reader ) : System
name	System	The name of the field ///
reader	System	The reader with the content ///
return	System

Field() public method

Create a field by specifying its name, value and how it will be saved in the index. Term vectors will not be stored in the index.

public Field ( System name, System value_Renamed, Store store, Index index ) : System
name	System	The name of the field ///
value_Renamed	System	The string to process ///
store	Store	Whether value should be stored in the index ///
index	Index	Whether the field should be indexed, and if so, if it should /// be tokenized before indexing ///
return	System

Field() public method

Create a field by specifying its name, value and how it will be saved in the index. the field is neither stored nor indexed the field is not indexed but termVector is TermVector.YES

public Field ( System name, System value_Renamed, Store store, Index index, TermVector termVector ) : System
name	System	The name of the field ///
value_Renamed	System	The string to process ///
store	Store	Whether value should be stored in the index ///
index	Index	Whether the field should be indexed, and if so, if it should /// be tokenized before indexing ///
termVector	TermVector	Whether term vector should be stored ///
return	System

Field() public method

Create a tokenized and indexed field that is not stored, optionally with storing term vectors. The Reader is read only when the Document is added to the index, i.e. you may not close the Reader until IndexWriter.AddDocument(Document) has been called.

public Field ( System name, System reader, TermVector termVector ) : System
name	System	The name of the field ///
reader	System	The reader with the content ///
termVector	TermVector	Whether term vector should be stored ///
return	System

Field() public method

Create a field by specifying its name, value and how it will be saved in the index. the field is neither stored nor indexed the field is not indexed but termVector is TermVector.YES

public Field ( System name, bool internName, System value_Renamed, Store store, Index index, TermVector termVector ) : System
name	System	The name of the field ///
internName	bool	Whether to .intern() name or not ///
value_Renamed	System	The string to process ///
store	Store	Whether value should be stored in the index ///
index	Index	Whether the field should be indexed, and if so, if it should /// be tokenized before indexing ///
termVector	TermVector	Whether term vector should be stored ///
return	System

Field() public method

Create a stored field with binary value. Optionally the value may be compressed.

public Field ( System name, byte value_Renamed, Store store ) : System
name	System	The name of the field ///
value_Renamed	byte	The binary value ///
store	Store	How value should be stored (compressed or not) ///
return	System

Field() public method

Create a stored field with binary value. Optionally the value may be compressed.

public Field ( System name, byte value_Renamed, int offset, int length, Store store ) : System
name	System	The name of the field ///
value_Renamed	byte	The binary value ///
offset	int	Starting offset in value where this Field's bytes are ///
length	int	Number of bytes to use for this Field, starting at offset ///
store	Store	How value should be stored (compressed or not) ///
return	System

SetTokenStream() public method

Expert: sets the token stream to be used for indexing and causes isIndexed() and isTokenized() to return true. May be combined with stored values from stringValue() or GetBinaryValue()

public SetTokenStream ( Lucene.Net.Analysis.TokenStream tokenStream ) : void
tokenStream	Lucene.Net.Analysis.TokenStream
return	void

SetValue() public method

Expert: change the value of this field. This can be used during indexing to re-use a single Field instance to improve indexing speed by avoiding GC cost of new'ing and reclaiming Field instances. Typically a single Document instance is re-used as well. This helps most on small documents.

Each Field instance should only be used once within a single Document instance. See ImproveIndexingSpeed for details.

public SetValue ( System value_Renamed ) : void
value_Renamed	System
return	void

SetValue() public method

Expert: change the value of this field. See setValue(String).

public SetValue ( byte value_Renamed ) : void
value_Renamed	byte
return	void

SetValue() public method

Expert: change the value of this field. See setValue(String).

public SetValue ( byte value_Renamed, int offset, int length ) : void
value_Renamed	byte
offset	int
length	int
return	void