gov.nasa.gsfc.spdf.cdfj

Interface Variable

All Superinterfaces:

VariableMetaData

All Known Implementing Classes:

CDFImpl.CDFVariable

public interface Variable
extends VariableMetaData

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

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.Otherwise, throws Throwable
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.Otherwise, throws Throwable
double[]	asDoubleArray() Returns this variable's values as double[].If variable type cannot be cast to double, a Throwable is thrown.
double[]	asDoubleArray(boolean preserve, int[] pt) 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.
double[]	asDoubleArray(int[] pt) 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.
float[]	asFloatArray() Returns this variable's values as float[].If variable type cannot be cast to float, a Throwable is thrown.
float[]	asFloatArray(boolean preserve, int[] pt) 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.
float[]	asFloatArray(int[] pt) 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.
int[]	asIntArray() 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.
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).throws Throwable for variables of other types.
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.throws Throwable for variables of other types.
long[]	asLongArray() Returns this variable's values as long[] for variables of type long.throws Throwable for variables of other types.
long[]	asLongArray(int[] pt) 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.
short[]	asShortArray() Returns this variable's values as short[] for variables of type short, byte or unsigned byte throws Throwable for variables of other types.
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).throws Throwable for variables of other types.
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.throws Throwable for variables of other types.
VDataContainer.CByte	getByteContainer(int[] pt) Returns byte DataContainer for a range of points.
CDFImpl	getCDF() Returns CDFImpl object containing this variable.
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
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.
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.
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.
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.

Methods inherited from interface gov.nasa.gsfc.spdf.cdfj.VariableMetaData

getBlockingFactor, getBuffer, getCompressionType, getDataBuffers, getDataBuffers, getDataItemSize, getDimensions, getEffectiveRank, getLocator, getName, getNumber, getNumberOfElements, getNumberOfValues, getPadValue, getPadValue, getRecordRange, getType, getVarys, isCompatible, isCompatible, isCompressed, isMissingRecords, isTypeR, recordVariance, rowMajority

Method Detail

asByteArray

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

Returns:

Throws:

java.lang.Throwable

asByteArray

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

Parameters:

pt -

Returns:

Throws:

java.lang.Throwable

asFloatArray

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.

Returns:

Throws:

java.lang.Throwable

asFloatArray

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.

Parameters:

preserve -

pt -

Returns:

Throws:

java.lang.Throwable

asFloatArray

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.

Parameters:

pt -

Returns:

Throws:

java.lang.Throwable

asDoubleArray

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.

Returns:

Throws:

java.lang.Throwable

asDoubleArray

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.

Parameters:

preserve -

pt -

Returns:

Throws:

java.lang.Throwable

asDoubleArray

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.

Parameters:

pt -

Returns:

Throws:

java.lang.Throwable

asIntArray

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.

Returns:

Throws:

java.lang.Throwable

asIntArray

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.

Parameters:

preserve -

pt -

Returns:

Throws:

java.lang.Throwable

asIntArray

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.

Parameters:

pt -

Returns:

Throws:

java.lang.Throwable

asShortArray

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

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

Returns:

Throws:

java.lang.Throwable

asShortArray

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.

Parameters:

preserve -

pt -

Returns:

Throws:

java.lang.Throwable

asShortArray

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.

Parameters:

pt -

Returns:

Throws:

java.lang.Throwable

asLongArray

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.

Returns:

Throws:

java.lang.Throwable

asLongArray

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.

Parameters:

pt -

Returns:

Throws:

java.lang.Throwable

missingRecordValueIsPrevious

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 VariableMetaData

Returns:

missingRecordValueIsPad

boolean missingRecordValueIsPad()

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

Specified by:

missingRecordValueIsPad in interface VariableMetaData

Returns:

getElementCount

java.util.Vector getElementCount()

Return element count for this variable's dimensions.

Specified by:

getElementCount in interface VariableMetaData

Returns:

getByteContainer

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

Returns byte DataContainer for a range of points.

Parameters:

pt -

Returns:

Throws:

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

getStringContainer

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

Returns String DataContainer for a range of points.

Parameters:

pt -

Returns:

Throws:

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

getFloatContainer

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

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

Parameters:

pt -

bo -

preserve -

Returns:

Throws:

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

getFloatContainer

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

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

Parameters:

pt -

preserve -

Returns:

Throws:

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

getDoubleContainer

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

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

Parameters:

pt -

bo -

preserve -

Returns:

Throws:

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

getDoubleContainer

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

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

Parameters:

pt -

preserve -

Returns:

Throws:

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

getIntContainer

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

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

Parameters:

pt -

bo -

preserve -

Returns:

Throws:

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

getIntContainer

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

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

Parameters:

pt -

preserve -

Returns:

Throws:

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

getShortContainer

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

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

Parameters:

pt -

bo -

preserve -

Returns:

Throws:

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

getShortContainer

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

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

Parameters:

pt -

preserve -

Returns:

Throws:

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

getLongContainer

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

Returns long DataContainer for a range of points.

Parameters:

pt -

bo -

Returns:

Throws:

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

getLongContainer

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

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

Parameters:

pt -

Returns:

Throws:

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

getCDF

CDFImpl getCDF()

Returns CDFImpl object containing this variable.

Returns:

getEffectiveDimensions

int[] getEffectiveDimensions()

Returns effective dimensions

Specified by:

getEffectiveDimensions in interface VariableMetaData

Returns: