uk.ac.starlink.datanode.nodes
Class WCSDataNode

java.lang.Object
  extended by uk.ac.starlink.datanode.nodes.DefaultDataNode
      extended by uk.ac.starlink.datanode.nodes.WCSDataNode
All Implemented Interfaces:
DataNode

public class WCSDataNode
extends DefaultDataNode

A DataNode representing the WCS component of an NDF.

Version:
$Id$
Author:
Mark Taylor (STARLINK)

Constructor Summary
WCSDataNode(FrameSet wcs)
          Constructs a WCSDataNode from a FrameSet object.
WCSDataNode(HDSObject hobj)
          Constructs a WCSDataNode from an HDS object.
WCSDataNode(Source xsrc)
          Constructs a WCSDataNode from an XML Source.
WCSDataNode(String path)
          Constructs a WCSDataNode from an HDS path.
 
Method Summary
 boolean allowsChildren()
          The DefaultDataNode implementation of this method returns false.
 void configureDetail(DetailViewer dv)
          No custom configuration is performed.
 Iterator getChildIterator()
          Gets the children of this node.
 String getDescription()
          Gets a concise description of this object.
 String getNodeTLA()
          The DefaultDataNode implementation returns the string "...".
 String getNodeType()
          Returns a short sentence indicating what kind of node this is.
 String getPathSeparator()
          Returns a default separator string.
 FrameSet getWcs()
           
 
Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode
beep, getChildMaker, getCreator, getDataObject, getIcon, getLabel, getName, getParentObject, getPathElement, hasDataObject, makeChild, makeErrorChild, registerDataObject, setChildMaker, setCreator, setDescription, setIconID, setLabel, setName, setParentObject, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WCSDataNode

public WCSDataNode(FrameSet wcs)
            throws NoSuchDataException
Constructs a WCSDataNode from a FrameSet object.

Throws:
NoSuchDataException

WCSDataNode

public WCSDataNode(HDSObject hobj)
            throws NoSuchDataException
Constructs a WCSDataNode from an HDS object.

Throws:
NoSuchDataException

WCSDataNode

public WCSDataNode(String path)
            throws NoSuchDataException
Constructs a WCSDataNode from an HDS path.

Throws:
NoSuchDataException

WCSDataNode

public WCSDataNode(Source xsrc)
            throws NoSuchDataException
Constructs a WCSDataNode from an XML Source.

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 interface DataNode
Overrides:
allowsChildren in class DefaultDataNode
Returns:
true if the node is of a type which can have child nodes, false otherwise

getChildIterator

public Iterator getChildIterator()
Gets the children of this node. This consists of the frames of which this frameset consists, one per child.

Specified by:
getChildIterator in interface DataNode
Overrides:
getChildIterator in class DefaultDataNode
Returns:
an array of children of this node

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 DefaultDataNode
Returns:
a short string describing this object

getPathSeparator

public String getPathSeparator()
Description copied from class: DefaultDataNode
Returns a default separator string.

Specified by:
getPathSeparator in interface DataNode
Overrides:
getPathSeparator in class DefaultDataNode
Returns:
"."

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 DefaultDataNode
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 DefaultDataNode
Returns:
a short description of the type of this DataNode

configureDetail

public void configureDetail(DetailViewer dv)
Description copied from class: DefaultDataNode
No custom configuration is performed.

Specified by:
configureDetail in interface DataNode
Overrides:
configureDetail in class DefaultDataNode
Parameters:
dv - the detail viewer which this node is given an opportunity to configure

getWcs

public FrameSet getWcs()


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.