sgtplot.dm

Class SGTMetaData

java.lang.Object

sgtplot.dm.SGTMetaData

All Implemented Interfaces:

java.io.Serializable

public class SGTMetaData
extends java.lang.Object
implements java.io.Serializable

MetaData container for the sgtplot datamodel.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SGTMetaData() Default constructor.
SGTMetaData(java.lang.String name, java.lang.String units) SGTMetaData constructor.
SGTMetaData(java.lang.String name, java.lang.String units, boolean rev, boolean mod)

Method Summary

Modifier and Type	Method and Description
GeoDate	getModuloTime() Get temporal modulo value
double	getModuloValue() Get modulo value.
java.lang.String	getName() Get the name associated with the variable or coordinate.
java.util.Properties	getProperties() Get variable or coordinate additional properties.
java.lang.String	getProperty(java.lang.String key) Get property value given the key.
java.lang.String	getProperty(java.lang.String key, java.lang.String defValue) Get property value given the key, if key is not defined use the default value.
java.lang.String	getUnits() Get variable or coordinate units.
boolean	isModulo() Axis values are modulo.
boolean	isReversed() Axis values are reversed.
void	setModuloTime(GeoDate val) Set temporal modulo value.
void	setModuloValue(double val) Set the modulo value.
void	setName(java.lang.String name) Set name of coordinate or variable
void	setProperties(java.util.Properties props) Set additional properties for the coordinate or variable.
void	setProperty(java.lang.String key, java.lang.String value) Set a property for the variable or coordinate.
void	setUnits(java.lang.String units) Set units of coordinate or variable

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SGTMetaData

public SGTMetaData()

Default constructor.

SGTMetaData

public SGTMetaData(java.lang.String name,
                   java.lang.String units)

SGTMetaData constructor.

Parameters:

name - variable name

units - units of variable

SGTMetaData

public SGTMetaData(java.lang.String name,
                   java.lang.String units,
                   boolean rev,
                   boolean mod)

Method Detail

getName

public java.lang.String getName()

Get the name associated with the variable or coordinate.

isReversed

public boolean isReversed()

Axis values are reversed. This axis defines a left-hand coordinate system. For example, northward, eastward, downward, is left-handed.

isModulo

public boolean isModulo()

Axis values are modulo. For example, 0 and 360 longitude are equivalent values.

setModuloValue

public void setModuloValue(double val)

Set the modulo value. For example, 360 for longitude.

setModuloTime

public void setModuloTime(GeoDate val)

Set temporal modulo value. For example, 365 days, for yearly climatologies.

getModuloValue

public double getModuloValue()

Get modulo value.

getModuloTime

public GeoDate getModuloTime()

Get temporal modulo value

setName

public void setName(java.lang.String name)

Set name of coordinate or variable

setUnits

public void setUnits(java.lang.String units)

Set units of coordinate or variable

setProperties

public void setProperties(java.util.Properties props)

Set additional properties for the coordinate or variable.

getProperties

public java.util.Properties getProperties()

Get variable or coordinate additional properties.

getProperty

public java.lang.String getProperty(java.lang.String key)

Get property value given the key.

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defValue)

Get property value given the key, if key is not defined use the default value.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Set a property for the variable or coordinate.

getUnits

public java.lang.String getUnits()

Get variable or coordinate units.