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
Public Member Functions | Properties | List of all members
Lucene.Net.Distributed.Indexing.IndexSets Class Reference

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

Public Member Functions

void LoadIndexSetArray (XmlNode node)
 Strongly-typed array of IndexSet objects as defined in a configuration section.
 
 IndexSets ()
 Public constructor for IndexSets. An IndexSet is defined in XML configuration and is loaded via a custom configuration handler.
 
IndexSet GetIndexSet (int deleteId)
 Returns an IndexSet object for a given IndexDocument id value
 
void LoadIndexDocuments (string sourceDir)
 Queries the DeltaDirectory to access any IndexDocument files. All IndexDocuments stored in the DeltaDirectory have been serialized to a file; the files are deserialized, evaluated for their id value (idcolumn) and added to the pending additions for the associated IndexSet.
 
void ProcessIndexDocuments ()
 Method to apply pending updates (additions & deletions) for all configured IndexSet objects.
 
void CopyUpdatedFiles ()
 Method to apply updated index files from master index to slave indexes
 
Hashtable CopyAllFiles ()
 Method to apply updated index files from master index to slave indexes
 
void OptimizeIndexes ()
 Method to execute an index optimization for each configured IndexSet object
 
void CompleteUpdate ()
 Method to finalize update process for each IndexSet object
 

Properties

static IndexSets GetConfig [get]
 Accessor method for the configurable master indexes.
 
bool CompoundFile [get]
 Indicates if the indexes under configuration should be built in the Compound format.
 
string DeltaDirectory [get]
 Filesystem location of where pending update IndexDocuments are retrieved.
 
IndexSet[] IndexSetArray [get]
 Strongly-typed array of IndexSet objects as defined in a configuration section.
 

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 50 of file IndexSets.cs.

Constructor & Destructor Documentation

Lucene.Net.Distributed.Indexing.IndexSets.IndexSets ( )

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

Definition at line 111 of file IndexSets.cs.

Member Function Documentation

void Lucene.Net.Distributed.Indexing.IndexSets.CompleteUpdate ( )

Method to finalize update process for each IndexSet object

Definition at line 276 of file IndexSets.cs.

Hashtable Lucene.Net.Distributed.Indexing.IndexSets.CopyAllFiles ( )

Method to apply updated index files from master index to slave indexes

Returns
Hashtable of updated indexes

Definition at line 241 of file IndexSets.cs.

void Lucene.Net.Distributed.Indexing.IndexSets.CopyUpdatedFiles ( )

Method to apply updated index files from master index to slave indexes

Definition at line 216 of file IndexSets.cs.

IndexSet Lucene.Net.Distributed.Indexing.IndexSets.GetIndexSet ( int  deleteId)

Returns an IndexSet object for a given IndexDocument id value

Parameters
deleteIdId value of the IndexDocument
Returns
The IndexSet containing the referenced IndexDocument

Definition at line 144 of file IndexSets.cs.

void Lucene.Net.Distributed.Indexing.IndexSets.LoadIndexDocuments ( string  sourceDir)

Queries the DeltaDirectory to access any IndexDocument files. All IndexDocuments stored in the DeltaDirectory have been serialized to a file; the files are deserialized, evaluated for their id value (idcolumn) and added to the pending additions for the associated IndexSet.

Parameters
sourceDirFilesystem path to the DeltaDirectory

Definition at line 162 of file IndexSets.cs.

void Lucene.Net.Distributed.Indexing.IndexSets.LoadIndexSetArray ( XmlNode  node)

Strongly-typed array of IndexSet objects as defined in a configuration section.

Parameters
nodeXmlNode definition for a given IndexSet

Definition at line 68 of file IndexSets.cs.

void Lucene.Net.Distributed.Indexing.IndexSets.OptimizeIndexes ( )

Method to execute an index optimization for each configured IndexSet object

Definition at line 267 of file IndexSets.cs.

void Lucene.Net.Distributed.Indexing.IndexSets.ProcessIndexDocuments ( )

Method to apply pending updates (additions & deletions) for all configured IndexSet objects.

Definition at line 201 of file IndexSets.cs.

Property Documentation

bool Lucene.Net.Distributed.Indexing.IndexSets.CompoundFile
get

Indicates if the indexes under configuration should be built in the Compound format.

Definition at line 119 of file IndexSets.cs.

string Lucene.Net.Distributed.Indexing.IndexSets.DeltaDirectory
get

Filesystem location of where pending update IndexDocuments are retrieved.

Definition at line 127 of file IndexSets.cs.

IndexSets Lucene.Net.Distributed.Indexing.IndexSets.GetConfig
staticget

Accessor method for the configurable master indexes.

Definition at line 60 of file IndexSets.cs.

IndexSet [] Lucene.Net.Distributed.Indexing.IndexSets.IndexSetArray
get

Strongly-typed array of IndexSet objects as defined in a configuration section.

Definition at line 135 of file IndexSets.cs.


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