de::aitools::aq::invertedindex::core::Configuration Class Reference

List of all members.

Classes
class	ConfigurationImpl
Public Types
enum	KeySorting { UNSORTED, SORTED }
enum	ValueSorting { DISABLED, ASCENDING, DESCENDING }
Public Member Functions
	Configuration ()
long	getExpectedNumberOfRecords ()
File	getIndexDirectory ()
File	getInputDirectory ()
KeySorting	getKeySorting ()
Memory	getMaxMemoryUsage ()
ValueSorting	getValueSorting ()
PrintStream	printTo (PrintStream stream)
void	setExpectedNumberOfRecords (long numberOfRecords)
void	setIndexDirectory (File indexDirectory)
void	setInputDirectory (File inputDirectory)
void	setKeySorting (KeySorting sorting)
void	setMaxMemoryUsage (Memory maxMemoryUsage)
void	setValueSorting (ValueSorting sorting)
Static Public Attributes
static final String	NATIVE_LIB = "aitools3-aq-invertedindex-1.2.6-jna"
Protected Attributes
ConfigurationImpl	impl

Detailed Description

A configuration class to setup instances of Indexer, ManagedIndexer and Searcher.

Author:: [email protected]

Version:

Id: Configuration.java,v 1.8 2011/07/18 03:18:52 trenkman Exp

Definition at line 19 of file Configuration.java.

Member Enumeration Documentation

enum de::aitools::aq::invertedindex::core::Configuration::KeySorting

Modes defining the sorting of keys.

Enumerator:

UNSORTED
SORTED

Definition at line 36 of file Configuration.java.

enum de::aitools::aq::invertedindex::core::Configuration::ValueSorting

Modes defining the sorting of values.

Enumerator:

DISABLED
ASCENDING
DESCENDING

Definition at line 41 of file Configuration.java.

Constructor & Destructor Documentation

de::aitools::aq::invertedindex::core::Configuration::Configuration ( ) [inline]

Creates a default configuration with setKeySorting(KeySorting) set to KeySorting#UNSORTED, setValueSorting(ValueSorting) set to ValueSorting#DISABLED, setMaxMemoryUsage(Memory) set to Memory#MB1024 and setInputDirectory(File) and setIndexDirectory(File) left empty.

Definition at line 53 of file Configuration.java.

References impl.

Member Function Documentation

long de::aitools::aq::invertedindex::core::Configuration::getExpectedNumberOfRecords ( ) [inline]

Returns the total number of records expected to be inserted.

Returns:: the total number of records

Definition at line 67 of file Configuration.java.

References impl.

Referenced by printTo().

Here is the caller graph for this function:

File de::aitools::aq::invertedindex::core::Configuration::getIndexDirectory ( ) [inline]

Returns the index directory.

Returns:: the path of the index directory

Definition at line 76 of file Configuration.java.

References impl.

Referenced by printTo().

Here is the caller graph for this function:

File de::aitools::aq::invertedindex::core::Configuration::getInputDirectory ( ) [inline]

Returns the input directory.

Returns:: the path of input directory

Definition at line 85 of file Configuration.java.

References impl.

Referenced by printTo().

Here is the caller graph for this function:

KeySorting de::aitools::aq::invertedindex::core::Configuration::getKeySorting ( ) [inline]

Returns the mode of the key sorting.

Returns:: the key sorting mode

Definition at line 94 of file Configuration.java.

References impl.

Referenced by printTo().

Here is the caller graph for this function:

Memory de::aitools::aq::invertedindex::core::Configuration::getMaxMemoryUsage ( ) [inline]

Returns the upper bound of memory to use.

Returns:: a constant specifying some amount of memory

Definition at line 103 of file Configuration.java.

References impl.

Referenced by printTo().

Here is the caller graph for this function:

ValueSorting de::aitools::aq::invertedindex::core::Configuration::getValueSorting ( ) [inline]

Returns the mode of the value sorting.

Returns:: the value sorting mode

Definition at line 112 of file Configuration.java.

References impl.

Referenced by printTo().

Here is the caller graph for this function:

PrintStream de::aitools::aq::invertedindex::core::Configuration::printTo ( PrintStream stream ) [inline]

Prints the content of this object in a human-readable form to the given PrintStream.

Parameters:

stream

the stream to print to

Returns:: the stream instance itself

Definition at line 123 of file Configuration.java.

References getExpectedNumberOfRecords(), getIndexDirectory(), getInputDirectory(), getKeySorting(), getMaxMemoryUsage(), and getValueSorting().

Here is the call graph for this function:

void de::aitools::aq::invertedindex::core::Configuration::setExpectedNumberOfRecords ( long numberOfRecords ) [inline]

Set the number of records expected to be inserted.

Parameters:

numberOfRecords

the total number of records

Definition at line 139 of file Configuration.java.

References impl.

Referenced by de::aitools::aq::invertedindex::usage::UsingIndexer::main(), and de::aitools::aq::invertedindex::core::TestIndexer::test().

Here is the caller graph for this function:

void de::aitools::aq::invertedindex::core::Configuration::setIndexDirectory ( File indexDirectory ) [inline]

Sets the index directory. In the case of Indexer and ManagedIndexer this directory specifies where the index has to be created. In the case of Searcher the index instance to load is expected in this directory.

Parameters:

indexDirectory

the path of the index directory

Definition at line 151 of file Configuration.java.

References impl.

Referenced by de::aitools::aq::invertedindex::usage::GoogleBooks::index(), de::aitools::aq::invertedindex::usage::UsingSearcher::main(), de::aitools::aq::invertedindex::usage::UsingManagedIndexer::main(), de::aitools::aq::invertedindex::usage::UsingIndexer::main(), de::aitools::aq::invertedindex::usage::SearcherTerminal::main(), and de::aitools::aq::invertedindex::core::TestIndexer::test().

Here is the caller graph for this function:

void de::aitools::aq::invertedindex::core::Configuration::setInputDirectory ( File inputDirectory ) [inline]

Sets the input directory. When using the ManagedIndexer for indexing this path specifies the location of the inverted files.

Parameters:

inputDirectory

the path of the input directory

Definition at line 162 of file Configuration.java.

References impl.

Referenced by de::aitools::aq::invertedindex::usage::UsingManagedIndexer::main().

Here is the caller graph for this function:

void de::aitools::aq::invertedindex::core::Configuration::setKeySorting ( KeySorting sorting ) [inline]

Sets the mode of the key sorting.

Parameters:

sorting

the key sorting mode

Definition at line 172 of file Configuration.java.

References impl.

Referenced by de::aitools::aq::invertedindex::usage::GoogleBooks::index(), de::aitools::aq::invertedindex::usage::UsingManagedIndexer::main(), and de::aitools::aq::invertedindex::usage::UsingIndexer::main().

Here is the caller graph for this function:

void de::aitools::aq::invertedindex::core::Configuration::setMaxMemoryUsage ( Memory maxMemoryUsage ) [inline]

Sets the maximal amount of memory the index is required to use during indexing. If Memory#MinRequired is specified the index tries best attempt to work with minimal footprint. In general a higher value can increase the indexing and/or search performance.

Parameters:

maxMemoryUsage

the maximal amount of memory to use

Definition at line 184 of file Configuration.java.

References impl.

Referenced by de::aitools::aq::invertedindex::usage::UsingManagedIndexer::main(), and de::aitools::aq::invertedindex::usage::UsingIndexer::main().

Here is the caller graph for this function: