gov.nasa.gsfc.spdf.cdfj

Class CDFImpl.CDFVariable

java.lang.Object

gov.nasa.gsfc.spdf.cdfj.CDFImpl.CDFVariable

All Implemented Interfaces:

Variable, VariableMetaData, java.io.Serializable

Enclosing class:

CDFImpl

public class CDFImpl.CDFVariable
extends java.lang.Object
implements java.io.Serializable, Variable

CDFVariable class

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Vector	attributes
int	compressionType
int[]	dimensions
int	number
protected int	numberOfValues
java.lang.Object	padValue
boolean[]	varies

Constructor Summary

Constructors

Constructor and Description
CDFVariable(long offset, java.lang.String vtype)

Method Summary

Modifier and Type	Method and Description
byte[]	asByteArray() Returns this variable's values as byte[] if variable type is byte, unsigned byte or char.
byte[]	asByteArray(int[] pt) Returns this variable's values for a range of records as byte[] if variable type is byte, unsigned byte or char.
byte[]	asByteArray(int[] pt, boolean columnMajor)
double[]	asDoubleArray() Returns this variable's values as double[].
double[]	asDoubleArray(boolean preserve, int[] pt) Returns this variable's values for the specified range of records as double[].
double[]	asDoubleArray(gov.nasa.gsfc.spdf.cdfj.CDFImpl.TargetAttribute tattr, int[] pt)
double[]	asDoubleArray(int[] pt) Returns this variable's values for the specified range of records as double[].
float[]	asFloatArray() Returns this variable's values as float[].
float[]	asFloatArray(boolean preserve, int[] pt) Returns this variable's values for the specified range of records as float[].
float[]	asFloatArray(int[] pt) Returns this variable's values for the specified range of records as float[].
int[]	asIntArray() Returns this variable's values as int[] for variables of type int, short or unsigned short, byte or unsigned byte.
int[]	asIntArray(boolean preserve, int[] pt) Returns this variable's values for the specified range of records as int[] for variables of type int, short or unsigned short, byte or unsigned byte, or unsigned int (only if preserve is false).
int[]	asIntArray(int[] pt) Returns this variable's values for the specified range of records as int[] for variables of type int, short or unsigned short, byte or unsigned byte.
long[]	asLongArray() Returns this variable's values as long[] for variables of type long.
long[]	asLongArray(int[] pt) Returns this variable's values for the specified range of records as long[] for variables of type long.
short[]	asShortArray() Returns this variable's values as long[] for variables of type long.
short[]	asShortArray(boolean preserve, int[] pt) Returns this variable's values for the specified range of records as short[] for variables of type short, byte or unsigned byte, or unsigned short (only if preserve is false).
short[]	asShortArray(int[] pt) Returns this variable's values for the specified range of records as short[] for variables of type short, byte or unsigned byte.
int	getBlockingFactor() returns blocking factor used in compression
java.nio.ByteBuffer	getBuffer()
java.nio.ByteBuffer	getBuffer(java.lang.Class cl, 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.
java.nio.ByteBuffer	getBuffer(int[] recordRange)
VDataContainer.CByte	getByteContainer(int[] pt) Returns byte DataContainer for a range of points.
CDFImpl	getCDF() Returns CDFImpl object containing this variable.
int	getCompressionType() returns 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) Gets an array of VariableDataBuffer objects that provide location of data for this variable if this variable is not compressed.
int	getDataItemSize() returns size of value of this variable
int[]	getDimensions() Gets the dimensions.
VDataContainer.CDouble	getDoubleContainer(int[] pt, boolean preserve) Returns double DataContainer for a range of points using native ByteOrder, optionally accepting possible loss of precision.
VDataContainer.CDouble	getDoubleContainer(int[] pt, boolean preserve, java.nio.ByteOrder bo) Returns double DataContainer for a range of points, optionally accepting possible loss of precision.
int[]	getEffectiveDimensions() Returns effective dimensions
int	getEffectiveRank() returns effective rank
java.util.Vector	getElementCount() Return element count for this variable's dimensions.
VDataContainer.CFloat	getFloatContainer(int[] pt, boolean preserve) Returns float DataContainer for a range of points using native ByteOrder, optionally accepting possible loss of precision.
VDataContainer.CFloat	getFloatContainer(int[] pt, boolean preserve, java.nio.ByteOrder bo) Returns float DataContainer for a range of points, optionally accepting possible loss of precision.
VDataContainer.CInt	getIntContainer(int[] pt, boolean preserve) Returns int DataContainer for a range of points using native ByteOrder, optionally accepting possible loss of precision.
VDataContainer.CInt	getIntContainer(int[] pt, boolean preserve, java.nio.ByteOrder bo) Returns int DataContainer for a range of points, optionally accepting possible loss of precision.
VariableDataLocator	getLocator() Gets a list of regions that contain data for the variable.
VDataContainer.CLong	getLongContainer(int[] pt) Returns short DataContainer for a range of points using native ByteOrder.
VDataContainer.CLong	getLongContainer(int[] pt, java.nio.ByteOrder bo) Returns long DataContainer for a range of points.
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() returns number of elements in the value of this variable
int	getNumberOfValues() returns number of values
java.lang.Object	getPadValue() returns pad value
java.lang.Object	getPadValue(boolean preservePrecision) Gets an object that represents a padded instance for a variable of numeric type.
int[]	getRecordRange() Returns record range for this variable
VDataContainer.CShort	getShortContainer(int[] pt, boolean preserve) Returns short DataContainer for a range of points using native ByteOrder, optionally accepting possible loss of precision.
VDataContainer.CShort	getShortContainer(int[] pt, boolean preserve, java.nio.ByteOrder bo) Returns short DataContainer for a range of points, optionally accepting possible loss of precision.
VDataContainer.CString	getStringContainer(int[] pt) Returns String DataContainer for a range of points.
int	getType() returns type of values of this variable
boolean[]	getVarys() Gets the dimensional variance.
boolean	isCompatible(java.lang.Class cl) returns whether conversion of this variable to type specified by cl is supported while preserving precision.
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() returns whether variable values have been compressed
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.
boolean	padValueSpecified() returns whether pad value is specified for this variable
boolean	recordVariance() returns whether value of this variable can vary from record to record
boolean	rowMajority() returns whether row major ordering is in use

