Package uk.ac.starlink.datanode.nodes
Class VOComponentDataNode
- java.lang.Object
-
- uk.ac.starlink.datanode.nodes.DefaultDataNode
-
- uk.ac.starlink.datanode.nodes.VOComponentDataNode
-
- All Implemented Interfaces:
DataNode
- Direct Known Subclasses:
VOTableTableDataNode
public class VOComponentDataNode extends DefaultDataNode
Generic node for representing VOTable elements.
-
-
Constructor Summary
Constructors Modifier Constructor Description VOComponentDataNode(javax.xml.transform.Source xsrc)
protected
VOComponentDataNode(javax.xml.transform.Source xsrc, java.lang.String elname)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
addVOComponentViews(DetailViewer dv, uk.ac.starlink.votable.VOElement voel)
boolean
allowsChildren()
The DefaultDataNode implementation of this method returns false.void
configureDetail(DetailViewer dv)
No custom configuration is performed.java.util.Iterator
getChildIterator()
The DefaultDataNode implementation of this method throws UnsupportedOperationException (DefaultDataNode.allowsChildren()
is false).DataNodeFactory
getChildMaker()
Gets the factory which should in general be used to generate descendant nodes.java.lang.String
getDescription()
Gets a concise description of this object.java.lang.String
getName()
Gets the name of this object.java.lang.String
getNodeTLA()
The DefaultDataNode implementation returns the string "...".java.lang.String
getNodeType()
Returns a short sentence indicating what kind of node this is.java.lang.Object
getParentObject()
Returns an object which is in some sense the parent of the one this node is based on.java.lang.String
getPathSeparator()
Returns a default separator string.static javax.xml.transform.dom.DOMSource
getSource(uk.ac.starlink.votable.VOElement voel)
Returns a DOM source associated with a given VO Element.-
Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode
beep, getCreator, getDataObject, getIcon, getLabel, getPathElement, hasDataObject, makeChild, makeErrorChild, registerDataObject, setChildMaker, setCreator, setDescription, setIconID, setLabel, setName, setParentObject, toString
-
-
-
-
Constructor Detail
-
VOComponentDataNode
public VOComponentDataNode(javax.xml.transform.Source xsrc) throws NoSuchDataException
- Throws:
NoSuchDataException
-
VOComponentDataNode
protected VOComponentDataNode(javax.xml.transform.Source xsrc, java.lang.String elname) throws NoSuchDataException
- Throws:
NoSuchDataException
-
-
Method Detail
-
getName
public java.lang.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 interfaceDataNode
- Overrides:
getName
in classDefaultDataNode
- Returns:
- the name of the object
-
getNodeTLA
public java.lang.String getNodeTLA()
Description copied from class:DefaultDataNode
The DefaultDataNode implementation returns the string "...".- Specified by:
getNodeTLA
in interfaceDataNode
- Overrides:
getNodeTLA
in classDefaultDataNode
- Returns:
- "..."
-
getNodeType
public java.lang.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 interfaceDataNode
- Overrides:
getNodeType
in classDefaultDataNode
- Returns:
- a short description of the type of this
DataNode
-
getPathSeparator
public java.lang.String getPathSeparator()
Description copied from class:DefaultDataNode
Returns a default separator string.- Specified by:
getPathSeparator
in interfaceDataNode
- Overrides:
getPathSeparator
in classDefaultDataNode
- Returns:
- "."
-
getParentObject
public java.lang.Object getParentObject()
Description copied from interface:DataNode
Returns an object which is in some sense the parent of the one this node is based on. The parent is not a DataNode, it is something which may get fed to a DataNodeFactory to create DataNode. If no such object exists, which may well be the case, null should be returned.- Specified by:
getParentObject
in interfaceDataNode
- Overrides:
getParentObject
in classDefaultDataNode
- Returns:
- an object which is the parent of this one, or null
-
getDescription
public java.lang.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 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 classDefaultDataNode
- Returns:
- a short string describing this object
-
getChildMaker
public DataNodeFactory getChildMaker()
Description copied from interface:DataNode
Gets the factory which should in general be used to generate descendant nodes.- Specified by:
getChildMaker
in interfaceDataNode
- Overrides:
getChildMaker
in classDefaultDataNode
- Returns:
- the factory used for generating children
-
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 classDefaultDataNode
- Returns:
true
if the node is of a type which can have child nodes,false
otherwise
-
getChildIterator
public java.util.Iterator 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
public void configureDetail(DetailViewer dv)
Description copied from class:DefaultDataNode
No custom configuration is performed.- Specified by:
configureDetail
in interfaceDataNode
- Overrides:
configureDetail
in classDefaultDataNode
- Parameters:
dv
- the detail viewer which this node is given an opportunity to configure
-
addVOComponentViews
public static void addVOComponentViews(DetailViewer dv, uk.ac.starlink.votable.VOElement voel)
-
getSource
public static javax.xml.transform.dom.DOMSource getSource(uk.ac.starlink.votable.VOElement voel)
Returns a DOM source associated with a given VO Element.- Parameters:
voel
- element- Returns:
- source
-
-