ucar.nc2
Interface VariableIF

All Known Subinterfaces:

VariableEnhanced

All Known Implementing Classes:

CoordinateAxis, CoordinateAxis1D, CoordinateAxis1DTime, CoordinateAxis2D, Structure, StructureDS, StructurePseudo, Variable, VariableDS

public interface VariableIF

The public interface to a Variable.

Version:

$Revision:51 $ $Date:2006-07-12 17:13:13Z $

Author:

caron

Method Summary

Attribute	findAttribute(java.lang.String attName)
Attribute	findAttributeIgnoreCase(java.lang.String attName)
int	findDimensionIndex(java.lang.String dimName)
java.util.List	getAttributes()
Dimension	getCoordinateDimension()
DataType	getDataType()
Dimension	getDimension(int index)
java.util.List	getDimensions()
java.util.List	getDimensionsAll()
int	getElementSize()
java.lang.String	getName()
void	getNameAndDimensions(java.lang.StringBuffer result, boolean useFullName, boolean strict)
Group	getParentGroup()
Structure	getParentStructure()
java.util.List	getRanges()
int	getRank()
int[]	getShape()
java.lang.String	getShortName()
long	getSize()
boolean	isMemberOfStructure()
boolean	isMetadata()
boolean	isScalar()
boolean	isUnlimited()
boolean	isUnsigned()
boolean	isVariableLength()
Array	read()
Array	read(int[] origin, int[] shape)
Array	read(java.util.List ranges)
Array	read(java.lang.String rangeSpec)
Array	readAllStructures(java.util.List ranges, boolean flatten)
Array	readAllStructuresSpec(java.lang.String rangeSpec, boolean flatten)
byte	readScalarByte()
double	readScalarDouble()
float	readScalarFloat()
int	readScalarInt()
long	readScalarLong()
short	readScalarShort()
java.lang.String	readScalarString()
Variable	section(java.util.List ranges)
java.lang.String	toStringDebug()

Method Detail

getName

java.lang.String getName()

getShortName

java.lang.String getShortName()

getNameAndDimensions

void getNameAndDimensions(java.lang.StringBuffer result,
                          boolean useFullName,
                          boolean strict)

isUnlimited

boolean isUnlimited()

isUnsigned

boolean isUnsigned()

getDataType

DataType getDataType()

getRank

int getRank()

isScalar

boolean isScalar()

getSize

long getSize()

getElementSize

int getElementSize()

getShape

int[] getShape()

getDimensions

java.util.List getDimensions()

getDimension

Dimension getDimension(int index)

findDimensionIndex

int findDimensionIndex(java.lang.String dimName)

getDimensionsAll

java.util.List getDimensionsAll()

getCoordinateDimension

Dimension getCoordinateDimension()

getAttributes

java.util.List getAttributes()

findAttribute

Attribute findAttribute(java.lang.String attName)

findAttributeIgnoreCase

Attribute findAttributeIgnoreCase(java.lang.String attName)

getParentGroup

Group getParentGroup()

section

Variable section(java.util.List ranges)
                 throws InvalidRangeException

Throws:

InvalidRangeException

getRanges

java.util.List getRanges()

read

Array read(int[] origin,
           int[] shape)
           throws java.io.IOException,
                  InvalidRangeException

Throws:

java.io.IOException

InvalidRangeException

read

Array read(java.lang.String rangeSpec)
           throws java.io.IOException,
                  InvalidRangeException

Throws:

java.io.IOException

InvalidRangeException

read

Array read(java.util.List ranges)
           throws java.io.IOException,
                  InvalidRangeException

Throws:

java.io.IOException

InvalidRangeException

read

Array read()
           throws java.io.IOException

Throws:

java.io.IOException

isMemberOfStructure

boolean isMemberOfStructure()

isVariableLength

boolean isVariableLength()

isMetadata

boolean isMetadata()

getParentStructure

Structure getParentStructure()

readAllStructuresSpec

Array readAllStructuresSpec(java.lang.String rangeSpec,
                            boolean flatten)
                            throws java.io.IOException,
                                   InvalidRangeException

Throws:

java.io.IOException

InvalidRangeException

readAllStructures

Array readAllStructures(java.util.List ranges,
                        boolean flatten)
                        throws java.io.IOException,
                               InvalidRangeException

Throws:

java.io.IOException

InvalidRangeException

readScalarByte

byte readScalarByte()
                    throws java.io.IOException

Throws:

java.io.IOException

readScalarShort

short readScalarShort()
                      throws java.io.IOException

Throws:

java.io.IOException

readScalarInt

int readScalarInt()
                  throws java.io.IOException

Throws:

java.io.IOException

readScalarLong

long readScalarLong()
                    throws java.io.IOException

Throws:

java.io.IOException

readScalarFloat

float readScalarFloat()
                      throws java.io.IOException

Throws:

java.io.IOException

readScalarDouble

double readScalarDouble()
                        throws java.io.IOException

Throws:

java.io.IOException

readScalarString

java.lang.String readScalarString()
                                  throws java.io.IOException

Throws:

java.io.IOException

toStringDebug

java.lang.String toStringDebug()