gate.mimir

Class IndexConfig

java.lang.Object

gate.mimir.IndexConfig

All Implemented Interfaces:

Serializable

public class IndexConfig
extends Object
implements Serializable

Interface for indexer configurations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexConfig.IndexerConfig Base class for indexer configs
static class	IndexConfig.SemanticIndexerConfig Object storing the configuration for a semantic annotation indexer.
static class	IndexConfig.TokenIndexerConfig Object storing the configuration for a Token indexer.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAXIMUM_BATCHES The default value for maximumBatches
static int	DEFAULT_TIME_BETWEEN_BATCHES The default value for timeBetweenBatches (1 hour).
static String	DOCUMENT_URI_FEATURE_DEFAULT_NAME The default feature name for obtaining document URIs (provided as features on documents).
static int	FORMAT_VERSION The current format version for the XML files containing serialisations of IndexConfig instances.

Constructor Summary

Constructors

Constructor and Description
IndexConfig(File indexDirectory, String tokenAnnotationSetName, String tokenAnnotationType, String semanticAnnotationSetName, IndexConfig.TokenIndexerConfig[] tokenIndexers, IndexConfig.SemanticIndexerConfig[] semanticIndexers, DocumentMetadataHelper[] docMetadataHelpers, DocumentRenderer documentRenderer) Constructs an index configuration object.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getContext() Gets the map used for passing values between the various pluggable elements in this index (such as annotation helpers).
DocumentMetadataHelper[]	getDocMetadataHelpers() Gets the array of document metadata helpers.
DocumentRenderer	getDocumentRenderer() Gets the renderer to be used for displaying documents and hits.
String	getDocumentUriFeatureName()
int	getFormatVersion()
File	getIndexDirectory() Gets the top level directory of an index.
int	getMaximumBatches() Gets the maximum number of on-disk index batches before an index compaction is triggered.
Map<String,String>	getOptions() Gets the options map - a Map with arbitrary configuration options, which is made available to all sub-elements of this index (e.g.
String	getSemanticAnnotationSetName() Gets the name of the annotation set containing semantic annotations.
IndexConfig.SemanticIndexerConfig[]	getSemanticIndexers() Gets the configuration for all the semantic annotation indexers used.
int	getTimeBetweenBatches() Gets the current value for the time interval (in milliseconds) between the saving of a batch and the next.
String	getTokenAnnotationSetName() Gets the name for the annotation set where token annotations can be found.
String	getTokenAnnotationType() Gets the annotation type to be used for obtaining tokens.
IndexConfig.TokenIndexerConfig[]	getTokenIndexers() Gets the configuration for all the token indexers used.
static IndexConfig	readConfigFromFile(File file) Loads an index config object from a file.
static IndexConfig	readConfigFromFile(File configFile, File indexDir) Loads an index config object from a file, but allows the caller to override the index directory stored in the file.
static IndexConfig	readConfigFromUrl(URL u) Loads an index config object from a URL.
static IndexConfig	readConfigFromUrl(URL configFile, File indexDir) Loads an index config object from a URL, but allows the caller to override the index directory stored in the file.
void	setDocumentRenderer(DocumentRenderer documentRenderer) Sets the renderer to be used for displaying documents and hits.
void	setDocumentUriFeatureName(String documentUriFeatureName)
void	setFormatVersion(int formatVersion) See FORMAT_VERSION.
void	setMaximumBatches(int maximumBatches) Sets the maximum number of on-disk index batches before an index compaction is triggered.
void	setTimeBetweenBatches(int timeBetweenBatches) Sets the current value for the time interval (in milliseconds) between the saving of a batch and the next.
static void	writeConfigToFile(IndexConfig config, File file) Saves an IndexConfig object to a file via XML serialisation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORMAT_VERSION

public static final int FORMAT_VERSION

The current format version for the XML files containing serialisations of IndexConfig instances. Version numbers:

4

First version number used. Indexes previous to this did not save their version.

5

Mimir indexes are now built with MG4J-big (64 bits).

6

Added support for direct indexes.

7

Mímir 5.0 live index.

8

Mímir 5.6 with upgraded MG4J dependencies.

See Also:

Constant Field Values

DOCUMENT_URI_FEATURE_DEFAULT_NAME

public static final String DOCUMENT_URI_FEATURE_DEFAULT_NAME

The default feature name for obtaining document URIs (provided as features on documents).

See Also:

Constant Field Values

DEFAULT_TIME_BETWEEN_BATCHES

public static final int DEFAULT_TIME_BETWEEN_BATCHES

The default value for timeBetweenBatches (1 hour).

See Also:

Constant Field Values

DEFAULT_MAXIMUM_BATCHES

public static final int DEFAULT_MAXIMUM_BATCHES

The default value for maximumBatches

See Also:

Constant Field Values

Constructor Detail

IndexConfig

public IndexConfig(File indexDirectory,
                   String tokenAnnotationSetName,
                   String tokenAnnotationType,
                   String semanticAnnotationSetName,
                   IndexConfig.TokenIndexerConfig[] tokenIndexers,
                   IndexConfig.SemanticIndexerConfig[] semanticIndexers,
                   DocumentMetadataHelper[] docMetadataHelpers,
                   DocumentRenderer documentRenderer)

Constructs an index configuration object.

Parameters:

indexDirectory - indexDirectory the top level directory to be used for storing the index.

tokenAnnotationSetName - the name for the annotation set where token annotations can be found. Use null for the default annotation set.

tokenAnnotationType - the type of annotations used as tokens.

semanticAnnotationSetName - the name for the annotation set where semantic annotations should be collected from.

tokenIndexers - an array of IndexConfig.TokenIndexerConfig values, describing the configuration for the indexing of each token feature.

semanticIndexers - an array of IndexConfig.SemanticIndexerConfig values, describing the the configuration for indexing semantic annotations.

Method Detail

getContext

public Map<String,Object> getContext()

Gets the map used for passing values between the various pluggable elements in this index (such as annotation helpers). The returned map is live, meaning that all changes made to it are available to all other clients requesting it.

Returns:

a Map, with String keys and arbitrary values.

getFormatVersion

public int getFormatVersion()

Returns:

the formatVersion See FORMAT_VERSION.

setFormatVersion

public void setFormatVersion(int formatVersion)

See FORMAT_VERSION.

Parameters:

formatVersion - the formatVersion to set

getIndexDirectory

public File getIndexDirectory()

Gets the top level directory of an index.

Returns:

a File object.

getTokenAnnotationType

public String getTokenAnnotationType()

Gets the annotation type to be used for obtaining tokens.

Returns:

an String object.

getTokenAnnotationSetName

public String getTokenAnnotationSetName()

Gets the name for the annotation set where token annotations can be found.

Returns:

the tokenAnnotationSet

getTokenIndexers

public IndexConfig.TokenIndexerConfig[] getTokenIndexers()

Gets the configuration for all the token indexers used.

Returns:

an array of IndexConfig.TokenIndexerConfig values.

getSemanticAnnotationSetName

public String getSemanticAnnotationSetName()

Gets the name of the annotation set containing semantic annotations.

Returns:

the semanticAnnotationSetName

getSemanticIndexers

public IndexConfig.SemanticIndexerConfig[] getSemanticIndexers()

Gets the configuration for all the semantic annotation indexers used.

Returns:

an array of IndexConfig.SemanticIndexerConfig values.

getTimeBetweenBatches

public int getTimeBetweenBatches()

Gets the current value for the time interval (in milliseconds) between the saving of a batch and the next. This is the maximum interval documents submitted for indexing are kept in RAM (and are thus not searcheable). Defaults to 3600000.

Returns:

setTimeBetweenBatches

public void setTimeBetweenBatches(int timeBetweenBatches)

Sets the current value for the time interval (in milliseconds) between the saving of a batch and the next. This is the maximum interval documents submitted for indexing are kept in RAM (and are thus not searcheable). Defaults to 3600000.

getMaximumBatches

public int getMaximumBatches()

Gets the maximum number of on-disk index batches before an index compaction is triggered. Defaults to 20.

Returns:

setMaximumBatches

public void setMaximumBatches(int maximumBatches)

Sets the maximum number of on-disk index batches before an index compaction is triggered. Defaults to DEFAULT_MAXIMUM_BATCHES.

Parameters:

maximumBatches -

getOptions

public Map<String,String> getOptions()

Gets the options map - a Map with arbitrary configuration options, which is made available to all sub-elements of this index (e.g. the various annotation helpers).

getDocumentRenderer

public DocumentRenderer getDocumentRenderer()

Gets the renderer to be used for displaying documents and hits.

Returns:

the documentRenderer

setDocumentRenderer

public void setDocumentRenderer(DocumentRenderer documentRenderer)

Sets the renderer to be used for displaying documents and hits.

Parameters:

documentRenderer - the documentRenderer to set

getDocMetadataHelpers

public DocumentMetadataHelper[] getDocMetadataHelpers()

Gets the array of document metadata helpers.

Returns:

the docMetadataHelpers

getDocumentUriFeatureName

public String getDocumentUriFeatureName()

Returns:

the documentUriFeatureName

setDocumentUriFeatureName

public void setDocumentUriFeatureName(String documentUriFeatureName)

Parameters:

documentUriFeatureName - the documentUriFeatureName to set

writeConfigToFile

public static void writeConfigToFile(IndexConfig config,
                                     File file)
                              throws IOException

Saves an IndexConfig object to a file via XML serialisation.

Parameters:

config - the object to be saved.

file - the file to write to.

Throws:

IOException

readConfigFromFile

public static IndexConfig readConfigFromFile(File file)
                                      throws IOException,
                                             IndexException

Loads an index config object from a file. The file should have been created using the writeConfigToFile(IndexConfig, File) method.

Parameters:

file - the file to read.

Returns:

an IndexConfig object.

Throws:

IOException - if the provided config file cannot be found.

IndexException - if the parsing of the config file fails.

readConfigFromUrl

public static IndexConfig readConfigFromUrl(URL u)
                                     throws IOException,
                                            IndexException

Loads an index config object from a URL. The file should have been created using the writeConfigToFile(IndexConfig, File) method.

Parameters:

u - the URL to read.

Returns:

an IndexConfig object.

Throws:

IOException - if the provided config file cannot be found.

IndexException - if the parsing of the config file fails.

readConfigFromFile

public static IndexConfig readConfigFromFile(File configFile,
                                             File indexDir)
                                      throws IOException,
                                             IndexException

Loads an index config object from a file, but allows the caller to override the index directory stored in the file. This is useful if the index was created on one machine but is being used on another.

Parameters:

configFile - the file to read

indexDir - the top-level index directory, which will be used instead of the value stored in the config file.

Throws:

FileNotFoundException - if the provided config file cannot be found.

IndexException - if the parsing of the config file fails.

IOException

readConfigFromUrl

public static IndexConfig readConfigFromUrl(URL configFile,
                                            File indexDir)
                                     throws IOException,
                                            IndexException

Loads an index config object from a URL, but allows the caller to override the index directory stored in the file. This is useful if the index was created on one machine but is being used on another.

Parameters:

configFile - the file to read

indexDir - the top-level index directory, which will be used instead of the value stored in the config file.

Throws:

FileNotFoundException - if the provided config file cannot be found.

IndexException - if the parsing of the config file fails.

IOException