Package uk.ac.starlink.datanode.nodes
Class TableHDUDataNode
java.lang.Object
uk.ac.starlink.datanode.nodes.DefaultDataNode
uk.ac.starlink.datanode.nodes.HDUDataNode
uk.ac.starlink.datanode.nodes.TableHDUDataNode
- All Implemented Interfaces:
DataNode
An implementation of the
DataNode
interface for
representing binary or ASCII tables in FITS HDUs.- Version:
- $Id$
- Author:
- Mark Taylor (Starlink)
-
Constructor Summary
ConstructorsConstructorDescriptionTableHDUDataNode
(nom.tam.fits.Header header, FITSDataNode.ArrayDataMaker hdudata) Initialises aTableHDUDataNode
from anHeader
object. -
Method Summary
Modifier and TypeMethodDescriptionboolean
TheDefaultDataNode
implementation of this method returnsfalse
.getDataObject
(DataType dtype) TheDefaultDataNode
implementation returns any data object which has been registered usingDefaultDataNode.registerDataObject(uk.ac.starlink.datanode.nodes.DataType, java.lang.Object)
.Gets a concise description of this object.TheDefaultDataNode
implementation returns the string "...".Returns a short sentence indicating what kind of node this is.uk.ac.starlink.table.StarTable
Returns the StarTable containing the data.boolean
hasDataObject
(DataType dtype) TheDefaultDataNode
implementation returns true for only those data objects which have been registered usingDefaultDataNode.registerDataObject(uk.ac.starlink.datanode.nodes.DataType, java.lang.Object)
.boolean
Methods inherited from class uk.ac.starlink.datanode.nodes.HDUDataNode
configureDetail, getHDUIndex, getHduType, getHeader, getPathElement, getPathSeparator
Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode
beep, getChildIterator, getChildMaker, getCreator, getIcon, getLabel, getName, getParentObject, makeChild, makeErrorChild, registerDataObject, setChildMaker, setCreator, setDescription, setIconID, setLabel, setName, setParentObject, toString
-
Constructor Details
-
TableHDUDataNode
public TableHDUDataNode(nom.tam.fits.Header header, FITSDataNode.ArrayDataMaker hdudata) throws NoSuchDataException Initialises aTableHDUDataNode
from anHeader
object. The stream is read to the end of the HDU.- Parameters:
header
- a FITS header object from which the node is to be createdhdudata
- object which can supply the data stream where the data resides- Throws:
NoSuchDataException
-
-
Method Details
-
getStarTable
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
TheDefaultDataNode
implementation of this method returnsfalse
.- Specified by:
allowsChildren
in interfaceDataNode
- Overrides:
allowsChildren
in classHDUDataNode
- Returns:
true
if the node is of a type which can have child nodes,false
otherwise
-
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 thegetName
method, since they may be presented together. It should be on one line, and preferably no longer than around 70 characters. Thenull
value may be returned if there is nothing to say.- Specified by:
getDescription
in interfaceDataNode
- Overrides:
getDescription
in classHDUDataNode
- Returns:
- a short string describing this object
-
getNodeTLA
Description copied from class:DefaultDataNode
TheDefaultDataNode
implementation returns the string "...".- Specified by:
getNodeTLA
in interfaceDataNode
- Overrides:
getNodeTLA
in classHDUDataNode
- Returns:
- "..."
-
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 interfaceDataNode
- Overrides:
getNodeType
in classHDUDataNode
- Returns:
- a short description of the type of this
DataNode
-
hasDataObject
Description copied from class:DefaultDataNode
TheDefaultDataNode
implementation returns true for only those data objects which have been registered usingDefaultDataNode.registerDataObject(uk.ac.starlink.datanode.nodes.DataType, java.lang.Object)
.- Specified by:
hasDataObject
in interfaceDataNode
- Overrides:
hasDataObject
in classDefaultDataNode
- Parameters:
dtype
- data object type of interest- Returns:
- true iff a subsequent call of
getDataObject(type)
is likely to be successful
-
getDataObject
Description copied from class:DefaultDataNode
TheDefaultDataNode
implementation returns any data object which has been registered usingDefaultDataNode.registerDataObject(uk.ac.starlink.datanode.nodes.DataType, java.lang.Object)
.- Specified by:
getDataObject
in interfaceDataNode
- Overrides:
getDataObject
in classDefaultDataNode
- Parameters:
dtype
- data object type of interest- Returns:
- data object of type
type
- Throws:
DataObjectException
-