de.aitools.aq.invertedindex.core
Class ManagedIndexer

java.lang.Object
  de.aitools.aq.invertedindex.core.ManagedIndexer

public final class ManagedIndexer
extends java.lang.Object

A class to build an inverted index from inverted file(s). The created index is static and read-only.

Version:

$Id: ManagedIndexer.java,v 1.2 2011/02/16 05:34:36 trenkman Exp $

Author:

martin.trenkmann@uni-weimar.de

Constructor Summary

ManagedIndexer()

Method Summary

static <V extends Value> Properties

index(java.lang.Class<V> clazz, Configuration config) Builds an inverted index from pseudo or real inverted files whose value type is defined by the generic parameter <V>, which is some derivative of Value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedIndexer

public ManagedIndexer()

Method Detail

index

public static final <V extends Value> Properties index(java.lang.Class<V> clazz,
                                                       Configuration config)

Builds an inverted index from pseudo or real inverted files whose value type is defined by the generic parameter <V>, which is some derivative of Value.

Please read the documentation according to the type of your input files to setup the Configuration object properly. There are also some limitations compared to indexing with Indexer to keep in mind.

• Unicode in the inverted files is not supported.
• Any whitespaces in the inverted files are interpreted as delimiters. Accordingly whitespaces within key strings or value strings (i.e. IntString) are not allowed.

The configuration parameter required for this job are:

• Configuration.setIndexDirectory(java.io.File)
• Configuration.setInputDirectory(java.io.File)
• Configuration.setKeySorting(KeySorting) (leave blank if unsure)
• Configuration.setValueSorting(ValueSorting) (disabled by default)

Type Parameters:

V - the value type parameter

Parameters:

clazz - the class object of the value type

config - the indexing job configuration

Returns:

a Properties object with some information about the created index.