Methods inherited from class java.lang.Object

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

Field Detail

attributes

public java.util.Vector attributes

number

public int number

numberOfValues

protected int numberOfValues

dimensions

public int[] dimensions

varies

public boolean[] varies

padValue

public java.lang.Object padValue

compressionType

public int compressionType

Constructor Detail

CDFVariable

public CDFVariable(long offset,
                   java.lang.String vtype)

Method Detail

isTypeR

public boolean isTypeR()

Specified by:

isTypeR in interface VariableMetaData

Returns:

missingRecordValueIsPrevious

public boolean missingRecordValueIsPrevious()

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

Specified by:

missingRecordValueIsPrevious in interface Variable

Specified by:

missingRecordValueIsPrevious in interface VariableMetaData

Returns:

missingRecordValueIsPad

public boolean missingRecordValueIsPad()

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

Specified by:

missingRecordValueIsPad in interface Variable

Specified by:

missingRecordValueIsPad in interface VariableMetaData

Returns:

isMissingRecords

public boolean isMissingRecords()

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

Specified by:

isMissingRecords in interface VariableMetaData

Returns:

getLocator

public 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.

Specified by:

getLocator in interface VariableMetaData

Returns:

getDataBuffers

public VariableDataBuffer[] getDataBuffers(boolean raw)
                                    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.

Specified by:

getDataBuffers in interface VariableMetaData

Returns:

Throws:

java.lang.Throwable

getDataBuffers

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

Description copied from interface: VariableMetaData

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.

Specified by:

getDataBuffers in interface VariableMetaData

Returns:

Throws:

java.lang.Throwable

rowMajority

public boolean rowMajority()

returns whether row major ordering is in use

Specified by:

rowMajority in interface VariableMetaData

Returns:

recordVariance

public boolean recordVariance()

returns whether value of this variable can vary from record to record

Specified by:

recordVariance in interface VariableMetaData

Returns:

padValueSpecified

public boolean padValueSpecified()

returns whether pad value is specified for this variable

isCompressed

public boolean isCompressed()

returns whether variable values have been compressed

Specified by:

isCompressed in interface VariableMetaData

Returns:

getPadValue

public java.lang.Object getPadValue()

returns pad value

Specified by:

getPadValue in interface VariableMetaData

Returns:

getPadValue

public 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;

Specified by:

getPadValue in interface VariableMetaData

Returns:

getCDF

public CDFImpl getCDF()

Description copied from interface: Variable

Returns CDFImpl object containing this variable.

Specified by:

getCDF in interface Variable

Returns:

getType

public int getType()

returns type of values of this variable

Specified by:

getType in interface VariableMetaData

Returns:

getBlockingFactor

public int getBlockingFactor()

returns blocking factor used in compression

Specified by:

getBlockingFactor in interface VariableMetaData

Returns:

getCompressionType

public int getCompressionType()

returns compression type

Specified by:

getCompressionType in interface VariableMetaData

Returns:

getEffectiveRank

public int getEffectiveRank()

returns effective rank

Specified by:

getEffectiveRank in interface VariableMetaData

Returns:

getEffectiveDimensions

public int[] getEffectiveDimensions()

Returns effective dimensions

Specified by:

getEffectiveDimensions in interface Variable

Specified by:

getEffectiveDimensions in interface VariableMetaData

Returns:

getDataItemSize

public int getDataItemSize()

returns size of value of this variable

Specified by:

getDataItemSize in interface VariableMetaData

Returns:

getNumberOfElements

public int getNumberOfElements()

returns number of elements in the value of this variable

Specified by:

getNumberOfElements in interface VariableMetaData

Returns:

getNumberOfValues

public int getNumberOfValues()

returns number of values

Specified by:

getNumberOfValues in interface VariableMetaData

Returns:

getName

public java.lang.String getName()

Gets the name of this of this variable

Specified by:

getName in interface VariableMetaData

Returns:

getNumber

public int getNumber()

Gets the sequence number of the variable inside the CDF.

Specified by:

getNumber in interface VariableMetaData

Returns:

getDimensions

public int[] getDimensions()

Gets the dimensions.

Specified by:

getDimensions in interface VariableMetaData

Returns:

getRecordRange

public int[] getRecordRange()

Returns record range for this variable

Specified by:

getRecordRange in interface VariableMetaData

Returns:

getVarys

public boolean[] getVarys()

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

Specified by:

getVarys in interface VariableMetaData

Returns:

getBuffer

public java.nio.ByteBuffer getBuffer()
                              throws java.lang.Throwable

Throws:

java.lang.Throwable

getBuffer

public java.nio.ByteBuffer getBuffer(int[] recordRange)
                              throws java.lang.Throwable

Throws:

java.lang.Throwable

getBuffer

public java.nio.ByteBuffer getBuffer(java.lang.Class cl,
                                     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.

Specified by:

getBuffer in interface VariableMetaData

Returns:

Throws:

java.lang.Throwable

isCompatible

public 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)

Specified by:

isCompatible in interface VariableMetaData

Returns:

isCompatible

public 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.

Specified by:

isCompatible in interface VariableMetaData

Returns:

getByteContainer

public VDataContainer.CByte getByteContainer(int[] pt)
                                      throws java.lang.Throwable

Description copied from interface: Variable

Returns byte DataContainer for a range of points.

Specified by:

getByteContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

asByteArray

public byte[] asByteArray(int[] pt)
                   throws java.lang.Throwable

Returns this variable's values for a range of records as byte[] if variable type is byte, unsigned byte or char. Otherwise, throws Throwable

Specified by:

asByteArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asByteArray

public byte[] asByteArray()
                   throws java.lang.Throwable

Returns this variable's values as byte[] if variable type is byte, unsigned byte or char. Otherwise, throws Throwable

