org.gridfour.gvrs

Enum GvrsMnc

java.lang.Object

java.lang.Enum<GvrsMnc>

org.gridfour.gvrs.GvrsMnc

All Implemented Interfaces:

Serializable, Comparable<GvrsMnc>

public enum GvrsMnc
extends Enum<GvrsMnc>

Provides specifications for the GVRS predefined Metadata Naming Convention (MNC). The purpose of this enumeration is to support uniform and consistent specifications across all applications that use the GVRS file format.

This class is provided as a preliminary implementation to illustrate a concept of how a metadata standard could be facilitated. However, no such standard is established at this time. This class is provided with the hope that it will foster discussion and the eventual creation of a comprehensive metadata standard for GVRS. Ideally, this enumeration will specify a small set of standard metadata names and data types that would be recognized by most or all applications. Beyond that, applications would remain free to specify custom metadata definitions according to their own requirements.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Author Defines a specification for the author of a data set.
Copyright Defines a specification for copyrights.
Disclaimers A statement disclaiming liability or clarifying limitations of applicability..
GvrsCompressionCodecs Gets an ordered list of the names of the codecs used by the GvrsFile.
GvrsJavaCodecs Defined for use by the GVRS Java implementation for tracking data compression codecs.
TermsOfUse A statement giving conditions under which the producer released the associated product for use.
TIFF Defines a specification for bundling tags from the industry-standard Tagged Image File Format (TIFF) into a GVRS file.
WKT Defines a specification for bundling "Well Known Text" specifications from Geographic Information System (GIS) applications.

Method Summary

Modifier and Type	Method and Description
GvrsMetadataType	getDataType() Gets the data type associated with this instance.
String	getDescription() Gets the description associated with this enumeration value, if any.
GvrsMetadata	newInstance() Constructs a new instance of a GvrsMetadata with the name and data type specified by the enumeration.
GvrsMetadata	newInstance(int recordID) Constructs a new instance of a GvrsMetadata object with the name, data type, specified by the enumeration and the record ID assigned to it by the calling application.
static GvrsMnc	valueOf(String name) Returns the enum constant of this type with the specified name.
static GvrsMnc[]	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

Author

public static final GvrsMnc Author

Defines a specification for the author of a data set.

Copyright

public static final GvrsMnc Copyright

Defines a specification for copyrights. In general practice, it is possible for a data set to be published using multiple copyrights (such as copyrights for different nations).

When data is released in the public domain (without copyright control), application developers are encouraged to indicate that the data is free for use by marking a file with a notation such as "This data is in the public domain".

TermsOfUse

public static final GvrsMnc TermsOfUse

A statement giving conditions under which the producer released the associated product for use. May indicating restrictions on use, limitations of applicability, etc. For example: "Not intended for navigation");

Disclaimers

public static final GvrsMnc Disclaimers

A statement disclaiming liability or clarifying limitations of applicability..

TIFF

public static final GvrsMnc TIFF

Defines a specification for bundling tags from the industry-standard Tagged Image File Format (TIFF) into a GVRS file. By convention, the record ID used when creating GvrsTags for TIFF specifications should reflect the integer TIFF tag ID.

WKT

public static final GvrsMnc WKT

Defines a specification for bundling "Well Known Text" specifications from Geographic Information System (GIS) applications.

GvrsJavaCodecs

public static final GvrsMnc GvrsJavaCodecs

Defined for use by the GVRS Java implementation for tracking data compression codecs. Metadata included under this specification will include Java-specific information. Non-Java implementation should ignore metadata this specification.

GvrsCompressionCodecs

public static final GvrsMnc GvrsCompressionCodecs

Gets an ordered list of the names of the codecs used by the GvrsFile. This specification is intended to support compatibility across development environments and is not limited to Java.

Method Detail

values

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

Returns:

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

valueOf

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

getDataType

public GvrsMetadataType getDataType()

Gets the data type associated with this instance.

Returns:

a valid data type.

getDescription

public String getDescription()

Gets the description associated with this enumeration value, if any. Note that not all value have associated description strings.

Returns:

a valid String; potentially empty if not defined.

newInstance

public GvrsMetadata newInstance()

Constructs a new instance of a GvrsMetadata with the name and data type specified by the enumeration.

This method is suitable for use in cases where the name assigned to the new instance may be used for multiple metadata instances with the same name. For example, some data sources may carry multiple Author or Copyright specifications.

Returns:

a valid instance

newInstance

public GvrsMetadata newInstance(int recordID)

Constructs a new instance of a GvrsMetadata object with the name, data type, specified by the enumeration and the record ID assigned to it by the calling application.

Parameters:

recordID - an integer value uniquely identifying the metadata object to be constructed.

Returns:

a valid instance