Lucene.Net
3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
|
Definition of current index information managed by the LuceneUpdater windows service. The <copy> node within the <indexset> node represents the information needed to load a CurrentIndex object for a given IndexSet. More...
Public Member Functions | |
CurrentIndex (XmlNode node, string strLocalPath) | |
Constructs a new CurrentIndex using the XmlNode value (from IndexSetConfigurationHandler configuration) | |
CurrentIndex (string sStatusDir) | |
Constructs a shell CurrentIndex. Use this constructor to interact with the underlying status and toggle files ONLY. | |
bool | Copy () |
Method that executes a filesystem copy of all directory files from a local path to the proper offline index. This method ensures no conflicts occur with the online index. | |
bool | CopyIncremental () |
Method that executes a filesystem copy of updated or new files from a local path to the proper offline index. This method ensures no conflicts occur with the online index. | |
void | ProcessLocalIndexDeletes (NameValueCollection nvcDeleteCollection) |
Takes a name/value pair collection to be used in updating an index. Deletes are necessary to ensure no duplication occurs within the index. | |
void | ProcessLocalIndexAdditions (Analyzer oAnalyzer, Hashtable htAddDocuments, bool bCompoundFile) |
Executes a loop on the Documents arraylist, adding each one to the index with the associated analyzer. | |
void | IndexRefresh () |
Single method to be used by a searchhost to indicate an index refresh has completed. | |
void | UpdateRefresh () |
Single method to be used by an index updater to indicate an index update has completed. | |
Static Public Member Functions | |
static Analyzer | GetAnalyzer (AnalyzerType oAnalyzerType) |
Returns an Analyzer for the given AnalyzerType | |
Properties | |
string | LocalPath [get] |
Filesystem path to the local source for an index; this is the path to the master index. | |
string | StatusDirectory [get] |
Filesystem path to a LuceneServer's status and toggle file for a given IndexSet | |
IndexSetting | IndexSetting [get] |
Indicates the current index directory (IndexSetting enum) in use (the online set) | |
IndexSetting | IndexSettingRefresh [get] |
Indicates the index directory to be used in any index searcher refresh by determining if any updates have been applied | |
bool | CanCopy [get] |
Indicates if the current index permits updated indexes to be copied to CopyTargetPath | |
bool | HasChanged [get] |
Indicates if the current index has pending updates (in the offline directory) to be used by an index searcher in a refresh evaluation | |
string | CopyTargetPath [get] |
The target directory path to be used when updating the offline index | |
Definition of current index information managed by the LuceneUpdater windows service. The <copy> node within the <indexset> node represents the information needed to load a CurrentIndex object for a given IndexSet.
An example configuration would look like the following: <indexsets ramallocation="100000" 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 63 of file CurrentIndex.cs.
Lucene.Net.Distributed.Configuration.CurrentIndex.CurrentIndex | ( | XmlNode | node, |
string | strLocalPath | ||
) |
Constructs a new CurrentIndex using the XmlNode value (from IndexSetConfigurationHandler configuration)
node | XmlNode containing configuration information |
strLocalPath | Local filesystem path to source index |
Definition at line 87 of file CurrentIndex.cs.
Lucene.Net.Distributed.Configuration.CurrentIndex.CurrentIndex | ( | string | sStatusDir | ) |
Constructs a shell CurrentIndex. Use this constructor to interact with the underlying status and toggle files ONLY.
sStatusDir | Filesystem path to the status and toggle files for an index |
Definition at line 98 of file CurrentIndex.cs.
bool Lucene.Net.Distributed.Configuration.CurrentIndex.Copy | ( | ) |
Method that executes a filesystem copy of all directory files from a local path to the proper offline index. This method ensures no conflicts occur with the online index.
Definition at line 207 of file CurrentIndex.cs.
bool Lucene.Net.Distributed.Configuration.CurrentIndex.CopyIncremental | ( | ) |
Method that executes a filesystem copy of updated or new files from a local path to the proper offline index. This method ensures no conflicts occur with the online index.
Definition at line 234 of file CurrentIndex.cs.
|
static |
Returns an Analyzer for the given AnalyzerType
oAnalyzerType | Enumeration value |
Definition at line 590 of file CurrentIndex.cs.
void Lucene.Net.Distributed.Configuration.CurrentIndex.IndexRefresh | ( | ) |
Single method to be used by a searchhost to indicate an index refresh has completed.
Definition at line 301 of file CurrentIndex.cs.
void Lucene.Net.Distributed.Configuration.CurrentIndex.ProcessLocalIndexAdditions | ( | Analyzer | oAnalyzer, |
Hashtable | htAddDocuments, | ||
bool | bCompoundFile | ||
) |
Executes a loop on the Documents arraylist, adding each one to the index with the associated analyzer.
oAnalyzer | Analyzer to be used in index document addition |
alAddDocuments | Arraylist of Lucene Document objects to be inserted in the index |
bCompoundFile | Setting to dictate if the index should use compound format |
Definition at line 283 of file CurrentIndex.cs.
void Lucene.Net.Distributed.Configuration.CurrentIndex.ProcessLocalIndexDeletes | ( | NameValueCollection | nvcDeleteCollection | ) |
Takes a name/value pair collection to be used in updating an index. Deletes are necessary to ensure no duplication occurs within the index.
nvcDeleteCollection | Set of record IDs (with underlying field name) to be applied for index updating |
Definition at line 260 of file CurrentIndex.cs.
void Lucene.Net.Distributed.Configuration.CurrentIndex.UpdateRefresh | ( | ) |
Single method to be used by an index updater to indicate an index update has completed.
Definition at line 313 of file CurrentIndex.cs.
|
get |
Indicates if the current index permits updated indexes to be copied to CopyTargetPath
Definition at line 179 of file CurrentIndex.cs.
|
get |
The target directory path to be used when updating the offline index
Definition at line 196 of file CurrentIndex.cs.
|
get |
Indicates if the current index has pending updates (in the offline directory) to be used by an index searcher in a refresh evaluation
Definition at line 188 of file CurrentIndex.cs.
|
get |
Indicates the current index directory (IndexSetting enum) in use (the online set)
Definition at line 148 of file CurrentIndex.cs.
|
get |
Indicates the index directory to be used in any index searcher refresh by determining if any updates have been applied
Definition at line 161 of file CurrentIndex.cs.
|
get |
Filesystem path to the local source for an index; this is the path to the master index.
Definition at line 133 of file CurrentIndex.cs.
|
get |
Filesystem path to a LuceneServer's status and toggle file for a given IndexSet
Definition at line 140 of file CurrentIndex.cs.