gov.nasa.gsfc.spdf.cdfj

Class CDFImpl

java.lang.Object

gov.nasa.gsfc.spdf.cdfj.CDFImpl

All Implemented Interfaces:

java.io.Serializable

public abstract class CDFImpl
extends java.lang.Object
implements java.io.Serializable

Abstract base class for each versions of CDF, containing common functionality.

See Also:

CDF2, CDF3, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CDFImpl.CDFAttributeEntry AttributeEntry class
class	CDFImpl.CDFVariable CDFVariable class
class	CDFImpl.DataLocator DataLocator

Field Summary

Fields

Modifier and Type	Field and Description
static int	CCR_RECORD_TYPE
static int	CPR_RECORD_TYPE
static int	CVVR_RECORD_TYPE
static int	FLAGS_MAJORITY_MASK
static int	GDR_RECORD CDF constants
protected CDFFactory.ProcessingOption	processingOption
static int	ROW_MAJOR
protected CDFFactory.CDFSource	source
static java.lang.String	STRINGDELIMITER
protected CDFCore	thisCDF
protected java.util.Hashtable	variableTable
protected java.lang.String[]	varNames
static int	VVR_RECORD_TYPE
static int	VXR_RECORD_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CDFImpl(java.nio.ByteBuffer buf)

Method Summary

Modifier and Type	Method and Description
void	extractBytes(int bufOffset, byte[] ba, int offset, int len)
java.lang.Object	get(java.lang.String varName)
java.lang.Object	get(java.lang.String varName, int element)
java.lang.Object	get(java.lang.String varName, int[] elements)
java.lang.Object	get(java.lang.String varName, int index0, int index1)
java.lang.Object	get(java.lang.String varName, int first, int last, int element)
java.lang.Object	get(java.lang.String varName, int first, int last, int[] elements)
double[]	get1D(java.lang.String varName)
java.lang.Object	get1D(java.lang.String varName, boolean preserve)
byte[]	get1D(java.lang.String varName, java.lang.Boolean stringType)
java.lang.Object	get1D(java.lang.String varName, int point)
java.lang.Object	get1D(java.lang.String varName, int first, int last)
java.lang.Object	getAttribute(java.lang.String atr) returns value of the named global attribute
java.lang.Object	getAttribute(java.lang.String var, java.lang.String atr) returns value of the named attribute for the named variable
java.util.Vector	getAttributeEntries(java.lang.String atr) returns list of AttributeEntry objects for the named global attribute.
java.util.Vector	getAttributeEntries(java.lang.String var, java.lang.String atr) returns list of AttributeEntry objects for the named attribute for the named variable.
protected java.nio.ByteBuffer	getBuffer()
byte[]	getByteArray(java.lang.String varName, int[] pt)
java.nio.ByteOrder	getByteOrder() returns byte order of source CDF
double[]	getDoubleArray(java.lang.String varName, int[] pt)
double[]	getDoubleArray(java.lang.String varName, int[] pt, boolean preserve)
float[]	getFloatArray(java.lang.String varName, int[] pt)
float[]	getFloatArray(java.lang.String varName, int[] pt, boolean preserve)
GlobalAttribute	getGlobalAttribute(java.lang.String atr) returns value of the named global attribute as GlobalAttribute object.
int[]	getIntArray(java.lang.String varName, int[] pt)
int[]	getIntArray(java.lang.String varName, int[] pt, boolean preserve)
java.lang.Object	getLong(java.lang.String varName)
long[]	getLongArray(java.lang.String varName, int[] pt)
static java.lang.Object	getNumberAttribute(int type, int nelement, java.nio.ByteBuffer vbuf, java.nio.ByteOrder byteOrder)
double[]	getOneD(java.lang.String varName, boolean columnMajor)
byte[]	getOneD(java.lang.String varName, java.lang.Boolean stringType, boolean columnMajor)
java.lang.Object	getPoint(java.lang.String varName, int point)
java.lang.Object	getRange(java.lang.String varName, int first, int last)
java.lang.Object	getRange(java.lang.String varName, int first, int last, boolean oned)
java.lang.Object	getRange(java.lang.String varName, int first, int last, int element)
java.lang.Object	getRange(java.lang.String varName, int first, int last, int[] elements)
java.lang.Object	getRangeOneD(java.lang.String varName, int first, int last, boolean columnMajor)
protected java.nio.ByteBuffer	getRecord(long offset)
protected int	getRecordOffset()
short[]	getShortArray(java.lang.String varName, int[] pt)
short[]	getShortArray(java.lang.String varName, int[] pt, boolean preserve)
CDFFactory.CDFSource	getSource()
protected java.lang.String	getString(java.nio.ByteBuffer _buf, int max)
protected abstract java.lang.String	getString(long offset)
protected java.lang.String	getString(long offset, int max)
java.nio.ByteBuffer	getValueBuffer(long offset)
java.nio.ByteBuffer	getValueBuffer(Variable var, long offset, int size, int number)
Variable	getVariable(java.lang.String name) returns the object that implements the Variable interface for the named variable
java.lang.String[]	getVariableNames() returns variable names in a String[]
java.lang.String[]	getVariableNames(java.lang.String type) returns variable names of a given VAR_TYPE in a String[]
java.lang.String[]	globalAttributeNames() returns names of global attributes in a String[]
boolean	isBigEndian()
boolean	isCompatible(java.lang.String varName, java.lang.Class cl)
protected abstract long	longInt(java.nio.ByteBuffer buf)
protected abstract int	lowOrderInt(java.nio.ByteBuffer buf)
protected abstract int	lowOrderInt(java.nio.ByteBuffer buf, int offset)
boolean	rowMajority() returns row majority of source CDF
protected void	setBuffer(java.nio.ByteBuffer b)
protected void	setByteOrder(boolean _bigEndian)
protected void	setByteOrder(java.nio.ByteOrder bo)
protected void	setOption(CDFFactory.ProcessingOption option)
protected void	setSource(CDFFactory.CDFSource source)
static gov.nasa.gsfc.spdf.cdfj.CDFImpl.TargetAttribute	targetAttributeInstance(boolean p, boolean c)
java.lang.String[]	variableAttributeNames(java.lang.String name) returns names of variable attributes in a String[]
int[]	variableDimensions(java.lang.String name) returns dimensions of the named variable.
protected java.util.Hashtable	variables() returns name to Variable map

