org.corpus_tools.pepper.common

Enum DOCUMENT_STATUS

java.lang.Object

java.lang.Enum<DOCUMENT_STATUS>

org.corpus_tools.pepper.common.DOCUMENT_STATUS

All Implemented Interfaces:

Serializable, Comparable<DOCUMENT_STATUS>

public enum DOCUMENT_STATUS
extends Enum<DOCUMENT_STATUS>

This Enumeration shows the status of a more or less currently processed document. The several status act on three levels:

3. • means, mapping was successful
   • means, mapping was not successful and ended with an error
   • means, mapping was successful and Mapped object SDocument or SCorpus was deleted (for instance when merging objects, and no further processing of mapped object is necessary)

Author:

Florian Zipser

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETED
DELETED
FAILED
IN_PROGRESS
NOT_STARTED

Method Summary

Modifier and Type	Method and Description
String	getName() Returns a prosa name of the type
int	getValue() Returns the level of the object in level hierarchie.
static DOCUMENT_STATUS	valueOf(String name) Returns the enum constant of this type with the specified name.
static DOCUMENT_STATUS[]	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

NOT_STARTED

public static final DOCUMENT_STATUS NOT_STARTED

IN_PROGRESS

public static final DOCUMENT_STATUS IN_PROGRESS

COMPLETED

public static final DOCUMENT_STATUS COMPLETED

DELETED

public static final DOCUMENT_STATUS DELETED

FAILED

public static final DOCUMENT_STATUS FAILED

Method Detail

values

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

Returns:

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

valueOf

public static DOCUMENT_STATUS 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

getValue

public int getValue()

Returns the level of the object in level hierarchie.

Returns:

level

getName

public String getName()

Returns a prosa name of the type

Returns:

prosa name of the type