uk.ac.starlink.datanode.nodes

Class FrameDataNode

java.lang.Object

uk.ac.starlink.datanode.nodes.DefaultDataNode

uk.ac.starlink.datanode.nodes.FrameDataNode

All Implemented Interfaces:

DataNode

public class FrameDataNode
extends DefaultDataNode

A DataNode representing an AST Frame object.

Version:

$Id$

Author:

Mark Taylor (Starlink)

Constructor Summary

Constructors

Constructor and Description
FrameDataNode(Frame frame) Creates a FrameDataNode from an AST Frame object.

Method Summary

Modifier and Type	Method and Description
void	configureDetail(DetailViewer dv) No custom configuration is performed.
String	getDescription() Gets a concise description of this object.
String	getName() Gets the name of this object.
String	getNodeTLA() Returns a short string describing the node type.
String	getNodeType() Returns a short sentence indicating what kind of node this is.

Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode

allowsChildren, beep, getChildIterator, getChildMaker, getCreator, getDataObject, getIcon, getLabel, getParentObject, getPathElement, getPathSeparator, 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

FrameDataNode

public FrameDataNode(Frame frame)
              throws NoSuchDataException

Creates a FrameDataNode from an AST Frame object.

Parameters:

frame - the AST Frame on which to base this DataNode

Throws:

NoSuchDataException

Method Detail

getNodeTLA

public String getNodeTLA()

Returns a short string describing the node type.

Specified by:

getNodeTLA in interface DataNode

Overrides:

getNodeTLA in class DefaultDataNode

Returns:

the string "FRM" or "SKY" depending on the type of frame

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

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

getName

public String getName()

Description copied from interface: DataNode

Gets the name of this object. This is an intrinsic property of the object.

Specified by:

getName in interface DataNode

Overrides:

getName in class DefaultDataNode

Returns:

the name of the object

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