Package uk.ac.starlink.datanode.nodes
Class ImageHDUDataNode
java.lang.Object
uk.ac.starlink.datanode.nodes.DefaultDataNode
uk.ac.starlink.datanode.nodes.HDUDataNode
uk.ac.starlink.datanode.nodes.ImageHDUDataNode
- All Implemented Interfaces:
DataNode
An implementation of the
DataNode
interface for
representing Header and Data Units (HDUs) in FITS files.- Version:
- $Id$
- Author:
- Mark Taylor (Starlink)
-
Constructor Summary
ConstructorsConstructorDescriptionImageHDUDataNode
(nom.tam.fits.Header hdr, FITSDataNode.ArrayDataMaker hdudata) Initialises anImageHDUDataNode
from aHeader
object. -
Method Summary
Modifier and TypeMethodDescriptionboolean
The DefaultDataNode implementation of this method returns false.void
No custom configuration is performed.The DefaultDataNode implementation of this method throws UnsupportedOperationException (DefaultDataNode.allowsChildren()
is false).getDataObject
(DataType dtype) The DefaultDataNode 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.The DefaultDataNode implementation returns the string "...".Returns a short sentence indicating what kind of node this is.boolean
hasDataObject
(DataType dtype) The DefaultDataNode implementation returns true for only those data objects which have been registered usingDefaultDataNode.registerDataObject(uk.ac.starlink.datanode.nodes.DataType, java.lang.Object)
.Methods inherited from class uk.ac.starlink.datanode.nodes.HDUDataNode
getHDUIndex, getHduType, getHeader, getPathElement, getPathSeparator
Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode
beep, getChildMaker, getCreator, getIcon, getLabel, getName, getParentObject, makeChild, makeErrorChild, registerDataObject, setChildMaker, setCreator, setDescription, setIconID, setLabel, setName, setParentObject, toString
-
Constructor Details
-
ImageHDUDataNode
public ImageHDUDataNode(nom.tam.fits.Header hdr, FITSDataNode.ArrayDataMaker hdudata) throws NoSuchDataException Initialises anImageHDUDataNode
from aHeader
object.- Parameters:
hdr
- a FITS header object from which the node is to be created.hdudata
- an object capable of returning the array data for the image- Throws:
NoSuchDataException
-
-
Method Details
-
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 classHDUDataNode
- Returns:
true
if the node is of a type which can have child nodes,false
otherwise
-
getChildIterator
Description copied from class:DefaultDataNode
The DefaultDataNode implementation of this method throws UnsupportedOperationException (DefaultDataNode.allowsChildren()
is false).- Specified by:
getChildIterator
in interfaceDataNode
- Overrides:
getChildIterator
in classDefaultDataNode
- Returns:
- an
Iterator
over the children. Each object iterated over should be aDataNode
. Behaviour is undefined if this method is called on an object for whichallowsChildren
returnsfalse
.
-
configureDetail
Description copied from class:DefaultDataNode
No custom configuration is performed.- Specified by:
configureDetail
in interfaceDataNode
- Overrides:
configureDetail
in classHDUDataNode
- Parameters:
dv
- the detail viewer which this node is given an opportunity to configure
-
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
The DefaultDataNode 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
The DefaultDataNode 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
The DefaultDataNode 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
-