The Field type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Field(String, TokenStream) | 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 {@link IndexWriter#AddDocument(Document)}
has been called.
|
| Field(String, TextReader) | 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 {@link IndexWriter#AddDocument(Document)}
has been called.
|
| Field(String, TokenStream, Field..::..TermVector) | 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 {@link IndexWriter#AddDocument(Document)}
has been called.
|
| Field(String, array<Byte>[]()[][], Field..::..Store) | Create a stored field with binary value. Optionally the value may be compressed.
|
| Field(String, TextReader, Field..::..TermVector) | 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 {@link IndexWriter#AddDocument(Document)}
has been called.
|
| Field(String, String, Field..::..Store, Field..::..Index) | 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(String, array<Byte>[]()[][], Int32, Int32, Field..::..Store) | Create a stored field with binary value. Optionally the value may be compressed.
|
| Field(String, String, Field..::..Store, Field..::..Index, Field..::..TermVector) | Create a field by specifying its name, value and how it will
be saved in the index.
|
| Field(String, Boolean, String, Field..::..Store, Field..::..Index, Field..::..TermVector) | Create a field by specifying its name, value and how it will
be saved in the index.
|
Methods
| Name | Description | |
|---|---|---|
| BinaryValue | Obsolete. The value of the field in Binary, or null. If null, the Reader value,
or String value is used. Exactly one of stringValue(),
readerValue(), and getBinaryValue() must be set.
(Overrides AbstractField..::..BinaryValue()()()().) |
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetBinaryLength | Returns length of byte[] segment that is used as value, if Field is not binary
returned value is undefined
(Inherited from AbstractField.) |
| GetBinaryOffset | Returns offset into byte[] segment that is used as value, if Field is not binary
returned value is undefined
(Inherited from AbstractField.) |
| GetBinaryValue()()()() | Return the raw byte[] for the binary field. Note that
you must also call {@link #getBinaryLength} and {@link
#getBinaryOffset} to know which range of bytes in this
returned array belong to the field.
(Inherited from AbstractField.) |
| GetBinaryValue(array<Byte>[]()[][]) | (Inherited from AbstractField.) |
| GetBoost | Returns 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 {@link Lucene.Net.Index.IndexReader#Document(int)} and
{@link Lucene.Net.Search.Hits#Doc(int)} may thus not have the same value present as when
this field was indexed.
(Inherited from AbstractField.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetOmitNorms | True if norms are omitted for this indexed field (Inherited from AbstractField.) |
| GetOmitTermFreqAndPositions | (Inherited from AbstractField.) |
| GetOmitTf | Obsolete. (Inherited from AbstractField.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsBinary | True iff the value of the filed is stored as binary (Inherited from AbstractField.) |
| IsCompressed | True if the value of the field is stored and compressed within the index (Inherited from AbstractField.) |
| IsIndexed | True iff the value of the field is to be indexed, so that it may be
searched on.
(Inherited from AbstractField.) |
| IsLazy | (Inherited from AbstractField.) |
| 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.
(Inherited from AbstractField.) |
| IsStoreOffsetWithTermVector | True iff terms are stored as term vector together with their offsets
(start and end position in source text).
(Inherited from AbstractField.) |
| IsStorePositionWithTermVector | True iff terms are stored as term vector together with their token positions. (Inherited from AbstractField.) |
| IsTermVectorStored | True iff the term or terms used to index this field are stored as a term
vector, available from {@link 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 (Inherited from AbstractField.) CopyC#stored |
| 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.
(Inherited from AbstractField.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Name | Returns the name of the field as an interned string.
For example "date", "title", "body", ...
(Inherited from AbstractField.) |
| ReaderValue | The value of the field as a Reader, or null. If null, the String value or
binary value is used. Exactly one of stringValue(),
readerValue(), and getBinaryValue() must be set.
(Overrides AbstractField..::..ReaderValue()()()().) |
| SetBoost | Sets the boost factor hits on this field. This value will be
multiplied into the score of all hits on this this field of this
document.
The boost is multiplied by {@link Lucene.Net.Documents.Document#GetBoost()} of the document
containing this field. If a document has multiple fields with the same
name, all such values are multiplied together. This product is then
used to compute the norm factor for the field. By
default, in the {@link
Lucene.Net.Search.Similarity#ComputeNorm(String,
FieldInvertState)} method, the boost value is multipled
by the {@link
Lucene.Net.Search.Similarity#LengthNorm(String,
int)} and then
rounded by {@link Lucene.Net.Search.Similarity#EncodeNorm(float)} before it is stored in the
index. One should attempt to ensure that this product does not overflow
the range of that encoding.
(Inherited from AbstractField.) |
| SetOmitNorms | Expert:
If set, omit normalization factors associated with this indexed field.
This effectively disables indexing boosts and length normalization for this field.
(Inherited from AbstractField.) |
| SetOmitTermFreqAndPositions | 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 {@link
PhraseQuery} or {@link SpanQuery} subclasses will
silently fail to find results.
(Inherited from AbstractField.) |
| SetOmitTf | Obsolete. (Inherited from AbstractField.) |
| SetStoreTermVector | (Inherited from AbstractField.) |
| SetTokenStream | 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 binaryValue()
|
| SetValue(array<Byte>[]()[][]) | Expert: change the value of this field. See setValue(String). |
| SetValue(TextReader) | Expert: change the value of this field. See setValue(String). |
| SetValue(String) | 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 {@link Document} instance is re-used as
well. This helps most on small documents.Each Field instance should only be used once
within a single {@link Document} instance. See ImproveIndexingSpeed
for details. |
| SetValue(TokenStream) | Obsolete. Expert: change the value of this field. See setValue(String). |
| SetValue(array<Byte>[]()[][], Int32, Int32) | Expert: change the value of this field. See setValue(String). |
| StringValue | The value of the field as a String, or null. If null, the Reader value or
binary value is used. Exactly one of stringValue(),
readerValue(), and getBinaryValue() must be set.
(Overrides AbstractField..::..StringValue()()()().) |
| TokenStreamValue | The TokesStream for this field to be used when indexing, or null. If null, the Reader value
or String value is analyzed to produce the indexed tokens.
(Overrides AbstractField..::..TokenStreamValue()()()().) |
| ToString | Prints a Field for human consumption. (Inherited from AbstractField.) |
Fields
| Name | Description | |
|---|---|---|
 | binaryLength | (Inherited from AbstractField.) |
| binaryOffset | (Inherited from AbstractField.) |
| boost | (Inherited from AbstractField.) |
| fieldsData | (Inherited from AbstractField.) |
| isBinary | (Inherited from AbstractField.) |
| isCompressed | (Inherited from AbstractField.) |
| isIndexed | (Inherited from AbstractField.) |
| isStored | (Inherited from AbstractField.) |
| isTokenized | (Inherited from AbstractField.) |
| lazy | (Inherited from AbstractField.) |
| name | (Inherited from AbstractField.) |
| omitNorms | (Inherited from AbstractField.) |
| omitTermFreqAndPositions | (Inherited from AbstractField.) |
| storeOffsetWithTermVector | (Inherited from AbstractField.) |
| storePositionWithTermVector | (Inherited from AbstractField.) |
| storeTermVector | (Inherited from AbstractField.) |
| tokenStream | (Inherited from AbstractField.) |
