GvrsMetadata (Core 1.0.2 API)

java.lang.Object
- org.gridfour.gvrs.GvrsMetadata

All Implemented Interfaces:

Comparable<GvrsMetadata>
```
public class GvrsMetadata
extends Object
implements Comparable<GvrsMetadata>
```
Provides definitions and elements for storing and reading metadata in a GVRS file.
The syntax for the application-defined ID string (the "name") must conform to the rules for the GVRS identifier:
1. The first character must be an upper or lowercase ASCII letter. This restriction is applied to support languages such as Python where an initial underscore indicates a special interpretation for an identifier.
2. A combination of ASCII characters including upper and lowercase letters, numeric digits, underscores.
Note: GVRS identifiers are intended to be consistent with naming conventions across a broad range of computer languages (including C/C++, Java, C#, and Python). So the allowable character set for identifiers is limited.
The limit to metadata name lengths is 32 characters.

Field Summary

Fields
Modifier and Type Field and Description

static int GVRS_METADATA_MAX_ID_LENGTH

Fields
Modifier and Type	Field and Description
`static int`	`GVRS_METADATA_MAX_ID_LENGTH`

Constructor Summary

Constructors
Constructor and Description
`GvrsMetadata(String name, GvrsMetadataType dataType)` Constructs a GVRS metadata instance with the specified data type, but no restriction for record ID.
`GvrsMetadata(String name, int recordID, GvrsMetadataType dataType)` Constructs a GVRS metadata instance with the specified parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(GvrsMetadata o)` Implements a comparison based on name and recordID, in that order.
`GvrsMetadataType`	`getDataType()` Gets the metadata type associated with this instanced.
`String`	`getDescription()` Gets the description string stored with the metadata.
`double`	`getDouble()`
`double[]`	`getDoubles()`
`int`	`getInteger()`
`int[]`	`getIntegers()`
`String`	`getName()` Gets the application-defined "name" for the record.
`int`	`getRecordID()` Gets the application-defined numerical ID associated with the record.
`short`	`getShort()`
`short[]`	`getShorts()`
`int`	`getStorageSize()` Gets the amount of storage space required to store the metadata, in bytes.
`String`	`getString()`
`int`	`getUnsignedShort()`
`int[]`	`getUnsignedShorts()`
`void`	`setDescription(String description)` Sets an optional description string.
`void`	`setDouble(double value)`
`void`	`setDoubles(double[] values)`
`void`	`setInteger(int value)`
`void`	`setIntegers(int[] values)`
`void`	`setShort(short value)`
`void`	`setShorts(short[] values)`
`void`	`setString(String string)`
`void`	`setUnsignedShort(int value)`
`void`	`setUnsignedShorts(int[] values)`
`void`	`setUnsignedShorts(short[] values)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - GVRS_METADATA_MAX_ID_LENGTH
```
public static final int GVRS_METADATA_MAX_ID_LENGTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GvrsMetadata
```
public GvrsMetadata(String name,
                    int recordID,
                    GvrsMetadataType dataType)
```
    Constructs a GVRS metadata instance with the specified parameters. This constructor is intended for specifying a unique metadata instances. A GVRS file may contain one, and only one, metadata record with a specific name and record ID.
    
    Parameters:
    
    name - an application-defined ID string
    
    recordID - an application-defined numeric ID
    
    dataType - the datatype for the metadata.
  - GvrsMetadata
```
public GvrsMetadata(String name,
                    GvrsMetadataType dataType)
```
    Constructs a GVRS metadata instance with the specified data type, but no restriction for record ID. This constructor may be used when a application intends to store multiple metadata records with the same name.
    The syntax for the application-defined ID string (the "name") must conform to the rules for the GVRS identifier (see class notes above)
    
    Parameters:
    
    name - an application-defined ID string conforming to the rules for GVRS identifiers.
    
    dataType - the datatype for the metadata.
- Method Detail
  - setDescription
```
public void setDescription(String description)
```
    Sets an optional description string.
    
    Parameters:
    
    description - a valid string with an UTF-8 encoding.
  - getDataType
```
public GvrsMetadataType getDataType()
```
    Gets the metadata type associated with this instanced.
    
    Returns:
    
    a valid enumeration instance.
  - getDescription
```
public String getDescription()
```
    Gets the description string stored with the metadata.
    
    Returns:
    
    if set, a valid string with a UTF-8 encoding; otherwise, a null.
  - getStorageSize
```
public int getStorageSize()
```
    Gets the amount of storage space required to store the metadata, in bytes.
    
    Returns:
    
    a positive value, in bytes.
  - setInteger
```
public void setInteger(int value)
```
  - getInteger
```
public int getInteger()
```
  - setIntegers
```
public void setIntegers(int[] values)
```
  - getIntegers
```
public int[] getIntegers()
```
  - setShort
```
public void setShort(short value)
```
  - getShort
```
public short getShort()
```
  - setShorts
```
public void setShorts(short[] values)
```
  - getShorts
```
public short[] getShorts()
```
  - setDouble
```
public void setDouble(double value)
```
  - getDouble
```
public double getDouble()
```
  - setDoubles
```
public void setDoubles(double[] values)
```
  - getDoubles
```
public double[] getDoubles()
```
  - setString
```
public void setString(String string)
```
  - getString
```
public String getString()
```
  - setUnsignedShort
```
public void setUnsignedShort(int value)
```
  - getUnsignedShort
```
public int getUnsignedShort()
```
  - setUnsignedShorts
```
public void setUnsignedShorts(short[] values)
```
  - setUnsignedShorts
```
public void setUnsignedShorts(int[] values)
```
  - getUnsignedShorts
```
public int[] getUnsignedShorts()
```
  - getName
```
public String getName()
```
    Gets the application-defined "name" for the record.
    
    Returns:
    
    a valid, non-empty string.
  - getRecordID
```
public int getRecordID()
```
    Gets the application-defined numerical ID associated with the record.
    
    Returns:
    
    a positive value in the range of an integer
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(GvrsMetadata o)
```
    Implements a comparison based on name and recordID, in that order.
    
    Specified by:
    
    compareTo in interface Comparable<GvrsMetadata>
    
    Parameters:
    
    o - a valid instance
    
    Returns:
    
    an integer value following the general contract of Java's compareTo specification.

Class GvrsMetadata

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GVRS_METADATA_MAX_ID_LENGTH

Constructor Detail

GvrsMetadata

GvrsMetadata

Method Detail

setDescription

getDataType

getDescription

getStorageSize

setInteger

getInteger

setIntegers

getIntegers

setShort

getShort

setShorts

getShorts

setDouble

getDouble

setDoubles

getDoubles

setString

getString

setUnsignedShort

getUnsignedShort

setUnsignedShorts

setUnsignedShorts

getUnsignedShorts

getName

getRecordID

toString

compareTo