gov.nasa.gsfc.spdf.cdfj

Interface CDFMeta

All Known Subinterfaces:

CDF2, CDF3, CDFCore

public interface CDFMeta

Interface that defines methods for getting attributes, variable characteristics

Method Summary

Modifier and Type	Method and Description
double[]	get1D(java.lang.String varName) Returns values of a numeric variable whose values can be converted to double without loss of precision as double[].If variable is non-numeric, or of type long a Throwable is thrown.
java.lang.Object	get1D(java.lang.String varName, boolean preserve) Returns value of a variable as a one dimensional array.returns, as double[], values of a numeric variable whose values can be converted to double without loss of precision; returns, as byte[], values of a string variable; returns, as long[], values of a long variable for preserve = true, and as double[] otherwise.
byte[]	get1D(java.lang.String varName, java.lang.Boolean stringType) Returns values of a string variable as byte[].If variable is numeric, a Throwable is thrown.
java.lang.Object	get1D(java.lang.String varName, int point) Returns value of 1 dimensional variable at the specified point.
java.lang.Object	get1D(java.lang.String varName, int first, int last) Returns values of 1 dimensional variable for the specified range of points.
java.lang.Object	getAttribute(java.lang.String atr) Returns value of the named global attribute.
java.lang.Object	getAttribute(java.lang.String vname, java.lang.String aname) Returns value of the named attribute for specified variable.
java.util.Vector	getAttributeEntries(java.lang.String attribute)
java.util.Vector	getAttributeEntries(java.lang.String vname, java.lang.String attribute)
java.nio.ByteOrder	getByteOrder() Returns ByteOrder.LITTLE_ENDIAN, or ByteOrder.BIG_ENDIAN depending the CDF encoding
GlobalAttribute	getGlobalAttribute(java.lang.String atr) Returns the GlobalAttribute object for the named global attribute.
VariableMetaData	getVariable(java.lang.String name) Returns the object that implements the Variable interface for the named variable
java.lang.String[]	getVariableNames() Returns names of variables in the CDF
java.lang.String[]	getVariableNames(java.lang.String type) Returns names of variables of given VAR_TYPE in the CDF
java.lang.String[]	globalAttributeNames() Returns names of global attributes.
boolean	isCompatible(java.lang.String vname, java.lang.Class cl) Returns whether value of the given variable can be cast to the specified type without loss of precision
boolean	rowMajority() Returns whether the arrays are stored in row major order in the source
java.lang.String[]	variableAttributeNames(java.lang.String name) Returns names of attributes of the given variable.

Method Detail

getByteOrder

java.nio.ByteOrder getByteOrder()

Returns ByteOrder.LITTLE_ENDIAN, or ByteOrder.BIG_ENDIAN depending the CDF encoding

Returns:

rowMajority

boolean rowMajority()

Returns whether the arrays are stored in row major order in the source

Returns:

getVariableNames

java.lang.String[] getVariableNames()

Returns names of variables in the CDF

Returns:

getVariable

VariableMetaData getVariable(java.lang.String name)

Returns the object that implements the Variable interface for the named variable

Parameters:

name -

Returns:

getVariableNames

java.lang.String[] getVariableNames(java.lang.String type)

Returns names of variables of given VAR_TYPE in the CDF

Parameters:

type -

Returns:

globalAttributeNames

java.lang.String[] globalAttributeNames()

Returns names of global attributes.

Returns:

variableAttributeNames

java.lang.String[] variableAttributeNames(java.lang.String name)

Returns names of attributes of the given variable.

Parameters:

name -

Returns:

getAttribute

java.lang.Object getAttribute(java.lang.String atr)

Returns value of the named global attribute.

For a character string attribute, a Vector of String is returned For a numeric attribute, a long[] is returned for long type; double[] is returned for all other numeric types.

Parameters:

atr -

Returns:

getGlobalAttribute

GlobalAttribute getGlobalAttribute(java.lang.String atr)
                            throws java.lang.Throwable

Returns the GlobalAttribute object for the named global attribute.

Parameters:

atr -

Returns:

Throws:

java.lang.Throwable

getAttribute

java.lang.Object getAttribute(java.lang.String vname,
                              java.lang.String aname)

Returns value of the named attribute for specified variable.

For a character string attribute, a String[] is returned For a numeric attribute, a long[] is returned for long type; double[] is returned for all other numeric types.

Parameters:

vname -

aname -

Returns:

isCompatible

boolean isCompatible(java.lang.String vname,
                     java.lang.Class cl)
              throws java.lang.Throwable

Returns whether value of the given variable can be cast to the specified type without loss of precision

Parameters:

vname -

cl -

Returns:

Throws:

java.lang.Throwable

get1D

double[] get1D(java.lang.String varName)
        throws java.lang.Throwable

Returns values of a numeric variable whose values can be converted to double without loss of precision as double[].If variable is non-numeric, or of type long a Throwable is thrown.

Parameters:

varName -

Returns:

Throws:

java.lang.Throwable

get1D

byte[] get1D(java.lang.String varName,
             java.lang.Boolean stringType)
      throws java.lang.Throwable

Returns values of a string variable as byte[].If variable is numeric, a Throwable is thrown.

Parameters:

varName -

stringType -

Returns:

Throws:

java.lang.Throwable

get1D

java.lang.Object get1D(java.lang.String varName,
                       boolean preserve)
                throws java.lang.Throwable

Returns value of a variable as a one dimensional array.returns, as double[], values of a numeric variable whose values can be converted to double without loss of precision; returns, as byte[], values of a string variable; returns, as long[], values of a long variable for preserve = true, and as double[] otherwise.

Parameters:

varName -

preserve -

Returns:

Throws:

java.lang.Throwable

get1D

java.lang.Object get1D(java.lang.String varName,
                       int point)
                throws java.lang.Throwable

Returns value of 1 dimensional variable at the specified point.

Parameters:

varName -

point -

Returns:

Throws:

java.lang.Throwable

get1D

java.lang.Object get1D(java.lang.String varName,
                       int first,
                       int last)
                throws java.lang.Throwable

Returns values of 1 dimensional variable for the specified range of points.

Parameters:

varName - name of the variable

first - record number of first point of range

last - record number of first point of range

Returns:

Throws:

java.lang.Throwable

getAttributeEntries

java.util.Vector getAttributeEntries(java.lang.String attribute)
                              throws java.lang.Throwable

Parameters:

attribute -

Returns:

Throws:

java.lang.Throwable

getAttributeEntries

java.util.Vector getAttributeEntries(java.lang.String vname,
                                     java.lang.String attribute)

Parameters:

vname -

attribute -

Returns: