gov.nasa.gsfc.spdf.cdfj

Class MetaData

java.lang.Object

gov.nasa.gsfc.spdf.cdfj.MetaData

Direct Known Subclasses:

GenericReader

public abstract class MetaData
extends java.lang.Object

Abstract base class for GenericReader. Provides methods to access CDF properties, global attributes, variable properties and attributes.

Constructor Summary

Constructors

Constructor and Description
MetaData()

Method Summary

Modifier and Type	Method and Description
boolean	existsVariable(java.lang.String varName) Returns whether there is a variable with the given name.
java.lang.Object	getAttribute(java.lang.String atr) Returns value of the first entry for the named global attribute.
java.lang.Object	getAttribute(java.lang.String varName, java.lang.String aname) Returns value of the named attribute for specified variable.For a character string attribute, a Vector of String is returned.For a numeric attribute, a Vector of size 1 is returned.The single element of the Vector is a long[] if attribute's type is long; For all other numeric types, the element is a double[].
java.util.Vector<AttributeEntry>	getAttributeEntries(java.lang.String aname) Returns list of AttributeEntry objects for the named global attribute.
java.util.Vector<AttributeEntry>	getAttributeEntries(java.lang.String varName, java.lang.String aname) Returns list of AttributeEntry objects for the named attribute for the named variable.
int	getBlockingFactor(java.lang.String varName) Returns the blocking factor used to compress this variable.See the CDF User's Guide for details.
java.nio.ByteOrder	getByteOrder() Returns ByteOrder.LITTLE_ENDIAN, or ByteOrder.BIG_ENDIAN depending the CDF encoding
int	getDataItemSize(java.lang.String varName) Returns size of a data item for the given variable.
int[]	getDimensions(java.lang.String varName) Returns dimensions the given variable.
int[]	getEffectiveDimensions(java.lang.String varName) Returns effective dimensions of the given variable.Dimensions for which dimVarys is false are ignored.
int	getEffectiveRank(java.lang.String varName) Returns effective rank of this variable.Dimensions for which dimVarys is false do not count.
java.util.Vector<java.lang.Integer>	getElementCount(java.lang.String varName) Return element count for this variable's dimensions.
GlobalAttribute	getGlobalAttribute(java.lang.String atr) Returns GlobalAttribute object for the named global attribute.
int	getLastLeapSecondId() Identifies the leap second table used in creating this CDF.Returns the id of the last leap second in the leap second table.
int	getNumber(java.lang.String varName) Returns given variable's number property.
int	getNumberOfElements(java.lang.String varName) Returns given variable's 'number of elements' property.
int	getNumberOfValues(java.lang.String varName) Returns 'number of values' property of the given variable.
java.lang.Object	getPadValue(java.lang.String varName) Returns 'pad value' property of the given variable.
java.lang.Object	getPadValue(java.lang.String varName, boolean preservePrecision) Returns 'pad value' property of the given variable subject to the given precision preservation constraint.
int[]	getRecordRange(java.lang.String varName) Returns record range for this variable
java.lang.String	getTimeVariableName(java.lang.String varName) Returns the name of the time variable for the given variable.
int	getType(java.lang.String varName) Returns CDF type of the variable.
java.lang.String[]	getVariableNames() Returns names of variables in the CDF
java.lang.String[]	getVariableNames(java.lang.String type) returns variable names of a given VAR_TYPE in a String[]
boolean[]	getVarys(java.lang.String varName) Returns 'varys' property of the given variable.
int	globalAttributeEntryCount(java.lang.String atr) Returns number of entries for the named global attribute.
java.lang.String[]	globalAttributeNames() Returns names of global attributes.
boolean	isCompatible(java.lang.String varName, java.lang.Class cl) returns whether conversion of this variable to type specified by cl is supported while preserving precision.
boolean	isCompatible(java.lang.String varName, java.lang.Class cl, boolean preserve) Returns whether conversion of this variable to type specified by cl is supported under the given precision preserving constraint.
boolean	isCompressed(java.lang.String varName) Returns whether the values of the variable are represented in a compressed form in the CDF.For variables declared to be compressed, CDF specification allows the values to be stored in uncompressed form if the latter results in a smaller size.
boolean	isMissingRecords(java.lang.String varName) Shows whether one or more records (in the range returned by getRecordRange()) are missing.
boolean	isTimeType(java.lang.String varName) Returns whether the given variable represents time.
boolean	isTypeR(java.lang.String varName) Returns whether a variable of type r-variable..See the CDF User's Guide for details.
boolean	missingRecordValueIsPad(java.lang.String varName) Return whether the missing record should be assigned the pad value.
boolean	missingRecordValueIsPrevious(java.lang.String varName) Return whether the missing record should be assigned the last seen value.If none has been seen, pad value is assigned.
boolean	recordVariance(java.lang.String varName) Returns an indication of the record varying property of a variable.
boolean	rowMajority() Returns whether the arrays are stored in row major order in the source
abstract java.lang.String	userTimeVariableName(java.lang.String varName)
java.lang.String[]	variableAttributeNames(java.lang.String name) Returns names of variable attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaData

