gov.nasa.gsfc.spdf.cdfj

Interface VariableMetaData

All Known Subinterfaces:

Variable

All Known Implementing Classes:

CDFImpl.CDFVariable

public interface VariableMetaData

Interface that defines methods for getting properties of a CDF variable.

Method Summary

Modifier and Type	Method and Description
int	getBlockingFactor()
java.nio.ByteBuffer	getBuffer(java.lang.Class type, int[] recordRange, boolean preserve, java.nio.ByteOrder bo) Returns ByteBuffer containing uncompressed values converted to a stream of numbers of the type specified by 'type' using the specified byte ordering (specified by bo) for the specified range of records.Original ordering of values (row majority) is preserved.recordRange[0] specifies the first record, and recordRange[1] the last record.If 'preserve' is true, a Throwable is thrown if the conversion to specified type will result in loss of precision.If 'preserve' is false, compatible conversions will be made even if it results in loss of precision.
int	getCompressionType() Gets the variable's compression type.
VariableDataBuffer[]	getDataBuffers() Gets an array of VariableDataBuffer objects that provide location of data for this variable if this variable is not compressed.This method throws a Throwable if invoked for a compressed variable.getBuffer method of VariableDataBuffer object returns a read only ByteBuffer that contains data for this variable for a range of records.
VariableDataBuffer[]	getDataBuffers(boolean raw)
int	getDataItemSize() Gets the size of an item (defined as number of bytes needed to represent the value of this variable at a point).
int[]	getDimensions() Gets the dimensions.
int[]	getEffectiveDimensions() Returns effective dimensions
int	getEffectiveRank() Returns effective rank of this variable.Dimensions for which dimVarys is false do not count.
java.util.Vector	getElementCount() Return element count for this variable's dimensions.
VariableDataLocator	getLocator() Gets a list of regions that contain data for the variable.Each element of the vector describes a region as an int[3] array.
java.lang.String	getName() Gets the name of this of this variable
int	getNumber() Gets the sequence number of the variable inside the CDF.
int	getNumberOfElements() Gets the number of elements (of type returned by getType()).
int	getNumberOfValues() Gets the number of values (size of time series)
java.lang.Object	getPadValue() Gets an object that represents a padded instance.For variable of type 'string', a String is returned; For numeric data, a double[] is returned.
java.lang.Object	getPadValue(boolean preservePrecision) Gets an object that represents a padded instance for a variable of numeric type.A double[] is returned, unless the variable type is long and preservePrecision is set to true;
int[]	getRecordRange() Returns record range for this variable
int	getType() Gets the type of values of the variable.
boolean[]	getVarys() Gets the dimensional variance.This determines the effective dimensionality of values of the variable.
boolean	isCompatible(java.lang.Class cl) returns whether conversion of this variable to type specified by cl is supported while preserving precision.equivalent to isCompatible(Class cl, true)
boolean	isCompatible(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() Determines whether the value of this variable is represented as a compressed byte sequence in the CDF.
boolean	isMissingRecords() Shows whether one or more records (in the range returned by getRecordRange()) are missing.
boolean	isTypeR()
boolean	missingRecordValueIsPad() Return whether the missing record should be assigned the pad value.
boolean	missingRecordValueIsPrevious() Return whether the missing record should be assigned the last seen value.If none has been seen, pad value is assigned.
boolean	recordVariance() Determines whether the value of this variable is the same at all time points.returns true if value may change, false otherwise
boolean	rowMajority() Determines whether the value of this variable is presented in a row-major order in the CDF.

Method Detail

recordVariance

boolean recordVariance()

Determines whether the value of this variable is the same at all time points.returns true if value may change, false otherwise

Returns:

isCompressed

boolean isCompressed()

Determines whether the value of this variable is represented as a compressed byte sequence in the CDF.

Returns:

rowMajority

boolean rowMajority()

Determines whether the value of this variable is presented in a row-major order in the CDF.

Returns:

getName

java.lang.String getName()

Gets the name of this of this variable

Returns:

getType

int getType()

Gets the type of values of the variable. Supported types are defined in the CDF Internal Format Description

Returns:

getCompressionType

int getCompressionType()

Gets the variable's compression type. Supported types are defined in the CDF Internal Format Description

Returns:

getDataItemSize

int getDataItemSize()

Gets the size of an item (defined as number of bytes needed to represent the value of this variable at a point).

Returns:

getNumber

int getNumber()

Gets the sequence number of the variable inside the CDF.

Returns:

getNumberOfElements

int getNumberOfElements()

Gets the number of elements (of type returned by getType()).

Returns:

getNumberOfValues

int getNumberOfValues()

Gets the number of values (size of time series)

Returns:

getPadValue

java.lang.Object getPadValue()

Gets an object that represents a padded instance.For variable of type 'string', a String is returned; For numeric data, a double[] is returned. If the variable type is long, a loss of precision may occur.

Returns:

getPadValue

java.lang.Object getPadValue(boolean preservePrecision)

Gets an object that represents a padded instance for a variable of numeric type.A double[] is returned, unless the variable type is long and preservePrecision is set to true;

Parameters:

preservePrecision -

Returns:

getDimensions

int[] getDimensions()

Gets the dimensions.

Returns:

getVarys

boolean[] getVarys()

Gets the dimensional variance.This determines the effective dimensionality of values of the variable.

Returns:

getLocator

VariableDataLocator getLocator()

Gets a list of regions that contain data for the variable.Each element of the vector describes a region as an int[3] array. Array elements are: record number of first point in the region, record number of last point in the region, and offset of the start of region.

Returns:

getDataBuffers

VariableDataBuffer[] getDataBuffers()
                             throws java.lang.Throwable

Gets an array of VariableDataBuffer objects that provide location of data for this variable if this variable is not compressed.This method throws a Throwable if invoked for a compressed variable.getBuffer method of VariableDataBuffer object returns a read only ByteBuffer that contains data for this variable for a range of records. getFirstRecord() and getLastRecord() define the range of records.

Returns:

Throws:

java.lang.Throwable

getDataBuffers

VariableDataBuffer[] getDataBuffers(boolean raw)
                             throws java.lang.Throwable

Parameters:

raw -

Returns:

Throws:

java.lang.Throwable

getEffectiveRank

int getEffectiveRank()

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

Returns:

getBuffer

java.nio.ByteBuffer getBuffer(java.lang.Class type,
                              int[] recordRange,
                              boolean preserve,
                              java.nio.ByteOrder bo)
                       throws java.lang.Throwable

Returns ByteBuffer containing uncompressed values converted to a stream of numbers of the type specified by 'type' using the specified byte ordering (specified by bo) for the specified range of records.Original ordering of values (row majority) is preserved.recordRange[0] specifies the first record, and recordRange[1] the last record.If 'preserve' is true, a Throwable is thrown if the conversion to specified type will result in loss of precision.If 'preserve' is false, compatible conversions will be made even if it results in loss of precision.

Parameters:

type -

bo -

recordRange -

preserve -

Returns:

Throws:

java.lang.Throwable

isMissingRecords

boolean isMissingRecords()

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

Returns:

getRecordRange

int[] getRecordRange()

Returns record range for this variable

Returns:

isCompatible

boolean isCompatible(java.lang.Class cl)

returns whether conversion of this variable to type specified by cl is supported while preserving precision.equivalent to isCompatible(Class cl, true)

Parameters:

cl -

Returns:

isCompatible

boolean isCompatible(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.

Parameters:

cl -

preserve -

Returns:

missingRecordValueIsPrevious

boolean missingRecordValueIsPrevious()

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

Returns:

missingRecordValueIsPad

boolean missingRecordValueIsPad()

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

Returns:

getElementCount

java.util.Vector getElementCount()

Return element count for this variable's dimensions.

Returns:

getEffectiveDimensions

int[] getEffectiveDimensions()

Returns effective dimensions

Returns:

getBlockingFactor

int getBlockingFactor()

Returns:

isTypeR

boolean isTypeR()

Returns: