it.unimi.di.mg4j.document
Enum AbstractDocumentCollection.PropertyKeys

java.lang.Object
  java.lang.Enum<AbstractDocumentCollection.PropertyKeys>
      it.unimi.di.mg4j.document.AbstractDocumentCollection.PropertyKeys

All Implemented Interfaces:

Serializable, Comparable<AbstractDocumentCollection.PropertyKeys>

Enclosing class:

AbstractDocumentCollection

public static enum AbstractDocumentCollection.PropertyKeys
extends Enum<AbstractDocumentCollection.PropertyKeys>

Symbolic names for common properties of a DocumentCollection.

Enum Constant Summary

COLLECTIONCLASS
The name of the DocumentCollection class.

DOCUMENTS
The number of documents in the collection.

NONTERMS
The number of nonterms in the collection, or -1 if this collection does not contain nonterms.

TERMS
The number of terms in the collection.

Method Summary

static AbstractDocumentCollection.PropertyKeys	valueOf(String name) Returns the enum constant of this type with the specified name.
static AbstractDocumentCollection.PropertyKeys[]	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

DOCUMENTS

public static final AbstractDocumentCollection.PropertyKeys DOCUMENTS

The number of documents in the collection.

TERMS

public static final AbstractDocumentCollection.PropertyKeys TERMS

The number of terms in the collection.

NONTERMS

public static final AbstractDocumentCollection.PropertyKeys NONTERMS

The number of nonterms in the collection, or -1 if this collection does not contain nonterms.

COLLECTIONCLASS

public static final AbstractDocumentCollection.PropertyKeys COLLECTIONCLASS

The name of the DocumentCollection class.

Method Detail

values

public static AbstractDocumentCollection.PropertyKeys[] 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 (AbstractDocumentCollection.PropertyKeys c : AbstractDocumentCollection.PropertyKeys.values())
    System.out.println(c);

Returns:

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

valueOf

public static AbstractDocumentCollection.PropertyKeys valueOf(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:

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

NullPointerException - if the argument is null