Lucene.Net.Distributed.Indexing.IndexSet Class Reference

Definition of configurable search indexes managed by the LuceneUpdater windows service. More...

Public Member Functions
	IndexSet (XmlNode node)
	Public constructor for IndexSet. An IndexSet is defined in XML configuration and is loaded via a custom configuration handler.
NameValueCollection	GetDeletionCollection ()
	Retrieves a NameValueCollection of records to first be deleted from an index. Name/Value pair combination consists of IdColumn and RecordId from each IndexDocument in IndexDocuments.
void	Reset ()
	Clears the contents of Documents and IndexDocuments
void	Optimize ()
	Executes a Lucene.Net optimization against the referenced index.
bool	ContainsId (int recordId)
	Indicates if a given recordId exists within the configuration definition of TopId and BottomId.

Properties
int	Id [get]
	Unique identifier for an IndexSet within a configuration of multiple IndexSet objects
IndexAction	IndexAction [get]
	Enumeration dictating the type of updates to be applied to the underlying master index
AnalyzerType	AnalyzerType [get]
	Enumeration dictating the type of Analyzer to be applied to IndexDocuments in update scenarios
Analyzer	Analzyer [get]
	The Analyzer object used in application of IndexDocument updates
string	LocalPath [get]
	Filesystem path to the master index
string	IdColumn [get]
	String name representing the unique key for the given record in the index
int	BottomId [get]
	Minimum IdColumn value for a record in this index
int	TopId [get]
	Maximum IdColumn value for a record in this index
CurrentIndex	CurrentIndex [get]
	CurrentIndex object associated with this IndexSet. The CurrentIndex is used in determining index settings and maintenance as well as managing physical file updates for index updates.
List< string >	FileSystemDocuments [get]
	List of filesystem paths representing files for the master index
Hashtable	IndexDocuments [get]
	Pending updates to be applied to the master index
Hashtable	Documents [get]
	Retrieves the DeleteIndexDocuments from IndexDocuments

Detailed Description

Definition of configurable search indexes managed by the LuceneUpdater windows service.

An example configuration would look like the following: <indexsets compoundfile="true" deltadirectory="c:\indexes\indexdocuments"> <indexSet id="1" action="1" analyzer="1"> <add key="localpath" value="c:\lucene\masterindex\index1"> <copy> <targetPath indexa="\\LuceneServer\lucene\indexA\index1" indexb="\\LuceneServer\lucene\indexA\index1"> <statusDir value="\\LuceneServer\lucene\statusfile\"> </copy> <add key="bottomid" value="1"> <add key="topid" value="1000"> <add key="idcolumn" value="pkId"> </indexSet> </indexsets>

Definition at line 54 of file IndexSet.cs.

Constructor & Destructor Documentation

Lucene.Net.Distributed.Indexing.IndexSet.IndexSet

(

XmlNode

node

)

Public constructor for IndexSet. An IndexSet is defined in XML configuration and is loaded via a custom configuration handler.

Parameters

node	XmlNode definition for a given IndexSet

Definition at line 76 of file IndexSet.cs.

Member Function Documentation

bool Lucene.Net.Distributed.Indexing.IndexSet.ContainsId

(

int

recordId

)

Indicates if a given recordId exists within the configuration definition of TopId and BottomId.

Parameters

recordId

Returns

Definition at line 357 of file IndexSet.cs.

NameValueCollection Lucene.Net.Distributed.Indexing.IndexSet.GetDeletionCollection

(

)

Retrieves a NameValueCollection of records to first be deleted from an index. Name/Value pair combination consists of IdColumn and RecordId from each IndexDocument in IndexDocuments.

Returns

Definition at line 320 of file IndexSet.cs.

void Lucene.Net.Distributed.Indexing.IndexSet.Optimize

(

)

Executes a Lucene.Net optimization against the referenced index.

Definition at line 340 of file IndexSet.cs.

void Lucene.Net.Distributed.Indexing.IndexSet.Reset

(

)

Clears the contents of Documents and IndexDocuments

Definition at line 331 of file IndexSet.cs.

Property Documentation

AnalyzerType Lucene.Net.Distributed.Indexing.IndexSet.AnalyzerType

get

Enumeration dictating the type of Analyzer to be applied to IndexDocuments in update scenarios

Definition at line 225 of file IndexSet.cs.

Analyzer Lucene.Net.Distributed.Indexing.IndexSet.Analzyer

get

The Analyzer object used in application of IndexDocument updates

Definition at line 233 of file IndexSet.cs.

int Lucene.Net.Distributed.Indexing.IndexSet.BottomId

get

Minimum IdColumn value for a record in this index

Definition at line 257 of file IndexSet.cs.

CurrentIndex Lucene.Net.Distributed.Indexing.IndexSet.CurrentIndex

get

CurrentIndex object associated with this IndexSet. The CurrentIndex is used in determining index settings and maintenance as well as managing physical file updates for index updates.

Definition at line 275 of file IndexSet.cs.

Hashtable Lucene.Net.Distributed.Indexing.IndexSet.Documents

get

Retrieves the DeleteIndexDocuments from IndexDocuments

Definition at line 299 of file IndexSet.cs.

List<string> Lucene.Net.Distributed.Indexing.IndexSet.FileSystemDocuments

get

List of filesystem paths representing files for the master index

Definition at line 283 of file IndexSet.cs.

int Lucene.Net.Distributed.Indexing.IndexSet.Id

get

Unique identifier for an IndexSet within a configuration of multiple IndexSet objects

Definition at line 209 of file IndexSet.cs.

string Lucene.Net.Distributed.Indexing.IndexSet.IdColumn

get

String name representing the unique key for the given record in the index

Definition at line 249 of file IndexSet.cs.

IndexAction Lucene.Net.Distributed.Indexing.IndexSet.IndexAction

get

Enumeration dictating the type of updates to be applied to the underlying master index

Definition at line 217 of file IndexSet.cs.

Hashtable Lucene.Net.Distributed.Indexing.IndexSet.IndexDocuments

get

Pending updates to be applied to the master index

Definition at line 291 of file IndexSet.cs.

string Lucene.Net.Distributed.Indexing.IndexSet.LocalPath

get

Filesystem path to the master index

Definition at line 241 of file IndexSet.cs.

int Lucene.Net.Distributed.Indexing.IndexSet.TopId

get

Maximum IdColumn value for a record in this index

Definition at line 265 of file IndexSet.cs.

---

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

• contrib/DistributedSearch/Distributed/Indexing/IndexSet.cs