public MetaData()

Method Detail

getByteOrder

public final java.nio.ByteOrder getByteOrder()

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

Returns:

rowMajority

public final boolean rowMajority()

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

Returns:

getVariableNames

public final java.lang.String[] getVariableNames()

Returns names of variables in the CDF

Returns:

getVariableNames

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

returns variable names of a given VAR_TYPE in a String[]

Parameters:

type -

Returns:

globalAttributeNames

public final java.lang.String[] globalAttributeNames()

Returns names of global attributes.

Returns:

variableAttributeNames

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

Returns names of variable attributes.

Parameters:

name -

Returns:

getAttribute

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

Returns value of the first entry for the named global attribute.

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.

This method is deprecated. Use getGlobalAttribute(String atr) method to extract all entries.

Parameters:

atr -

Returns:

globalAttributeEntryCount

public final int globalAttributeEntryCount(java.lang.String atr)
                                    throws CDFException.ReaderError

Returns number of entries for the named global attribute.

Parameters:

atr -

Returns:

Throws:

CDFException.ReaderError

getAttribute

public final java.lang.Object getAttribute(java.lang.String varName,
                                           java.lang.String aname)
                                    throws CDFException.ReaderError

Returns value of the named attribute for specified variable.For a character string attribute, a Vector of String is returned.For a numeric attribute, a Vector of size 1 is returned.The single element of the Vector is a long[] if attribute's type is long; For all other numeric types, the element is a double[].

Parameters:

varName -

aname -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getAttributeEntries

public final java.util.Vector<AttributeEntry> getAttributeEntries(java.lang.String varName,
                                                                  java.lang.String aname)
                                                           throws CDFException.ReaderError

Returns list of AttributeEntry objects for the named attribute for the named variable.

Parameters:

varName -

aname -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getAttributeEntries

public final java.util.Vector<AttributeEntry> getAttributeEntries(java.lang.String aname)
                                                           throws CDFException.ReaderError

Returns list of AttributeEntry objects for the named global attribute.

Parameters:

aname -

Returns:

Throws:

CDFException.ReaderError

getGlobalAttribute

public final GlobalAttribute getGlobalAttribute(java.lang.String atr)
                                         throws CDFException.ReaderError

Returns GlobalAttribute object for the named global attribute.

Parameters:

atr -

Returns:

Throws:

CDFException.ReaderError

recordVariance

public final boolean recordVariance(java.lang.String varName)
                             throws CDFException.ReaderError

Returns an indication of the record varying property of a variable.

Parameters:

varName -

Returns:

false if variable has a constant value for this CDF.

Throws:

CDFException.ReaderError - if variable does not exist

isCompressed

public final boolean isCompressed(java.lang.String varName)
                           throws CDFException.ReaderError

Returns whether the values of the variable are represented in a compressed form in the CDF.For variables declared to be compressed, CDF specification allows the values to be stored in uncompressed form if the latter results in a smaller size.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getType

public final int getType(java.lang.String varName)
                  throws CDFException.ReaderError

Returns CDF type of the variable.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getDataItemSize

public final int getDataItemSize(java.lang.String varName)
                          throws CDFException.ReaderError

Returns size of a data item for the given variable.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getNumber

public final int getNumber(java.lang.String varName)
                    throws CDFException.ReaderError

Returns given variable's number property.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getNumberOfElements

public final int getNumberOfElements(java.lang.String varName)
                              throws CDFException.ReaderError

Returns given variable's 'number of elements' property.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getNumberOfValues

public final int getNumberOfValues(java.lang.String varName)
                            throws CDFException.ReaderError

