Package uk.ac.starlink.datanode.nodes
Class HDUDataNode
- java.lang.Object
-
- uk.ac.starlink.datanode.nodes.DefaultDataNode
-
- uk.ac.starlink.datanode.nodes.HDUDataNode
-
- All Implemented Interfaces:
DataNode
- Direct Known Subclasses:
ImageHDUDataNode
,TableHDUDataNode
public class HDUDataNode extends DefaultDataNode
An implementation of theDataNode
interface for representing a general Header and Data Unit (HDU) in FITS files.- Version:
- $Id$
- Author:
- Mark Taylor (Starlink)
-
-
Constructor Summary
Constructors Constructor Description HDUDataNode(nom.tam.fits.Header hdr, FITSDataNode.ArrayDataMaker hdudata)
Initialises aHDUDataNode
from aHeader
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
allowsChildren()
The DefaultDataNode implementation of this method returns false.void
configureDetail(DetailViewer dv)
No custom configuration is performed.java.lang.String
getDescription()
Gets a concise description of this object.int
getHDUIndex()
protected java.lang.String
getHduType()
protected nom.tam.fits.Header
getHeader()
java.lang.String
getNodeTLA()
The DefaultDataNode implementation returns the string "...".java.lang.String
getNodeType()
Returns a short sentence indicating what kind of node this is.java.lang.String
getPathElement()
The DefaultDataNode implementation returns the label as a default path element.java.lang.String
getPathSeparator()
Returns a default separator string.-
Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode
beep, getChildIterator, getChildMaker, getCreator, getDataObject, getIcon, getLabel, getName, getParentObject, hasDataObject, makeChild, makeErrorChild, registerDataObject, setChildMaker, setCreator, setDescription, setIconID, setLabel, setName, setParentObject, toString
-
-
-
-
Constructor Detail
-
HDUDataNode
public HDUDataNode(nom.tam.fits.Header hdr, FITSDataNode.ArrayDataMaker hdudata) throws NoSuchDataException
Initialises aHDUDataNode
from aHeader
object.- Parameters:
hdr
- a FITS header object from which the node is to be createdhdudata
- an object capable of returning the HDU data- Throws:
NoSuchDataException
-
-
Method Detail
-
allowsChildren
public boolean allowsChildren()
Description copied from class:DefaultDataNode
The DefaultDataNode implementation of this method returns false.- Specified by:
allowsChildren
in interfaceDataNode
- Overrides:
allowsChildren
in classDefaultDataNode
- Returns:
true
if the node is of a type which can have child nodes,false
otherwise
-
configureDetail
public void configureDetail(DetailViewer dv)
Description copied from class:DefaultDataNode
No custom configuration is performed.- Specified by:
configureDetail
in interfaceDataNode
- Overrides:
configureDetail
in classDefaultDataNode
- Parameters:
dv
- the detail viewer which this node is given an opportunity to configure
-
getDescription
public java.lang.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 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 classDefaultDataNode
- Returns:
- a short string describing this object
-
getNodeTLA
public java.lang.String getNodeTLA()
Description copied from class:DefaultDataNode
The DefaultDataNode implementation returns the string "...".- Specified by:
getNodeTLA
in interfaceDataNode
- Overrides:
getNodeTLA
in classDefaultDataNode
- Returns:
- "..."
-
getNodeType
public java.lang.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 interfaceDataNode
- Overrides:
getNodeType
in classDefaultDataNode
- Returns:
- a short description of the type of this
DataNode
-
getPathSeparator
public java.lang.String getPathSeparator()
Description copied from class:DefaultDataNode
Returns a default separator string.- Specified by:
getPathSeparator
in interfaceDataNode
- Overrides:
getPathSeparator
in classDefaultDataNode
- Returns:
- "."
-
getPathElement
public java.lang.String getPathElement()
Description copied from class:DefaultDataNode
The DefaultDataNode implementation returns the label as a default path element.- Specified by:
getPathElement
in interfaceDataNode
- Overrides:
getPathElement
in classDefaultDataNode
- Returns:
- the node's label
-
getHDUIndex
public int getHDUIndex()
-
getHduType
protected java.lang.String getHduType()
-
getHeader
protected nom.tam.fits.Header getHeader()
-
-