uk.ac.starlink.datanode.nodes
Class ARYDataNode

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

public class ARYDataNode
extends HDSDataNode

A DataNode representing an ARY object.

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

Field Summary
 
Fields inherited from class uk.ac.starlink.datanode.nodes.HDSDataNode
MAX_CHILDREN_PER_ARRAY
 
Constructor Summary
ARYDataNode(ArrayStructure aryobj)
          Constructs and ARYDataNode from an ArrayStrucutre.
ARYDataNode(HDSObject hobj)
          Constructs an ARYDataNode from an HDSObject.
ARYDataNode(String path)
          Constructs an ARYDataNode from an HDS path.
 
Method Summary
 void configureDetail(DetailViewer dv)
          No custom configuration is performed.
 DataNodeFactory getChildMaker()
          Removes the possibility of creating certain types of data node prior to setting the factory (ARY, NDF, WCS).
 Object getDataObject(DataType dtype)
          The DefaultDataNode implementation returns any data object which has been registered using DefaultDataNode.registerDataObject(uk.ac.starlink.datanode.nodes.DataType, java.lang.Object).
 String getDescription()
          Gets a concise description of this object.
 Icon getIcon()
          Returns a default icon, unless setIconID has been called, in which case it returns the one indicated by that call.
 String getNodeTLA()
          Returns the string "ARY".
 String getNodeType()
          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 using DefaultDataNode.registerDataObject(uk.ac.starlink.datanode.nodes.DataType, java.lang.Object).
 void setChildMaker(DataNodeFactory childMaker)
          Sets the factory which should in general be used to generate child nodes.
 
Methods inherited from class uk.ac.starlink.datanode.nodes.HDSDataNode
allowsChildren, getChildIterator, getHDSFromFile, getHDSFromPath, getName, getParentObject, getPathElement, getPathSeparator, isMagic
 
Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode
beep, getCreator, getLabel, makeChild, makeErrorChild, registerDataObject, 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

ARYDataNode

public ARYDataNode(HDSObject hobj)
            throws NoSuchDataException
Constructs an ARYDataNode from an HDSObject.

Throws:
NoSuchDataException

ARYDataNode

public ARYDataNode(ArrayStructure aryobj)
            throws NoSuchDataException
Constructs and ARYDataNode from an ArrayStrucutre.

Throws:
NoSuchDataException

ARYDataNode

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

Throws:
NoSuchDataException
Method Detail

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

getNodeTLA

public String getNodeTLA()
Returns the string "ARY".

Specified by:
getNodeTLA in interface DataNode
Overrides:
getNodeTLA in class HDSDataNode
Returns:
"ARY"

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

getIcon

public Icon getIcon()
Description copied from class: DefaultDataNode
Returns a default icon, unless setIconID has been called, in which case it returns the one indicated by that call.

Specified by:
getIcon in interface DataNode
Overrides:
getIcon in class DefaultDataNode
Returns:
an icon representing this node

getChildMaker

public DataNodeFactory getChildMaker()
Removes the possibility of creating certain types of data node prior to setting the factory (ARY, NDF, WCS). These can never be descendants of an ARY, but the descendants of an ARY can sometimes look like they are one of these to the factory.

Specified by:
getChildMaker in interface DataNode
Overrides:
getChildMaker in class DefaultDataNode
Returns:
the factory used for generating children

setChildMaker

public void setChildMaker(DataNodeFactory childMaker)
Description copied from interface: DataNode
Sets the factory which should in general be used to generate child nodes. This is not necessarily the factory which is used for generating children of this node, since this node may have special procedures for generating children. However it is the factory which should in general be used for creating descendants of this node.

This method should only be used by applications which wish to restrict the type of node which can appear in a whole subtree of the node hierarchy. The childMaker is normally inherited from parent to child, so for instance customising the childMaker of the tree root by removing certain builders will prevent such nodes from appearing anywhere in the tree.

Specified by:
setChildMaker in interface DataNode
Overrides:
setChildMaker in class DefaultDataNode
Parameters:
childMaker - the factory to use for generating children

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 HDSDataNode
Parameters:
dv - the detail viewer which this node is given an opportunity to configure

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(uk.ac.starlink.datanode.nodes.DataType, java.lang.Object).

Specified by:
hasDataObject in interface DataNode
Overrides:
hasDataObject in class HDSDataNode
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(uk.ac.starlink.datanode.nodes.DataType, java.lang.Object).

Specified by:
getDataObject in interface DataNode
Overrides:
getDataObject in class HDSDataNode
Parameters:
dtype - data object type of interest
Returns:
data object of type type
Throws:
DataObjectException


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