org.kit.furia.index
Enum AbstractIRIndex.FieldName

java.lang.Object
  java.lang.Enum<AbstractIRIndex.FieldName>
      org.kit.furia.index.AbstractIRIndex.FieldName

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AbstractIRIndex.FieldName>

Enclosing class:

AbstractIRIndex<O extends org.ajmm.obsearch.OB>

protected static enum AbstractIRIndex.FieldName
extends java.lang.Enum<AbstractIRIndex.FieldName>

Lucene has the concepts of fields of a document. They are analogous to columns of a DB table (SQL). This enumeration lists the name of the fields our IRIndex will use.

Enum Constant Summary

DOC_DETAILS

DOC_NAME

MULTI_SET_SIZE

SET_SIZE

WORDS

Method Summary

static AbstractIRIndex.FieldName	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AbstractIRIndex.FieldName[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WORDS

public static final AbstractIRIndex.FieldName WORDS

DOC_NAME

public static final AbstractIRIndex.FieldName DOC_NAME

MULTI_SET_SIZE

public static final AbstractIRIndex.FieldName MULTI_SET_SIZE

DOC_DETAILS

public static final AbstractIRIndex.FieldName DOC_DETAILS

SET_SIZE

public static final AbstractIRIndex.FieldName SET_SIZE

Method Detail

values

public static AbstractIRIndex.FieldName[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AbstractIRIndex.FieldName c : AbstractIRIndex.FieldName.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AbstractIRIndex.FieldName valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null