Specified by:

asByteArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asByteArray

public byte[] asByteArray(int[] pt,
                          boolean columnMajor)
                   throws java.lang.Throwable

Throws:

java.lang.Throwable

getStringContainer

public VDataContainer.CString getStringContainer(int[] pt)
                                          throws java.lang.Throwable

Description copied from interface: Variable

Returns String DataContainer for a range of points.

Specified by:

getStringContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

getFloatContainer

public VDataContainer.CFloat getFloatContainer(int[] pt,
                                               boolean preserve,
                                               java.nio.ByteOrder bo)
                                        throws java.lang.Throwable

Description copied from interface: Variable

Returns float DataContainer for a range of points, optionally accepting possible loss of precision.

Specified by:

getFloatContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

getFloatContainer

public VDataContainer.CFloat getFloatContainer(int[] pt,
                                               boolean preserve)
                                        throws java.lang.Throwable

Description copied from interface: Variable

Returns float DataContainer for a range of points using native ByteOrder, optionally accepting possible loss of precision.

Specified by:

getFloatContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

asFloatArray

public float[] asFloatArray(boolean preserve,
                            int[] pt)
                     throws java.lang.Throwable

Returns this variable's values for the specified range of records as float[]. If variable type cannot be cast to float, a Throwable is thrown. If preserve is true, a Throwable is thrown for variables of type double, long or int to signal possible loss of precision.

Specified by:

asFloatArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asFloatArray

public float[] asFloatArray()
                     throws java.lang.Throwable

Returns this variable's values as float[]. If variable type cannot be cast to float, a Throwable is thrown.

Specified by:

asFloatArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asFloatArray

public float[] asFloatArray(int[] pt)
                     throws java.lang.Throwable

Returns this variable's values for the specified range of records as float[]. If variable type cannot be cast to float, a Throwable is thrown.

Specified by:

asFloatArray in interface Variable

Returns:

Throws:

java.lang.Throwable

getDoubleContainer

public VDataContainer.CDouble getDoubleContainer(int[] pt,
                                                 boolean preserve,
                                                 java.nio.ByteOrder bo)
                                          throws java.lang.Throwable

Description copied from interface: Variable

Returns double DataContainer for a range of points, optionally accepting possible loss of precision.

Specified by:

getDoubleContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

getDoubleContainer

public VDataContainer.CDouble getDoubleContainer(int[] pt,
                                                 boolean preserve)
                                          throws java.lang.Throwable

Description copied from interface: Variable

Returns double DataContainer for a range of points using native ByteOrder, optionally accepting possible loss of precision.

Specified by:

getDoubleContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

asDoubleArray

public double[] asDoubleArray(boolean preserve,
                              int[] pt)
                       throws java.lang.Throwable

Returns this variable's values for the specified range of records as double[]. If variable type cannot be cast to double, a Throwable is thrown. If preserve is true, a Throwable is thrown for variables of type long to signal possible loss of precision.

Specified by:

asDoubleArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asDoubleArray

public double[] asDoubleArray(gov.nasa.gsfc.spdf.cdfj.CDFImpl.TargetAttribute tattr,
                              int[] pt)
                       throws java.lang.Throwable

Throws:

java.lang.Throwable

asDoubleArray

public double[] asDoubleArray()
                       throws java.lang.Throwable

Returns this variable's values as double[]. If variable type cannot be cast to double, a Throwable is thrown.

Specified by:

asDoubleArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asDoubleArray

public double[] asDoubleArray(int[] pt)
                       throws java.lang.Throwable

Returns this variable's values for the specified range of records as double[]. If variable type cannot be cast to double, a Throwable is thrown.

Specified by:

asDoubleArray in interface Variable

Returns:

Throws:

java.lang.Throwable

getLongContainer

public VDataContainer.CLong getLongContainer(int[] pt,
                                             java.nio.ByteOrder bo)
                                      throws java.lang.Throwable

Description copied from interface: Variable

Returns long DataContainer for a range of points.

Specified by:

getLongContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

getLongContainer

