The Field type exposes the following members.

Methods

  NameDescription
Public methodBinaryValue 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()()()().)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBinaryLength
Returns length of byte[] segment that is used as value, if Field is not binary returned value is undefined
(Inherited from AbstractField.)
Public methodGetBinaryOffset
Returns offset into byte[] segment that is used as value, if Field is not binary returned value is undefined
(Inherited from AbstractField.)
Public methodGetBinaryValue()()()()
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.)
Public methodGetBinaryValue(array<Byte>[]()[][]) (Inherited from AbstractField.)
Public methodGetBoost
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.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetOmitNorms
True if norms are omitted for this indexed field
(Inherited from AbstractField.)
Public methodGetOmitTermFreqAndPositions (Inherited from AbstractField.)
Public methodGetOmitTf Obsolete. (Inherited from AbstractField.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsBinary
True iff the value of the filed is stored as binary
(Inherited from AbstractField.)
Public methodIsCompressed
True if the value of the field is stored and compressed within the index
(Inherited from AbstractField.)
Public methodIsIndexed
True iff the value of the field is to be indexed, so that it may be searched on.
(Inherited from AbstractField.)
Public methodIsLazy (Inherited from AbstractField.)
Public methodIsStored
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.)
Public methodIsStoreOffsetWithTermVector
True iff terms are stored as term vector together with their offsets (start and end position in source text).
(Inherited from AbstractField.)
Public methodIsStorePositionWithTermVector
True iff terms are stored as term vector together with their token positions.
(Inherited from AbstractField.)
Public methodIsTermVectorStored
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
CopyC#
stored
attribute instead.
(Inherited from AbstractField.)
Public methodIsTokenized
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.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodName
Returns the name of the field as an interned string. For example "date", "title", "body", ...
(Inherited from AbstractField.)
Public methodReaderValue
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()()()().)
Public methodSetBoost
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.)
Public methodSetOmitNorms
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.)
Public methodSetOmitTermFreqAndPositions
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.)
Public methodSetOmitTf Obsolete. (Inherited from AbstractField.)
Protected methodSetStoreTermVector (Inherited from AbstractField.)
Public methodSetTokenStream
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()
Public methodSetValue(array<Byte>[]()[][])
Expert: change the value of this field. See setValue(String).
Public methodSetValue(TextReader)
Expert: change the value of this field. See setValue(String).
Public methodSetValue(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.

Public methodSetValue(TokenStream) Obsolete.
Expert: change the value of this field. See setValue(String).
Public methodSetValue(array<Byte>[]()[][], Int32, Int32)
Expert: change the value of this field. See setValue(String).
Public methodStringValue
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()()()().)
Public methodTokenStreamValue
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()()()().)
Public methodToString
Prints a Field for human consumption.
(Inherited from AbstractField.)

See Also