|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.datanode.nodes.DefaultDataNode
uk.ac.starlink.datanode.nodes.NdxDataNode
public class NdxDataNode
An implementation of the DataNode interface for representing
Ndx
objects.
Constructor Summary | |
---|---|
NdxDataNode(File file)
|
|
NdxDataNode(HDSObject hobj)
Initialises an NdxDataNode from an NDF structure. |
|
NdxDataNode(Source xsrc)
Initialises an NdxDataNode from an XML source. |
|
NdxDataNode(String loc)
Initialises an NdxDataNode from a string giving a URL or filename. |
|
NdxDataNode(XMLDocument xdoc)
Constructs a new NdxDataNode from an XML document. |
Method Summary | |
---|---|
boolean |
allowsChildren()
The DefaultDataNode implementation of this method returns false. |
void |
configureDetail(DetailViewer dv)
No custom configuration is performed. |
Iterator |
getChildIterator()
The DefaultDataNode implementation of this method throws UnsupportedOperationException ( DefaultDataNode.allowsChildren() is false). |
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 |
getName()
Gets the name 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 |
getPathElement()
The DefaultDataNode implementation returns the label as a default path element. |
String |
getPathSeparator()
Returns a default separator string. |
Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode |
---|
beep, getChildMaker, getCreator, getDataObject, getLabel, getParentObject, 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 |
---|
public NdxDataNode(String loc) throws NoSuchDataException
loc
- the location of a readable Ndx
NoSuchDataException
public NdxDataNode(File file) throws NoSuchDataException
NoSuchDataException
public NdxDataNode(HDSObject hobj) throws NoSuchDataException
hobj
- an HDSObject, which should reference an NDF structure
NoSuchDataException
public NdxDataNode(Source xsrc) throws NoSuchDataException
xsrc
- a Source containing the XML representation of the Ndx
NoSuchDataException
public NdxDataNode(XMLDocument xdoc) throws NoSuchDataException
NoSuchDataException
Method Detail |
---|
public String getDescription()
DataNode
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.
getDescription
in interface DataNode
getDescription
in class DefaultDataNode
public boolean allowsChildren()
DefaultDataNode
allowsChildren
in interface DataNode
allowsChildren
in class DefaultDataNode
true
if the node is of a type which can have
child nodes, false
otherwisepublic Iterator getChildIterator()
DefaultDataNode
DefaultDataNode.allowsChildren()
is false).
getChildIterator
in interface DataNode
getChildIterator
in class DefaultDataNode
Iterator
over the children. Each object
iterated over should be a DataNode
.
Behaviour is undefined if this method is called on an
object for which allowsChildren
returns
false
.public String getName()
DataNode
getName
in interface DataNode
getName
in class DefaultDataNode
public String getNodeTLA()
DefaultDataNode
getNodeTLA
in interface DataNode
getNodeTLA
in class DefaultDataNode
public String getNodeType()
DataNode
getNodeType
in interface DataNode
getNodeType
in class DefaultDataNode
DataNode
public Icon getIcon()
DefaultDataNode
getIcon
in interface DataNode
getIcon
in class DefaultDataNode
public String getPathElement()
DefaultDataNode
getPathElement
in interface DataNode
getPathElement
in class DefaultDataNode
public String getPathSeparator()
DefaultDataNode
getPathSeparator
in interface DataNode
getPathSeparator
in class DefaultDataNode
public void configureDetail(DetailViewer dv)
DefaultDataNode
configureDetail
in interface DataNode
configureDetail
in class DefaultDataNode
dv
- the detail viewer which this node is given an opportunity
to configure
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |