it.unimi.di.mg4j.document
Enum DispatchingDocumentFactory.MetadataKeys

java.lang.Object
  java.lang.Enum<DispatchingDocumentFactory.MetadataKeys>
      it.unimi.di.mg4j.document.DispatchingDocumentFactory.MetadataKeys

All Implemented Interfaces:

Serializable, Comparable<DispatchingDocumentFactory.MetadataKeys>

Enclosing class:

DispatchingDocumentFactory

public static enum DispatchingDocumentFactory.MetadataKeys
extends Enum<DispatchingDocumentFactory.MetadataKeys>

Case-insensitive keys for metadata.

See Also:

PropertyBasedDocumentFactory.MetadataKeys

Enum Constant Summary

FIELDNAME
The property containing the (comma-separated) sequence of field names.

KEY
The property containing the key that should be checked (e.g., mimetype).

MAP
The property containing a comma-separated list with as many items as there are factories; each item will be a colon-separated list of as many integers as there are fields.

RULE
The property containing comma-separated sequence of colon-separated pairs value/document factory names.

Method Summary

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

FIELDNAME

public static final DispatchingDocumentFactory.MetadataKeys FIELDNAME

The property containing the (comma-separated) sequence of field names.

KEY

public static final DispatchingDocumentFactory.MetadataKeys KEY

The property containing the key that should be checked (e.g., mimetype).

RULE

public static final DispatchingDocumentFactory.MetadataKeys RULE

The property containing comma-separated sequence of colon-separated pairs value/document factory names.

MAP

public static final DispatchingDocumentFactory.MetadataKeys MAP

The property containing a comma-separated list with as many items as there are factories; each item will be a colon-separated list of as many integers as there are fields. The k-th integer in the f-th list is the number of the field of the f-th factory that should be used to extract field number k, or -1 if the field should be empty.

Method Detail

values

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

Returns:

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

valueOf

public static DispatchingDocumentFactory.MetadataKeys 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