visad.data.dods
Class StructureVariableAdapter

java.lang.Object
  extended by visad.data.dods.Adapter
      extended by visad.data.dods.VariableAdapter
          extended by visad.data.dods.StructureVariableAdapter

public class StructureVariableAdapter
extends VariableAdapter

Provides support for adapting DODS DStructure variables to the VisAD data-import context.

Instances are immutable.

Author:
Steven R. Emmerson

Method Summary
 DataImpl data(dods.dap.DStructure structure, boolean copy)
          Returns the VisAD DataImpl corresponding to the values of a DODS DStructure and the DODS variable used during construction of this instance.
 MathType getMathType()
          Returns the VisAD MathType of this instance.
 SimpleSet[] getRepresentationalSets(boolean copy)
          Returns the VisAD Sets that will be used to represent this instances data values in the range of a VisAD FlatField.
static StructureVariableAdapter structureVariableAdapter(dods.dap.DStructure structure, dods.dap.DAS das, VariableAdapterFactory factory)
          Returns an instance of this class corresponding to a DODS DStructure.
 
Methods inherited from class visad.data.dods.VariableAdapter
data, data, data, data, data, data, data, data, data, data, data, data, data, data, mathType
 
Methods inherited from class visad.data.dods.Adapter
attributeTable, attributeTable, getCacheStrategy, isFlat, mathType, realType, realType, realType, realType, scalarName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

structureVariableAdapter

public static StructureVariableAdapter structureVariableAdapter(dods.dap.DStructure structure,
                                                                dods.dap.DAS das,
                                                                VariableAdapterFactory factory)
                                                         throws BadFormException,
                                                                VisADException,
                                                                RemoteException
Returns an instance of this class corresponding to a DODS DStructure.

Parameters:
structure - The DODS variable. Only the DODS metadata is used: the variable needn't have any actual data.
das - The DODS DAS in which the attribute table for the DODS variable is embedded.
factory - A factory for creating variable adapters.
Returns:
An instance of this class corresponding to the input arguments.
Throws:
BadFormException - The DODS information is corrupt.
VisADException - VisAD failure.
RemoteException - Java RMI failure.

getMathType

public MathType getMathType()
Returns the VisAD MathType of this instance.

Specified by:
getMathType in class VariableAdapter
Returns:
The MathType of this instance.

getRepresentationalSets

public SimpleSet[] getRepresentationalSets(boolean copy)
Returns the VisAD Sets that will be used to represent this instances data values in the range of a VisAD FlatField.

Overrides:
getRepresentationalSets in class VariableAdapter
Parameters:
copy - If true, then the array is cloned.
Returns:
The VisAD Sets used to represent the data values in the range of a FlatField. WARNING: Modify only under duress.

data

public DataImpl data(dods.dap.DStructure structure,
                     boolean copy)
              throws BadFormException,
                     VisADException,
                     RemoteException
Returns the VisAD DataImpl corresponding to the values of a DODS DStructure and the DODS variable used during construction of this instance.

Overrides:
data in class VariableAdapter
Parameters:
structure - The DODS variable to have the corresponding VisAD data object returned. The variable must be compatible with the variable used to construct this instance.
copy - If true, then data values are copied.
Returns:
The VisAD data object of this instance. The class of the object will be determined by the components of the structure used during construction of this instance. Will be null if the construction structure had no components.
Throws:
BadFormException - The DODS variable is corrupt.
VisADException - VisAD failure. Possibly the variable wasn't compatible with the variable used to construct this instance.
RemoteException - Java RMI failure.