Class ncsa.horizon.util.HorizonMetadata
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class ncsa.horizon.util.HorizonMetadata

java.lang.Object
   |
   +----java.util.Dictionary
           |
           +----java.util.Hashtable
                   |
                   +----ncsa.horizon.util.Metadata
                           |
                           +----ncsa.horizon.util.HorizonMetadata

public class HorizonMetadata
extends Metadata
a Metadata class with extra help to support the Horizon schema

Variable Index

 o aCoordinateSystem
 o horizonSchema
 o nativeSchema
 o naxes
 o SchemaSet
 o version
version of horizon schema supported by this object

Constructor Index

 o HorizonMetadata()
Construct a HorizonMetadata object for holding Viewable-level metadata.
 o HorizonMetadata(int)
Creates an empty metadatum list with defaults.
 o HorizonMetadata(int, Metadata)
Create a Metadata object describing a Viewable dataset with a given number of axes.
 o HorizonMetadata(Metadata, Metadata)
Creates an empty metadatum list with specified defaults.

Method Index

 o initMetadata(int)
 o setCoordinateSystem(Metadata)
set the Coordinate System metadata for a dataset
 o setCoordinateSystem(Metadata, Metadata)
set the Coordinate System metadata for a dataset
 o setNaxes(int)
set the number of axes for the dataset described by this Metadata
 o setNaxes(Metadata, int)
set the number of axes in a dataset

Variables

 o horizonSchema
  public final static String horizonSchema
 o version
  public final static String version
version of horizon schema supported by this object
 o aCoordinateSystem
  public final static String aCoordinateSystem
 o nativeSchema
  public final static String nativeSchema
 o SchemaSet
  public final static String SchemaSet
 o naxes
  public final static String naxes

Constructors

 o HorizonMetadata
  public HorizonMetadata()
Construct a HorizonMetadata object for holding Viewable-level metadata. The dataset will be assumed to have 1 axis
 o HorizonMetadata
  public HorizonMetadata(int nax,
                         Metadata defaults) throws ArrayIndexOutOfBoundsException
Create a Metadata object describing a Viewable dataset with a given number of axes.
Parameters:
nax - the number of axes in the dataset
defaults - the defaults (can be null)
Throws: ArrayIndexOutOfBoundsException
if naxes < 1
 o HorizonMetadata
  public HorizonMetadata(int nax) throws ArrayIndexOutOfBoundsException
Creates an empty metadatum list with defaults.
Parameters:
nax - the number of axes in the dataset
Throws: ArrayIndexOutOfBoundsException
if naxes < 1
 o HorizonMetadata
  public HorizonMetadata(Metadata viewableDefaults,
                         Metadata coordMetadata) throws ArrayIndexOutOfBoundsException
Creates an empty metadatum list with specified defaults.
Parameters:
viewableDefaults - the default dataset metadata; can be null;
coordMetadata - the coordinate system metadata; these will be saved under the primary (i.e. updatable) list with the name "CoordinateSystem"; can be null.
Throws: ArrayIndexOutOfBoundsException
if viewableDefaults contains a value for "naxes" that is < 1 or not specified.

Methods

 o initMetadata
  protected void initMetadata(int nax)
 o setNaxes
  public static void setNaxes(Metadata md,
                              int nax) throws ArrayIndexOutOfBoundsException
set the number of axes in a dataset
Parameters:
md - the metadata to update
nax - the number of axes
 o setNaxes
  public void setNaxes(int i) throws ArrayIndexOutOfBoundsException
set the number of axes for the dataset described by this Metadata
Parameters:
nax - the number of axes
 o setCoordinateSystem
  public static void setCoordinateSystem(Metadata md,
                                         Metadata coordmd)
set the Coordinate System metadata for a dataset
Parameters:
md - the metadata to update
coordmd - the Coordinate System metadata to insert
 o setCoordinateSystem
  public void setCoordinateSystem(Metadata coordmd)
set the Coordinate System metadata for a dataset
Parameters:
coordmd - the Coordinate System metadata to insert

All Packages  Class Hierarchy  This Package  Previous  Next  Index