Methods inherited from class java.lang.Object

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

Field Detail

GDR_RECORD

public static final int GDR_RECORD

CDF constants

See Also:

Constant Field Values

FLAGS_MAJORITY_MASK

public static final int FLAGS_MAJORITY_MASK

See Also:

Constant Field Values

ROW_MAJOR

public static final int ROW_MAJOR

See Also:

Constant Field Values

VXR_RECORD_TYPE

public static final int VXR_RECORD_TYPE

See Also:

Constant Field Values

VVR_RECORD_TYPE

public static final int VVR_RECORD_TYPE

See Also:

Constant Field Values

CVVR_RECORD_TYPE

public static final int CVVR_RECORD_TYPE

See Also:

Constant Field Values

CCR_RECORD_TYPE

public static final int CCR_RECORD_TYPE

See Also:

Constant Field Values

CPR_RECORD_TYPE

public static final int CPR_RECORD_TYPE

See Also:

Constant Field Values

STRINGDELIMITER

public static final java.lang.String STRINGDELIMITER

varNames

protected java.lang.String[] varNames

variableTable

protected java.util.Hashtable variableTable

thisCDF

protected CDFCore thisCDF

source

protected CDFFactory.CDFSource source

processingOption

protected CDFFactory.ProcessingOption processingOption

Constructor Detail

CDFImpl

protected CDFImpl(java.nio.ByteBuffer buf)

Method Detail

getRecord

protected java.nio.ByteBuffer getRecord(long offset)

getByteOrder

public java.nio.ByteOrder getByteOrder()

returns byte order of source CDF

rowMajority

public boolean rowMajority()

returns row majority of source CDF

variables

protected java.util.Hashtable variables()

returns name to Variable map

getVariableNames

public java.lang.String[] getVariableNames()

returns variable names in a String[]

getVariable

public Variable getVariable(java.lang.String name)

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

getVariableNames

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

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

globalAttributeNames

public java.lang.String[] globalAttributeNames()

returns names of global attributes in a String[]

variableAttributeNames

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

returns names of variable attributes in a String[]

getAttribute

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

returns value of the named global attribute

getGlobalAttribute

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

returns value of the named global attribute as GlobalAttribute object.

Throws:

java.lang.Throwable

getAttribute

public java.lang.Object getAttribute(java.lang.String var,
                                     java.lang.String atr)

returns value of the named attribute for the named variable

getAttributeEntries

public java.util.Vector getAttributeEntries(java.lang.String atr)
                                     throws java.lang.Throwable

returns list of AttributeEntry objects for the named global attribute.

Throws:

java.lang.Throwable

getAttributeEntries

public java.util.Vector getAttributeEntries(java.lang.String var,
                                            java.lang.String atr)

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

getValueBuffer

public java.nio.ByteBuffer getValueBuffer(long offset)

getValueBuffer

public java.nio.ByteBuffer getValueBuffer(Variable var,
                                          long offset,
                                          int size,
                                          int number)

variableDimensions

public int[] variableDimensions(java.lang.String name)

returns dimensions of the named variable.

longInt

protected abstract long longInt(java.nio.ByteBuffer buf)

lowOrderInt

protected abstract int lowOrderInt(java.nio.ByteBuffer buf)

lowOrderInt

protected abstract int lowOrderInt(java.nio.ByteBuffer buf,
                                   int offset)

getString

protected abstract java.lang.String getString(long offset)

getString

protected java.lang.String getString(long offset,
                                     int max)

getString

protected java.lang.String getString(java.nio.ByteBuffer _buf,
                                     int max)

getNumberAttribute

