textractor.mg4j.document
Enum ConfigurableTextractorDocumentFactory.MetadataKeys

java.lang.Object
  java.lang.Enum<ConfigurableTextractorDocumentFactory.MetadataKeys>
      textractor.mg4j.document.ConfigurableTextractorDocumentFactory.MetadataKeys

All Implemented Interfaces:

Serializable, Comparable<ConfigurableTextractorDocumentFactory.MetadataKeys>

Enclosing class:

ConfigurableTextractorDocumentFactory

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

Case-insensitive keys for metadata passed to DocumentFactory.getDocument( java.io.InputStream,it.unimi.dsi.fastutil.objects.Reference2ObjectMap).

The keys in this class are general-purpose keys that are meaningful for most factories. Specific factory implementations might choose to interpret more keys, but then it is up to the DocumentSequence that uses the factory to provide data for those keys.

Enum Constant Summary

CONFIGURATION_FILE
Name of the property file used to configure the factory.

Method Summary

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

CONFIGURATION_FILE

public static final ConfigurableTextractorDocumentFactory.MetadataKeys CONFIGURATION_FILE

Name of the property file used to configure the factory.

Method Detail

values

public static ConfigurableTextractorDocumentFactory.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 (ConfigurableTextractorDocumentFactory.MetadataKeys c : ConfigurableTextractorDocumentFactory.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 ConfigurableTextractorDocumentFactory.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