de.aitools.aq.invertedindex.core
Class Properties

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

public final class Properties
extends java.lang.Object

Version:

$Id: Properties.java,v 1.1 2011/02/16 04:41:23 trenkman Exp $

Author:

martin.trenkmann@uni-weimar.de

Method Summary

long	getKeyCount() Returns the number of unique keys known by the index instance, that has returned this properties object.
long	getTotalSize() The total size in bytes of all values, indexed by the index instance, that has returned this properties object.
long	getValueCount() Returns the total number of values indexed by the index instance, that has returned this properties object.
Configuration.ValueSorting	getValueSorting() Returns the sorting of the postlist's values as specified in Configuration.setValueSorting(ValueSorting).
java.lang.String	getValueType() A string that represents the native value type of the index instance, that has returned this properties object.
int	getVersionNumber() Returns the internal version number of the this library.
java.io.PrintStream	printTo(java.io.PrintStream stream) Prints the content of this object in a human-readable form to the given PrintStream.

Methods inherited from class java.lang.Object

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

Method Detail

getKeyCount

public long getKeyCount()

Returns the number of unique keys known by the index instance, that has returned this properties object. This number is equal to the number of postlists stored in this index.

Returns:

the size of the index' vocabulary, which is the number of unique keys

getTotalSize

public long getTotalSize()

The total size in bytes of all values, indexed by the index instance, that has returned this properties object.

Returns:

the size in bytes of the index' payload

getValueCount

public long getValueCount()

Returns the total number of values indexed by the index instance, that has returned this properties object.

Returns:

the number of indexed values

getValueSorting

public Configuration.ValueSorting getValueSorting()

Returns the sorting of the postlist's values as specified in Configuration.setValueSorting(ValueSorting).

Returns:

the value sorting mode

getValueType

public java.lang.String getValueType()

A string that represents the native value type of the index instance, that has returned this properties object.

Returns:

a string with the native value type

getVersionNumber

public int getVersionNumber()

Returns the internal version number of the this library.

Returns:

a number that encodes the version of this library

printTo

public java.io.PrintStream printTo(java.io.PrintStream stream)

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