Package ucar.nc2.dataset

Class SequenceDS

java.lang.Object
ucar.nc2.CDMNode
ucar.nc2.Variable
ucar.nc2.Structure
ucar.nc2.dataset.StructureDS
ucar.nc2.dataset.SequenceDS
All Implemented Interfaces:
Comparable<VariableSimpleIF>, Iterable<Attribute>, AttributeContainer, Enhancements, VariableEnhanced, ProxyReader, VariableSimpleIF
@Deprecated public class SequenceDS extends StructureDS
Deprecated.
SequenceDS will not extend StructureDS in 6.
Enhanced sequence
Since:
Nov 10, 2009

  • Constructor Details

    • SequenceDS

      public SequenceDS(Group g, Sequence orgSeq)
      Deprecated.

  • Method Details

    • getStructureIterator

      public StructureDataIterator getStructureIterator(int bufferSize) throws IOException
      Deprecated.
      Description copied from class: Structure
      Get an efficient iterator over all the data in the Structure. This is the efficient way to get all the data, it can be much faster than reading one record at a time, and is optimized for large datasets. This is accomplished by buffering bufferSize amount of data at once. 
       Example:

  StructureDataIterator ii = structVariable.getStructureIterator(100 * 1000);
  while (ii.hasNext()) {
    StructureData sdata = ii.next();
  }
      Overrides:
      getStructureIterator in class Structure
      Parameters:
      bufferSize - size in bytes to buffer, set < 0 to use default size
      Returns:
      StructureDataIterator over type StructureData
      Throws:
      IOException - on read error

    • read

      public Array read(Section section) throws IOException
      Deprecated.
      Description copied from class: Variable
      Read a section of the data for this Variable from the netcdf file and return a memory resident Array. The Array has the same element type as the Variable, and the requested shape. Note that this does not do rank reduction, so the returned Array has the same rank as the Variable. Use Array.reduce() for rank reduction.

      If the Variable is a member of an array of Structures, this returns only the variable's data in the first Structure, so that the Array shape is the same as the Variable. To read the data in all structures, use ncfile.readSectionSpec().

      Note this only allows you to specify a subset of this variable. If the variable is nested in an array of structures and you want to subset that, use NetcdfFile.read(String sectionSpec, boolean flatten);

      Overrides:
      read in class Variable
      Parameters:
      section - list of Range specifying the section of data to read. Must be null or same rank as variable. If list is null, assume all data. Each Range corresponds to a Dimension. If the Range object is null, it means use the entire dimension.
      Returns:
      the requested data in a memory-resident Array
      Throws:
      IOException - if error

    • read

      public Array read() throws IOException
      Deprecated.
      Description copied from class: Variable
      Read all the data for this Variable and return a memory resident Array. The Array has the same element type and shape as the Variable.

      If the Variable is a member of an array of Structures, this returns only the variable's data in the first Structure, so that the Array shape is the same as the Variable. To read the data in all structures, use ncfile.readSection().

      Overrides:
      read in class Variable
      Returns:
      the requested data in a memory-resident Array.
      Throws:
      IOException

    • toBuilder

      public SequenceDS.Builder<?> toBuilder()
      Deprecated.
      Description copied from class: Structure
      Turn into a mutable Builder. Can use toBuilder().build() to copy.
      Overrides:
      toBuilder in class StructureDS

    • builder

      public static SequenceDS.Builder<?> builder()
      Deprecated.