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.Configuration.LuceneServerIndex Class Reference

Definition of a configurable search index made accessible by the LuceneServer windows service. More...

Public Member Functions

 LuceneServerIndex (XmlNode xSection, int defaultPort)
 Public constructor for LuceneServerIndex. A LuceneServerIndex is defined in XML configuration and is loaded via a custom configuration handler.
 
DirectoryInfo[] RefreshDirectories (IndexSetting oIndexSettingRefresh)
 Instance method that returns an array of directory paths associated with the given IndexSetting.
 

Properties

string ObjectUri [get]
 The published Uri name for a collective set of indexes. The ObjectUri is referenced by clients consuming the well-known service type. As an example, an ObjectUri of "RemoteSearchIndex" on a system located at 192.168.1.100, exposed on port 1089, would be accessed at "tcp://192.168.1.100:1089/RemoteSearchIndex".
 
int Port [get]
 A definable port number for the published Uri. Use this value to override the default Port setting for all published URIs.
 
DirectoryInfo[] IndexADirectories [get]
 File-system path to the "IndexA" location of the index files.
 
DirectoryInfo[] IndexBDirectories [get]
 File-system path to the "IndexB" location of the index files.
 

Detailed Description

Definition of a configurable search index made accessible by the LuceneServer windows service.

An example configuration would look like the following: <LuceneServerIndexes port="1089"> <LuceneServerIndex objecturi="RemoteIndexes1"> <Directory indexa="c:\lucene\indexA\index1" indexb="c:\lucene\indexB\index1"> <Directory indexa="c:\lucene\indexA\index2" indexb="c:\lucene\indexB\index2"> </LuceneServerIndex> <LuceneServerIndex objecturi="RemoteIndexes2"> <Directory indexa="c:\lucene\indexA\index3" indexb="c:\lucene\indexB\index3"> <Directory indexa="c:\lucene\indexA\index4" indexb="c:\lucene\indexB\index4"> </LuceneServerIndex> </LuceneServerIndexes>

Definition at line 44 of file LuceneServerIndex.cs.

Constructor & Destructor Documentation

Lucene.Net.Distributed.Configuration.LuceneServerIndex.LuceneServerIndex ( XmlNode  xSection,
int  defaultPort 
)

Public constructor for LuceneServerIndex. A LuceneServerIndex is defined in XML configuration and is loaded via a custom configuration handler.

Parameters
xSectionThe Xml definition in the configuration file
defaultPortThe default Port value, as defined in the contained LuceneServerIndexes configuration

Definition at line 59 of file LuceneServerIndex.cs.

Member Function Documentation

DirectoryInfo [] Lucene.Net.Distributed.Configuration.LuceneServerIndex.RefreshDirectories ( IndexSetting  oIndexSettingRefresh)

Instance method that returns an array of directory paths associated with the given IndexSetting.

Parameters
oIndexSettingRefreshIndexSetting enumeration value
Returns
DirectoryInfo[] of directory paths

Definition at line 165 of file LuceneServerIndex.cs.

Property Documentation

DirectoryInfo [] Lucene.Net.Distributed.Configuration.LuceneServerIndex.IndexADirectories
get

File-system path to the "IndexA" location of the index files.

Definition at line 147 of file LuceneServerIndex.cs.

DirectoryInfo [] Lucene.Net.Distributed.Configuration.LuceneServerIndex.IndexBDirectories
get

File-system path to the "IndexB" location of the index files.

Definition at line 155 of file LuceneServerIndex.cs.

string Lucene.Net.Distributed.Configuration.LuceneServerIndex.ObjectUri
get

The published Uri name for a collective set of indexes. The ObjectUri is referenced by clients consuming the well-known service type. As an example, an ObjectUri of "RemoteSearchIndex" on a system located at 192.168.1.100, exposed on port 1089, would be accessed at "tcp://192.168.1.100:1089/RemoteSearchIndex".

This value is required in configuration.

Definition at line 129 of file LuceneServerIndex.cs.

int Lucene.Net.Distributed.Configuration.LuceneServerIndex.Port
get

A definable port number for the published Uri. Use this value to override the default Port setting for all published URIs.

This value is optional in configuration.

Definition at line 139 of file LuceneServerIndex.cs.


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