public static java.lang.Object getNumberAttribute(int type,
                                                  int nelement,
                                                  java.nio.ByteBuffer vbuf,
                                                  java.nio.ByteOrder byteOrder)

setByteOrder

protected void setByteOrder(java.nio.ByteOrder bo)

setByteOrder

protected void setByteOrder(boolean _bigEndian)

isBigEndian

public boolean isBigEndian()

setBuffer

protected void setBuffer(java.nio.ByteBuffer b)

getBuffer

protected java.nio.ByteBuffer getBuffer()

extractBytes

public void extractBytes(int bufOffset,
                         byte[] ba,
                         int offset,
                         int len)

getRecordOffset

protected int getRecordOffset()

setSource

protected void setSource(CDFFactory.CDFSource source)

getSource

public CDFFactory.CDFSource getSource()

setOption

protected void setOption(CDFFactory.ProcessingOption option)

get1D

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

Throws:

java.lang.Throwable

getOneD

public double[] getOneD(java.lang.String varName,
                        boolean columnMajor)
                 throws java.lang.Throwable

Throws:

java.lang.Throwable

get1D

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

Throws:

java.lang.Throwable

getOneD

public byte[] getOneD(java.lang.String varName,
                      java.lang.Boolean stringType,
                      boolean columnMajor)
               throws java.lang.Throwable

Throws:

java.lang.Throwable

get1D

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

Throws:

java.lang.Throwable

get1D

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

Throws:

java.lang.Throwable

get1D

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

Throws:

java.lang.Throwable

get

public java.lang.Object get(java.lang.String varName)
                     throws java.lang.Throwable

Throws:

java.lang.Throwable

getLong

public java.lang.Object getLong(java.lang.String varName)
                         throws java.lang.Throwable

Throws:

java.lang.Throwable

get

public java.lang.Object get(java.lang.String varName,
                            int element)
                     throws java.lang.Throwable

Throws:

java.lang.Throwable

get

public java.lang.Object get(java.lang.String varName,
                            int[] elements)
                     throws java.lang.Throwable

Throws:

java.lang.Throwable

get

public java.lang.Object get(java.lang.String varName,
                            int index0,
                            int index1)
                     throws java.lang.Throwable

Throws:

java.lang.Throwable

get

public java.lang.Object get(java.lang.String varName,
                            int first,
                            int last,
                            int element)
                     throws java.lang.Throwable

Throws:

java.lang.Throwable

get

public java.lang.Object get(java.lang.String varName,
                            int first,
                            int last,
                            int[] elements)
                     throws java.lang.Throwable

Throws:

java.lang.Throwable

getPoint

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

Throws:

java.lang.Throwable

getRange

public java.lang.Object getRange(java.lang.String varName,
                                 int first,
                                 int last,
                                 boolean oned)
                          throws java.lang.Throwable

Throws:

java.lang.Throwable

getRange

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

Throws:

java.lang.Throwable

getRangeOneD

public java.lang.Object getRangeOneD(java.lang.String varName,
                                     int first,
                                     int last,
                                     boolean columnMajor)
                              throws java.lang.Throwable

Throws:

java.lang.Throwable

getRange

public java.lang.Object getRange(java.lang.String varName,
                                 int first,
                                 int last,
                                 int element)
                          throws java.lang.Throwable

Throws:

java.lang.Throwable

getRange

public java.lang.Object getRange(java.lang.String varName,
                                 int first,
                                 int last,
                                 int[] elements)
                          throws java.lang.Throwable

Throws:

java.lang.Throwable

isCompatible

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

Throws:

java.lang.Throwable

getByteArray

public byte[] getByteArray(java.lang.String varName,
                           int[] pt)
                    throws java.lang.Throwable

Throws:

java.lang.Throwable

getDoubleArray

public double[] getDoubleArray(java.lang.String varName,
                               int[] pt)
                        throws java.lang.Throwable

Throws:

java.lang.Throwable

getDoubleArray

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

Throws:

java.lang.Throwable

getFloatArray

public float[] getFloatArray(java.lang.String varName,
                             int[] pt)
                      throws java.lang.Throwable

Throws:

java.lang.Throwable

getFloatArray

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

Throws:

java.lang.Throwable

getIntArray

public int[] getIntArray(java.lang.String varName,
                         int[] pt)
                  throws java.lang.Throwable

Throws:

java.lang.Throwable

getIntArray

public int[] getIntArray(java.lang.String varName,
                         int[] pt,
                         boolean preserve)
                  throws java.lang.Throwable

Throws:

java.lang.Throwable

getLongArray

public long[] getLongArray(java.lang.String varName,
                           int[] pt)
                    throws java.lang.Throwable

Throws:

java.lang.Throwable

getShortArray

public short[] getShortArray(java.lang.String varName,
                             int[] pt)
                      throws java.lang.Throwable

Throws:

java.lang.Throwable

getShortArray

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

Throws:

java.lang.Throwable

targetAttributeInstance

public static gov.nasa.gsfc.spdf.cdfj.CDFImpl.TargetAttribute targetAttributeInstance(boolean p,
                                                                                      boolean c)