Package org.meteoinfo.data.meteodata

Class Variable

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Variable

org.meteoinfo.data.meteodata.Variable

public class Variable
extends ucar.nc2.Variable

Nested Class Summary

Nested classes/interfaces inherited from class ucar.nc2.Variable

ucar.nc2.Variable.Cache

Field Summary

Fields

Modifier and Type	Field	Description
int	Number

Fields inherited from class ucar.nc2.CDMNode

annotations, dodsname, group, immutable, parentstruct, shortName, sort

Fields inherited from class ucar.nc2.Variable

attributes, cache, dataType, debugCaching, defaultCoordsSizeToCache, defaultSizeToCache, dimensions, elementSize, hashCode, isMetadata, isVariableLength, ncfile, permitCaching, proxyReader, shape, shapeAsSection, sizeToCache, spiObject

Constructor Summary

Constructors

Constructor	Description
Variable()	Constructor
Variable(int aNum, java.lang.String aName, java.lang.String aDesc, java.lang.String aUnit)	Constructor
Variable(ucar.nc2.Variable from)	Construct

Method Summary

Modifier and Type	Method	Description
void	addAttribute(java.lang.String attName, double attValue)	Add attribute
void	addAttribute(java.lang.String attName, java.lang.String attValue)	Add attribute
void	addAttribute(java.lang.String attName, java.util.List attValue)	Add attribute
void	addDimension(int idx, Dimension dim)	Add a dimension
void	addDimension(java.lang.String tstr, java.util.List<java.lang.Number> values)	Add a dimension
void	addDimension(Dimension dim)	Add a dimension
void	addDimension(DimensionType dType, java.util.List<java.lang.Number> values)	Add a dimension
void	addLevel(double levelValue)	Add a level
java.lang.Object	clone()	Clone
boolean	dimensionContains(Variable var)	If the dimensions contains the diemsions of another variable
boolean	dimensionEquales(Variable var)	If the dimensions equales with another variable
boolean	dimensionSizeEquals(Variable var)	If the dimensions size equales with another variable
boolean	equals(Variable aVar)	Determine if two parameter are equal
double	getAddOffset()	Get add offset
int	getAttNumber()	Get attribute number
int	getAttributeIndex(java.lang.String attName)	Get attribute index by name, return -1 if the name not exist.
java.lang.String	getAttributeString(java.lang.String attName)	Get attribute value string by name
java.lang.String	getDescription()	Get description
Dimension	getDimension(DimensionType dimType)	Get dimension by type
int[]	getDimIds()	Get dimension identifers
int	getDimIndex(Dimension aDim)	Get index of a dimension
int	getDimLength(int idx)	Get dimension length
int	getDimNumber()	Get dimension number
double	getFillValue()	Get fill value
java.lang.String	getHDFPath()	Get HDF path
Dimension	getLevelDimension(Variable var)	Get level dimension for SWATH data variable
java.util.List<java.lang.Integer>	getLevelIdxs()	Get level index list - for ARL data
int	getLevelNum()	Get level number
java.util.List<java.lang.Double>	getLevels()	Get levels
int	getLevelType()	Get level type
java.lang.String	getName()	Get name
double	getScaleFactor()	Get scale factor
Dimension	getTDimension()	Get T dimension
java.util.List<java.util.Date>	getTimes()	Get times
int	getTrueLevelNumber()	Get true level number
java.lang.String	getUnits()	Set units
int	getVarId()	Get variable identifer
java.util.List<java.lang.Integer>	getVarInLevelIdxs()	Get variable index in level index list - for ARL data
Dimension	getXDimension()	Get X dimension
Dimension	getYDimension()	Get Y dimension
Dimension	getZDimension()	Get Z dimension
boolean	hasDimension(int dimId)	Determine if the variable has a dimension
boolean	hasNullDimension()	If the variable has a null dimension
boolean	hasXtrackDimension()	Determine if has Xtrack dimension
boolean	isDimVar()	Get if the variable is dimension variable
boolean	isPlottable()	Get if the variable is plottable (has both X and Y dimension)
boolean	isStation()	Get if the variable is station data set
boolean	isSwath()	Get if the variable is swath data set
void	setAddOffset(double value)	Set add offset
void	setDescription(java.lang.String value)	Set description
void	setDimension(java.lang.String tstr, java.util.List<java.lang.Number> values, boolean reverse)	Set a dimension
void	setDimension(java.lang.String tstr, java.util.List<java.lang.Number> values, boolean reverse, int index)	Set a dimension
void	setDimension(Dimension aDim)	Set dimension
void	setDimension(Dimension aDim, int idx)	Set dimension
void	setDimension(Dimension aDim, DimensionType dimType)	Set dimension by dimension type
void	setDimVar(boolean value)	Set if the variable is dimension variable
void	setFillValue(double value)	Set fill value
void	setHDFPath(java.lang.String value)	Set HDF path
void	setLevelIdxs(java.util.List<java.lang.Integer> value)	Set level index list
void	setLevels(java.util.List<java.lang.Double> value)	Set levels
void	setLevelType(int value)	Set level type
java.lang.String	setName(java.lang.String value)	Set name
void	setScaleFactor(double value)	Set scale factor
void	setStation(boolean value)	Set if the variable is station data set
void	setSwath(boolean value)	Set if the variable is swath data set
void	setTDimension(Dimension value)	Set T dimension
void	setUnits(java.lang.String value)	Set units
void	setVarId(int value)	Set variable identifer
void	setVarInLevelIdxs(java.util.List<java.lang.Integer> value)	Set variable index in level index list - for ARL data
void	setXDimension(Dimension value)	Set X dimension
void	setYDimension(Dimension value)	Set Y dimension
void	setZDimension(Dimension value)	Set Z dimension
boolean	tEquals(Variable aVar)	Determine if two parameter are totally equal
java.util.List<ucar.nc2.Dimension>	toNCDimensions()	To netCDF dimensions
void	updateZDimension()	Update z dimension from levels

Methods inherited from class ucar.nc2.CDMNode

annotate, getAnnotation, getAnnotations, getDODSName, getFullName, getFullNameEscaped, getGroup, getImmutable, getParentStructure, getShortName, getSort, isMemberOfStructure, localhash, setDODSName, setImmutable, setParentStructure, setShortName, setSort, unwrap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class ucar.nc2.Variable

_read, _read, addAll, addAttribute, compareTo, copy, createNewCache, equals, extraInfo, findAttribute, findAttributeIgnoreCase, findDimensionIndex, getAttributes, getDAPName, getDAPName, getDatasetLocation, getDataType, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getElementSize, getEnumTypedef, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNetcdfFile, getParentGroup, getProxyReader, getRanges, getRank, getScalarData, getShape, getShape, getShapeAll, getShapeAsSection, getShapeNotScalar, getSize, getSizeToCache, getSPobject, getUnitsString, hasCachedData, hashCode, hashCodeShow, invalidateCache, isCaching, isCoordinateVariable, isImmutable, isMetadata, isScalar, isUnknownLength, isUnlimited, isUnsigned, isVariableLength, lookupEnumString, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, readToByteChannel, readToStream, reallyRead, reallyRead, reduce, remove, removeAttribute, removeAttributeIgnoreCase, resetDimensions, resetShape, section, section, setCachedData, setCachedData, setCaching, setDataType, setDimension, setDimensions, setDimensions, setDimensionsAnonymous, setElementSize, setEnumTypedef, setImmutable, setIsScalar, setParentGroup, setProxyReader, setSizeToCache, setSPobject, setUnsigned, setValues, setValues, slice, toString, toStringDebug, writeCDL, writeCDL

Methods inherited from interface ucar.nc2.VariableIF

getFullName, getFullNameEscaped, getParentStructure, getShortName, isMemberOfStructure

Field Detail

Number

public int Number

Constructor Detail

Variable

public Variable()

Constructor

Variable

public Variable(ucar.nc2.Variable from)

Construct

Parameters:

from - From variable

Variable

public Variable(int aNum,
                java.lang.String aName,
                java.lang.String aDesc,
                java.lang.String aUnit)

Constructor

Parameters:

aNum - Parameter number

aName - The name

aDesc - The description

aUnit - The units

Method Detail

getName

public java.lang.String getName()

Get name

Overrides:

getName in class ucar.nc2.CDMNode

Returns:

Name

setName

public java.lang.String setName(java.lang.String value)

Set name

Overrides:

setName in class ucar.nc2.Variable

Parameters:

value - Name

Returns:

getLevelType

public int getLevelType()

Get level type

Returns:

Level type

setLevelType

public void setLevelType(int value)

Set level type

Parameters:

value - Level type

getLevels

public java.util.List<java.lang.Double> getLevels()

Get levels

Returns:

Levels

setLevels

public void setLevels(java.util.List<java.lang.Double> value)

Set levels

Parameters:

value - Levels

getUnits

public java.lang.String getUnits()

Set units

Returns:

Units

setUnits

public void setUnits(java.lang.String value)

Set units

Parameters:

value - Units

getDescription

public java.lang.String getDescription()

Get description

Overrides:

getDescription in class ucar.nc2.Variable

Returns:

Description

setDescription

public void setDescription(java.lang.String value)

Set description

Parameters:

value - Description

getDimNumber

public int getDimNumber()

Get dimension number

Returns:

Dimension number

getLevelNum

public int getLevelNum()

Get level number

Returns:

Level number

getHDFPath

public java.lang.String getHDFPath()

Get HDF path

Returns:

HDF path

setHDFPath

public void setHDFPath(java.lang.String value)

Set HDF path

Parameters:

value - HDF path

getXDimension

public Dimension getXDimension()

Get X dimension

Returns:

X dimension

setXDimension

public void setXDimension(Dimension value)

Set X dimension

Parameters:

value - X dimension

getYDimension

public Dimension getYDimension()

Get Y dimension

Returns:

Y dimension

setYDimension

public void setYDimension(Dimension value)

Set Y dimension

Parameters:

value - Y dimension

getZDimension

public Dimension getZDimension()

Get Z dimension

Returns:

Z dimension

setZDimension

public void setZDimension(Dimension value)

Set Z dimension

Parameters:

value - Z dimension

getTDimension

public Dimension getTDimension()

Get T dimension

Returns:

T dimension

setTDimension

public void setTDimension(Dimension value)

Set T dimension

Parameters:

value - T dimension

getDimIds

public int[] getDimIds()

Get dimension identifers

Returns:

Dimension identifers

isStation

public boolean isStation()

Get if the variable is station data set

Returns:

Boolean

setStation

public void setStation(boolean value)

Set if the variable is station data set

Parameters:

value - Boolean

isSwath

public boolean isSwath()

Get if the variable is swath data set

Returns:

Boolean

setSwath

public void setSwath(boolean value)

Set if the variable is swath data set

Parameters:

value - Boolean

isPlottable

public boolean isPlottable()

Get if the variable is plottable (has both X and Y dimension)

Returns:

Boolean

getAttNumber

public int getAttNumber()

Get attribute number

Returns:

Attribute number

getVarId

public int getVarId()

Get variable identifer

Returns:

Variable identifer

setVarId

public void setVarId(int value)

Set variable identifer

Parameters:

value - Variable identifer

isDimVar

public boolean isDimVar()

Get if the variable is dimension variable

Returns:

Boolean

setDimVar

public void setDimVar(boolean value)

Set if the variable is dimension variable

Parameters:

value - Boolean

getLevelIdxs

public java.util.List<java.lang.Integer> getLevelIdxs()

Get level index list - for ARL data

Returns:

Level index list

setLevelIdxs

public void setLevelIdxs(java.util.List<java.lang.Integer> value)

Set level index list

Parameters:

value - Level index list

getVarInLevelIdxs

public java.util.List<java.lang.Integer> getVarInLevelIdxs()

Get variable index in level index list - for ARL data

Returns:

Variable index

setVarInLevelIdxs

public void setVarInLevelIdxs(java.util.List<java.lang.Integer> value)

Set variable index in level index list - for ARL data

Parameters:

value - Variable index

getFillValue

public double getFillValue()

Get fill value

Returns:

Fill value

setFillValue

public void setFillValue(double value)

Set fill value

Parameters:

value - Fill value

getScaleFactor

public double getScaleFactor()

Get scale factor

Returns:

Scale factor

setScaleFactor

public void setScaleFactor(double value)

Set scale factor

Parameters:

value - Scale factor

getAddOffset

public double getAddOffset()

Get add offset

Returns:

Add offset

setAddOffset

public void setAddOffset(double value)

Set add offset

Parameters:

value - Add offset

clone

public java.lang.Object clone()

Clone

Overrides:

clone in class java.lang.Object

Returns:

Parameter object

equals

public boolean equals(Variable aVar)

Determine if two parameter are equal

Parameters:

aVar - The variable

Returns:

If equal

tEquals

public boolean tEquals(Variable aVar)

Determine if two parameter are totally equal

Parameters:

aVar - The variable

Returns:

If equal

addLevel

public void addLevel(double levelValue)

Add a level

Parameters:

levelValue - Level value

getTrueLevelNumber

public int getTrueLevelNumber()

Get true level number

Returns:

True level number

getDimension

public Dimension getDimension(DimensionType dimType)

Get dimension by type

Parameters:

dimType - Dimension type

Returns:

Dimension

setDimension

public void setDimension(java.lang.String tstr,
                         java.util.List<java.lang.Number> values,
                         boolean reverse)

Set a dimension

Parameters:

tstr - Dimension type string

values - Dimension values

reverse - If is reverse

setDimension

public void setDimension(java.lang.String tstr,
                         java.util.List<java.lang.Number> values,
                         boolean reverse,
                         int index)

Set a dimension

Parameters:

tstr - Dimension type string

values - Dimension values

index - Index

reverse - If is reverse

setDimension

public void setDimension(Dimension aDim)

Set dimension

Parameters:

aDim - The dimension

setDimension

public void setDimension(Dimension aDim,
                         int idx)

Set dimension

Parameters:

aDim - The dimension

idx - Index

setDimension

public void setDimension(Dimension aDim,
                         DimensionType dimType)

Set dimension by dimension type

Parameters:

aDim - The dimension

dimType - Dimension type

getDimIndex

public int getDimIndex(Dimension aDim)

Get index of a dimension

Parameters:

aDim - The dimension

Returns:

Index

getDimLength

public int getDimLength(int idx)

Get dimension length

Parameters:

idx - Dimension index

Returns:

Dimension length

hasXtrackDimension

public boolean hasXtrackDimension()

Determine if has Xtrack dimension

Returns:

Boolean

hasDimension

public boolean hasDimension(int dimId)

Determine if the variable has a dimension

Parameters:

dimId - Dimension identifer

Returns:

Boolean

hasNullDimension

public boolean hasNullDimension()

If the variable has a null dimension

Returns:

Boolean

dimensionEquales

public boolean dimensionEquales(Variable var)

If the dimensions equales with another variable

Parameters:

var - Another variable

Returns:

Boolean

dimensionSizeEquals

public boolean dimensionSizeEquals(Variable var)

If the dimensions size equales with another variable

Parameters:

var - Another variable

Returns:

Boolean

dimensionContains

public boolean dimensionContains(Variable var)

If the dimensions contains the diemsions of another variable

Parameters:

var - Another variable

Returns:

Boolean

getLevelDimension

public Dimension getLevelDimension(Variable var)

Get level dimension for SWATH data variable

Parameters:

var - Variable

Returns:

Dimension

getTimes

public java.util.List<java.util.Date> getTimes()

Get times

Returns:

Times

getAttributeIndex

public int getAttributeIndex(java.lang.String attName)

Get attribute index by name, return -1 if the name not exist.

Parameters:

attName - Attribute name

Returns:

Attribute index

getAttributeString

public java.lang.String getAttributeString(java.lang.String attName)

Get attribute value string by name

Parameters:

attName - Attribute name

Returns:

Attribute value string

toNCDimensions

public java.util.List<ucar.nc2.Dimension> toNCDimensions()

To netCDF dimensions

Returns:

NC dimensions

addDimension

public void addDimension(Dimension dim)

Add a dimension

Parameters:

dim - Dimension

addDimension

public void addDimension(int idx,
                         Dimension dim)

Add a dimension

Parameters:

idx - Index

dim - Dimension

addDimension

public void addDimension(DimensionType dType,
                         java.util.List<java.lang.Number> values)

Add a dimension

Parameters:

dType - Dimension type

values - Dimension values

addDimension

public void addDimension(java.lang.String tstr,
                         java.util.List<java.lang.Number> values)

Add a dimension

Parameters:

tstr - Dimension type string

values - Dimension values

addAttribute

public void addAttribute(java.lang.String attName,
                         java.util.List attValue)

Add attribute

Parameters:

attName - Attribute name

attValue - Attribute value

addAttribute

public void addAttribute(java.lang.String attName,
                         java.lang.String attValue)

Add attribute

Parameters:

attName - Attribute name

attValue - Attribute value

addAttribute

public void addAttribute(java.lang.String attName,
                         double attValue)

Add attribute

Parameters:

attName - Attribute name

attValue - Attribute name

updateZDimension

public void updateZDimension()

Update z dimension from levels