public VDataContainer.CLong getLongContainer(int[] pt)
                                      throws java.lang.Throwable

Description copied from interface: Variable

Returns short DataContainer for a range of points using native ByteOrder.

Specified by:

getLongContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

asLongArray

public long[] asLongArray()
                   throws java.lang.Throwable

Returns this variable's values as long[] for variables of type long. throws Throwable for variables of other types.

Specified by:

asLongArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asLongArray

public long[] asLongArray(int[] pt)
                   throws java.lang.Throwable

Returns this variable's values for the specified range of records as long[] for variables of type long. throws Throwable for variables of other types.

Specified by:

asLongArray in interface Variable

Returns:

Throws:

java.lang.Throwable

getIntContainer

public VDataContainer.CInt getIntContainer(int[] pt,
                                           boolean preserve,
                                           java.nio.ByteOrder bo)
                                    throws java.lang.Throwable

Description copied from interface: Variable

Returns int DataContainer for a range of points, optionally accepting possible loss of precision.

Specified by:

getIntContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

getIntContainer

public VDataContainer.CInt getIntContainer(int[] pt,
                                           boolean preserve)
                                    throws java.lang.Throwable

Description copied from interface: Variable

Returns int DataContainer for a range of points using native ByteOrder, optionally accepting possible loss of precision.

Specified by:

getIntContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

asIntArray

public int[] asIntArray(boolean preserve,
                        int[] pt)
                 throws java.lang.Throwable

Returns this variable's values for the specified range of records as int[] for variables of type int, short or unsigned short, byte or unsigned byte, or unsigned int (only if preserve is false). throws Throwable for variables of other types.

Specified by:

asIntArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asIntArray

public int[] asIntArray()
                 throws java.lang.Throwable

Returns this variable's values as int[] for variables of type int, short or unsigned short, byte or unsigned byte. throws Throwable for variables of other types.

Specified by:

asIntArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asIntArray

public int[] asIntArray(int[] pt)
                 throws java.lang.Throwable

Returns this variable's values for the specified range of records as int[] for variables of type int, short or unsigned short, byte or unsigned byte. throws Throwable for variables of other types.

Specified by:

asIntArray in interface Variable

Returns:

Throws:

java.lang.Throwable

getShortContainer

public VDataContainer.CShort getShortContainer(int[] pt,
                                               boolean preserve,
                                               java.nio.ByteOrder bo)
                                        throws java.lang.Throwable

Description copied from interface: Variable

Returns short DataContainer for a range of points, optionally accepting possible loss of precision.

Specified by:

getShortContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

getShortContainer

public VDataContainer.CShort getShortContainer(int[] pt,
                                               boolean preserve)
                                        throws java.lang.Throwable

Description copied from interface: Variable

Returns short DataContainer for a range of points using native ByteOrder, optionally accepting possible loss of precision.

Specified by:

getShortContainer in interface Variable

Returns:

Throws:

java.lang.Throwable - if variable type is not compatible

asShortArray

public short[] asShortArray(boolean preserve,
                            int[] pt)
                     throws java.lang.Throwable

Returns this variable's values for the specified range of records as short[] for variables of type short, byte or unsigned byte, or unsigned short (only if preserve is false). throws Throwable for variables of other types.

Specified by:

asShortArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asShortArray

public short[] asShortArray()
                     throws java.lang.Throwable

Returns this variable's values as long[] for variables of type long. throws Throwable for variables of other types.

Specified by:

asShortArray in interface Variable

Returns:

Throws:

java.lang.Throwable

asShortArray

public short[] asShortArray(int[] pt)
                     throws java.lang.Throwable

Returns this variable's values for the specified range of records as short[] for variables of type short, byte or unsigned byte. throws Throwable for variables of other types.

Specified by:

asShortArray in interface Variable

Returns:

Throws:

java.lang.Throwable

getElementCount

public java.util.Vector getElementCount()

Return element count for this variable's dimensions.

Specified by:

getElementCount in interface Variable

Specified by:

getElementCount in interface VariableMetaData

Returns: