Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Public Member Functions | List of all members
Lucene.Net.Documents.SetBasedFieldSelector Class Reference

Declare what fields to load normally and what fields to load lazily More...

Inherits Lucene.Net.Documents.FieldSelector.

Public Member Functions

 SetBasedFieldSelector (ISet< string > fieldsToLoad, ISet< string > lazyFieldsToLoad)
 Pass in the Set of Field names to load and the Set of Field names to load lazily. If both are null, the Document will not have any Field on it.
 
virtual FieldSelectorResult Accept (System.String fieldName)
 Indicate whether to load the field with the given name or not. If the AbstractField.Name() is not in either of the initializing Sets, then Lucene.Net.Documents.FieldSelectorResult.NO_LOAD is returned. If a Field name is in both fieldsToLoad and lazyFieldsToLoad, lazy has precedence.
 

Detailed Description

Declare what fields to load normally and what fields to load lazily

Definition at line 28 of file SetBasedFieldSelector.cs.

Constructor & Destructor Documentation

Lucene.Net.Documents.SetBasedFieldSelector.SetBasedFieldSelector ( ISet< string >  fieldsToLoad,
ISet< string >  lazyFieldsToLoad 
)

Pass in the Set of Field names to load and the Set of Field names to load lazily. If both are null, the Document will not have any Field on it.

Parameters
fieldsToLoadA Set of String field names to load. May be empty, but not null
lazyFieldsToLoadA Set of String field names to load lazily. May be empty, but not null

Definition at line 40 of file SetBasedFieldSelector.cs.

Member Function Documentation

virtual FieldSelectorResult Lucene.Net.Documents.SetBasedFieldSelector.Accept ( System.String  fieldName)
virtual

Indicate whether to load the field with the given name or not. If the AbstractField.Name() is not in either of the initializing Sets, then Lucene.Net.Documents.FieldSelectorResult.NO_LOAD is returned. If a Field name is in both fieldsToLoad and lazyFieldsToLoad, lazy has precedence.

Parameters
fieldNameThe Field name to check
Returns
The FieldSelectorResult

Implements Lucene.Net.Documents.FieldSelector.

Definition at line 55 of file SetBasedFieldSelector.cs.


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