Returns 'number of values' property of the given variable.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getPadValue

public final java.lang.Object getPadValue(java.lang.String varName)
                                   throws CDFException.ReaderError

Returns 'pad value' property of the given variable.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getPadValue

public final java.lang.Object getPadValue(java.lang.String varName,
                                          boolean preservePrecision)
                                   throws CDFException.ReaderError

Returns 'pad value' property of the given variable subject to the given precision preservation constraint.

Parameters:

varName -

preservePrecision -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getDimensions

public final int[] getDimensions(java.lang.String varName)
                          throws CDFException.ReaderError

Returns dimensions the given variable.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getVarys

public final boolean[] getVarys(java.lang.String varName)
                         throws CDFException.ReaderError

Returns 'varys' property of the given variable.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getEffectiveRank

public final int getEffectiveRank(java.lang.String varName)
                           throws CDFException.ReaderError

Returns effective rank of this variable.Dimensions for which dimVarys is false do not count.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

isMissingRecords

public final boolean isMissingRecords(java.lang.String varName)
                               throws CDFException.ReaderError

Shows whether one or more records (in the range returned by getRecordRange()) are missing.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getRecordRange

public final int[] getRecordRange(java.lang.String varName)
                           throws CDFException.ReaderError

Returns record range for this variable

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

isCompatible

public final boolean isCompatible(java.lang.String varName,
                                  java.lang.Class cl)
                           throws CDFException.ReaderError

returns whether conversion of this variable to type specified by cl is supported while preserving precision.

Parameters:

varName -

cl -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

isCompatible

public final boolean isCompatible(java.lang.String varName,
                                  java.lang.Class cl,
                                  boolean preserve)
                           throws CDFException.ReaderError

Returns whether conversion of this variable to type specified by cl is supported under the given precision preserving constraint.

Parameters:

varName -

preserve -

cl -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

missingRecordValueIsPrevious

public final boolean missingRecordValueIsPrevious(java.lang.String varName)
                                           throws CDFException.ReaderError

Return whether the missing record should be assigned the last seen value.If none has been seen, pad value is assigned.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

missingRecordValueIsPad

public final boolean missingRecordValueIsPad(java.lang.String varName)
                                      throws CDFException.ReaderError

Return whether the missing record should be assigned the pad value.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getElementCount

public final java.util.Vector<java.lang.Integer> getElementCount(java.lang.String varName)
                                                          throws CDFException.ReaderError

Return element count for this variable's dimensions.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

getEffectiveDimensions

public final int[] getEffectiveDimensions(java.lang.String varName)
                                   throws CDFException.ReaderError

Returns effective dimensions of the given variable.Dimensions for which dimVarys is false are ignored.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

isTimeType

public final boolean isTimeType(java.lang.String varName)
                         throws CDFException.ReaderError

Returns whether the given variable represents time.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError - if variable does not exist

existsVariable

public final boolean existsVariable(java.lang.String varName)

Returns whether there is a variable with the given name.

Parameters:

varName -

Returns:

userTimeVariableName

public abstract java.lang.String userTimeVariableName(java.lang.String varName)
                                               throws CDFException.ReaderError

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError

getTimeVariableName

public final java.lang.String getTimeVariableName(java.lang.String varName)
                                           throws java.lang.Throwable

Returns the name of the time variable for the given variable.

Parameters:

varName - variable name

Returns:

String

Throws:

CDFException.ReaderError - if variable does not exist

java.lang.Throwable

getLastLeapSecondId

public final int getLastLeapSecondId()

Identifies the leap second table used in creating this CDF.Returns the id of the last leap second in the leap second table. Leap second id is an integer = year*10000 + month*100 + day, where year, month and day refer to the day following the leap second. Until 2015, leap second has been added at the end of December, or June. Thus leapSecondId is either (10000*year + 101), or (10000*year + 701).

Returns:

getBlockingFactor

public final int getBlockingFactor(java.lang.String varName)
                            throws CDFException.ReaderError

Returns the blocking factor used to compress this variable.See the CDF User's Guide for details.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError

isTypeR

public final boolean isTypeR(java.lang.String varName)
                      throws CDFException.ReaderError

Returns whether a variable of type r-variable..See the CDF User's Guide for details.

Parameters:

varName -

Returns:

Throws:

CDFException.ReaderError