Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Classes | Enumerations
Package Lucene.Net.Documents

Classes

class  AbstractField
  More...
 
class  CompressionTools
 Simple utility class providing static methods to compress and decompress binary data for stored fields. This class uses java.util.zip.Deflater and Inflater classes to compress and decompress. More...
 
class  DateField
 Provides support for converting dates to strings and vice-versa. The strings are structured so that lexicographic sorting orders by date, which makes them suitable for use as field values and search terms. More...
 
class  DateTools
 Provides support for converting dates to strings and vice-versa. The strings are structured so that lexicographic sorting orders them by date, which makes them suitable for use as field values and search terms. More...
 
class  Document
 Documents are the unit of indexing and search. More...
 
class  Field
 A field is a section of a Document. Each field has two parts, a name and a value. Values may be free text, provided as a String or as a Reader, or they may be atomic keywords, which are not further processed. Such keywords may be used to represent dates, urls, etc. Fields are optionally stored in the index, so that they may be returned with hits on the document. More...
 
class  FieldExtensions
 
interface  IFieldable
 Synonymous with Field. More...
 
interface  FieldSelector
 Similar to a java.io.FileFilter, the FieldSelector allows one to make decisions about what Fields get loaded on a Document by Lucene.Net.Index.IndexReader.Document(int,Lucene.Net.Documents.FieldSelector) More...
 
class  LoadFirstFieldSelector
 Load the First field and break. See FieldSelectorResult.LOAD_AND_BREAK More...
 
class  MapFieldSelector
 A FieldSelector based on a Map of field names to FieldSelectorResults More...
 
class  NumberTools
 Provides support for converting longs to Strings, and back again. The strings are structured so that lexicographic sorting order is preserved. More...
 
class  NumericField
 This class provides a Field that enables indexing of numeric values for efficient range filtering and sorting. Here's an example usage, adding an int value: More...
 
class  SetBasedFieldSelector
 Declare what fields to load normally and what fields to load lazily More...
 

Enumerations

enum  FieldSelectorResult {
  INVALID, LOAD, LAZY_LOAD, NO_LOAD,
  LOAD_AND_BREAK, SIZE, SIZE_AND_BREAK
}
 Provides information about what should be done with this Field More...
 

Enumeration Type Documentation

enum Lucene.Net.Documents.FieldSelectorResult

Provides information about what should be done with this Field

Enumerator
INVALID 
LOAD 

Load this Field every time the Document is loaded, reading in the data as it is encountered. Document.GetField(String) and Document.GetFieldable(String) should not return null.

Document.Add(IFieldable) should be called by the Reader.

LAZY_LOAD 

Lazily load this Field. This means the Field is valid, but it may not actually contain its data until invoked. Document.GetField(String) SHOULD NOT BE USED. Document.GetFieldable(String) is safe to use and should return a valid instance of a IFieldable.

Document.Add(IFieldable) should be called by the Reader.

NO_LOAD 

Do not load the Field. Document.GetField(String) and Document.GetFieldable(String) should return null. Document.Add(IFieldable) is not called.

Document.Add(IFieldable) should not be called by the Reader.

LOAD_AND_BREAK 

Load this field as in the LOAD case, but immediately return from Field loading for the Document. Thus, the Document may not have its complete set of Fields. Document.GetField(String) and Document.GetFieldable(String) should both be valid for this Field

Document.Add(IFieldable) should be called by the Reader.

SIZE 

Expert: Load the size of this Field rather than its value. Size is measured as number of bytes required to store the field == bytes for a binary or any compressed value, and 2*chars for a String value. The size is stored as a binary value, represented as an int in a byte[], with the higher order byte first in [0]

SIZE_AND_BREAK 

Expert: Like SIZE but immediately break from the field loading loop, i.e., stop loading further fields, after the size is loaded

Definition at line 25 of file FieldSelectorResult.cs.