com.canto.cumulus.utils

Enum MetadataExchange.Format

java.lang.Object

java.lang.Enum<MetadataExchange.Format>

com.canto.cumulus.utils.MetadataExchange.Format

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MetadataExchange.Format>

Enclosing class:

MetadataExchange

public static enum MetadataExchange.Format
extends java.lang.Enum<MetadataExchange.Format>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUMULUS_5_LOCAL_ENCODING Deprecated format of previous Cumulus versions.
CUMULUS_5_UTF8 Deprecated format of previous Cumulus versions.
XML XML format.
XMP Special format to export the XMP data of a single record.

Method Summary

Methods

Modifier and Type	Method and Description
static MetadataExchange.Format	find(int id)
int	getID()
boolean	supportsFieldFilter()
static MetadataExchange.Format	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MetadataExchange.Format[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XML

public static final MetadataExchange.Format XML

XML format. Supports sub-tables and is the recommended format.

CUMULUS_5_LOCAL_ENCODING

public static final MetadataExchange.Format CUMULUS_5_LOCAL_ENCODING

Deprecated format of previous Cumulus versions. Should not be used as it does not support sub-tables and other features of Cumulus.

CUMULUS_5_UTF8

public static final MetadataExchange.Format CUMULUS_5_UTF8

Deprecated format of previous Cumulus versions. Should not be used as it does not support sub-tables and other features of Cumulus.

XMP

public static final MetadataExchange.Format XMP

Special format to export the XMP data of a single record. Do not use.

Method Detail

values

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

Returns:

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

valueOf

public static MetadataExchange.Format 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

getID

public int getID()

supportsFieldFilter

public boolean supportsFieldFilter()

find

public static MetadataExchange.Format find(int id)