IndexServer.dtd

Configuration Reference

Generated by DTDDoc.

It is the root element of the Index Server configuration.

<IndexServer>'s children Name Cardinality IndexManager At least one LogFile Only one XFileFactoryClass One or none

<IndexServer>'s attributes Name Values Default port

(LogFile,XFileFactoryClass?,IndexManager+)

This tag defines an index.
The configuration file must contain one of this element for each index you want to create.

<IndexManager>'s children Name Cardinality AnalyzerClass Only one IndexDescription One or none IndexDirectory Only one IndexName Only one Log One or none Source At least one Tasks One or none

(IndexName,IndexDescription?,IndexDirectory,AnalyzerClass,Source+,Log?,Tasks?)

Path to the main log file. This Log collects messages from the server itself.

Path to the index-specific log file. If this element is omitted, then all index level messages go to the main log file.

<Log>'s attributes Name Values Default level HIGH, LOW

Defines the XFileFactory class to be used. If not present the org.apache.lucene.server.SimpleXFileFactory will be used.

Name of the index. This name is used as an identifier by the server.

this is the path to the directory where Lucene files are stored for this index.

the java Analyzer class that will be used to create the index.

informative description.

A source is a set of files to be indexed.
It is defined by a Location and several FileHandler. An index may be consist of several sources.

A given file matches the source if :

<Source>'s children Name Cardinality FileHandler At least one Location Only one

(Location,FileHandler+)

the location is a base path that determines a set of files.

There are three types of locations.

• Single File Location : represented by a path to a single file. (ex. c:/documents/doc.txt). The set of files is a singleton.
• Directory Location : represented by a path to a valid directory. (ex. c:/documents/). In a directory Location, the set of files is the set of all files from all subdirectories.
• Files List Location : represented by a path to a valid directory plus a regular expression. (ex. c:/documents/{.*\.txt}). In this case the set of file is consists of all the files from the specified directory whose name matches the regular expression. Note that the regular Expression is surrounded in brackets.

<Location>'s attributes Name Values Default XFileFactoryClass

This element defines what to do with each type of file that the file set includes.

<FileHandler>'s children Name Cardinality FileHandlerClass Only one FileType Only one

(FileType,FileHandlerClass)

A FileType is a valid regular expression.
A file is said to match the enclosing FileHandler if its name matches this regular expression.

Name of a java class that implements the org.apache.lucine.server.FileHandlerInterface interface.

Defines a list of tasks to be scheduled.

<Tasks>'s children Name Cardinality Build Any number

(Build*)

The build task is the action of rebuild the entire index.

<Build>'s attributes
Name	Values	Default
at
when	EVERYDAY, MONDAY, TUESDAY, WEDNESDAY, FRIDAY, THURSDAY, SATURDAY, SUNDAY

This tag is always empty.

Day of the week for on which this task must be scheduled.

Possible values : EVERYDAY, MONDAY, TUESDAY, WEDNESDAY, FRIDAY, THURSDAY, SATURDAY, SUNDAY - Required

Time at which the task must start (in the form of hh:mm:ss).

Required

The port attribute indicates the TCP port on which the server will listen. Actually if this attribute is specified, the server will create its own RMI registry using this port number. If it is omitted, the server will use the default registry (in that case you must have the rmiregistry program running on your host).

At high level, the index server will be verbose when building the index. It lists all the files that are treated and the matched source.
It is useful to which files are indexed and which one are not.
Beware that with a large amount of files, the log file can grow quickly.

Possible values : HIGH, LOW

Defines a local XFileFactory that overrides the default one.