Class TableHDUDataNode

All Implemented Interfaces:
DataNode

public class TableHDUDataNode extends HDUDataNode
An implementation of the DataNode interface for representing binary or ASCII tables in FITS HDUs.
Version:
$Id$
Author:
Mark Taylor (Starlink)
  • Constructor Details

    • TableHDUDataNode

      public TableHDUDataNode(nom.tam.fits.Header header, FITSDataNode.ArrayDataMaker hdudata) throws NoSuchDataException
      Initialises a TableHDUDataNode from an Header object. The stream is read to the end of the HDU.
      Parameters:
      header - a FITS header object from which the node is to be created
      hdudata - object which can supply the data stream where the data resides
      Throws:
      NoSuchDataException
  • Method Details

    • getStarTable

      public uk.ac.starlink.table.StarTable getStarTable() throws IOException
      Returns the StarTable containing the data. Its construction, which involves reading from the stream, is deferred until necessary.
      Returns:
      the StarTable object containing the data for this HDU
      Throws:
      IOException
    • isStarTable

      public boolean isStarTable()
    • allowsChildren

      public boolean allowsChildren()
      Description copied from class: DefaultDataNode
      The DefaultDataNode implementation of this method returns false.
      Specified by:
      allowsChildren in interface DataNode
      Overrides:
      allowsChildren in class HDUDataNode
      Returns:
      true if the node is of a type which can have child nodes, false otherwise
    • getDescription

      public String getDescription()
      Description copied from interface: DataNode
      Gets a concise description of this object. The form of the description will depend on the type of node, but it might detail the shape or type of data represented, or otherwise give some information additional to the name. It should not include the return value of the getName method, since they may be presented together. It should be on one line, and preferably no longer than around 70 characters. The null value may be returned if there is nothing to say.
      Specified by:
      getDescription in interface DataNode
      Overrides:
      getDescription in class HDUDataNode
      Returns:
      a short string describing this object
    • getNodeTLA

      public String getNodeTLA()
      Description copied from class: DefaultDataNode
      The DefaultDataNode implementation returns the string "...".
      Specified by:
      getNodeTLA in interface DataNode
      Overrides:
      getNodeTLA in class HDUDataNode
      Returns:
      "..."
    • getNodeType

      public String getNodeType()
      Description copied from interface: DataNode
      Returns a short sentence indicating what kind of node this is. The return value should be just a few words. As a rough guideline it should indicate what the implementing class is.
      Specified by:
      getNodeType in interface DataNode
      Overrides:
      getNodeType in class HDUDataNode
      Returns:
      a short description of the type of this DataNode
    • hasDataObject

      public boolean hasDataObject(DataType dtype)
      Description copied from class: DefaultDataNode
      The DefaultDataNode implementation returns true for only those data objects which have been registered using DefaultDataNode.registerDataObject(DataType, Object).
      Specified by:
      hasDataObject in interface DataNode
      Overrides:
      hasDataObject in class DefaultDataNode
      Parameters:
      dtype - data object type of interest
      Returns:
      true iff a subsequent call of getDataObject(type) is likely to be successful
    • getDataObject

      public Object getDataObject(DataType dtype) throws DataObjectException
      Description copied from class: DefaultDataNode
      The DefaultDataNode implementation returns any data object which has been registered using DefaultDataNode.registerDataObject(DataType, Object).
      Specified by:
      getDataObject in interface DataNode
      Overrides:
      getDataObject in class DefaultDataNode
      Parameters:
      dtype - data object type of interest
      Returns:
      data object of type type
      Throws:
      DataObjectException