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)protectedVOComponentDataNode(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 voidaddVOComponentViews(DetailViewer dv, uk.ac.starlink.votable.VOElement voel)booleanallowsChildren()The DefaultDataNode implementation of this method returns false.voidconfigureDetail(DetailViewer dv)No custom configuration is performed.java.util.IteratorgetChildIterator()The DefaultDataNode implementation of this method throws UnsupportedOperationException (DefaultDataNode.allowsChildren()is false).DataNodeFactorygetChildMaker()Gets the factory which should in general be used to generate descendant nodes.java.lang.StringgetDescription()Gets a concise description of this object.java.lang.StringgetName()Gets the name of this object.java.lang.StringgetNodeTLA()The DefaultDataNode implementation returns the string "...".java.lang.StringgetNodeType()Returns a short sentence indicating what kind of node this is.java.lang.ObjectgetParentObject()Returns an object which is in some sense the parent of the one this node is based on.java.lang.StringgetPathSeparator()Returns a default separator string.static javax.xml.transform.dom.DOMSourcegetSource(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:DataNodeGets the name of this object. This is an intrinsic property of the object.- Specified by:
getNamein interfaceDataNode- Overrides:
getNamein classDefaultDataNode- Returns:
- the name of the object
-
getNodeTLA
public java.lang.String getNodeTLA()
Description copied from class:DefaultDataNodeThe DefaultDataNode implementation returns the string "...".- Specified by:
getNodeTLAin interfaceDataNode- Overrides:
getNodeTLAin classDefaultDataNode- Returns:
- "..."
-
getNodeType
public java.lang.String getNodeType()
Description copied from interface:DataNodeReturns 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:
getNodeTypein interfaceDataNode- Overrides:
getNodeTypein classDefaultDataNode- Returns:
- a short description of the type of this
DataNode
-
getPathSeparator
public java.lang.String getPathSeparator()
Description copied from class:DefaultDataNodeReturns a default separator string.- Specified by:
getPathSeparatorin interfaceDataNode- Overrides:
getPathSeparatorin classDefaultDataNode- Returns:
- "."
-
getParentObject
public java.lang.Object getParentObject()
Description copied from interface:DataNodeReturns 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:
getParentObjectin interfaceDataNode- Overrides:
getParentObjectin classDefaultDataNode- Returns:
- an object which is the parent of this one, or null
-
getDescription
public java.lang.String getDescription()
Description copied from interface:DataNodeGets 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 thegetNamemethod, since they may be presented together. It should be on one line, and preferably no longer than around 70 characters. Thenullvalue may be returned if there is nothing to say.- Specified by:
getDescriptionin interfaceDataNode- Overrides:
getDescriptionin classDefaultDataNode- Returns:
- a short string describing this object
-
getChildMaker
public DataNodeFactory getChildMaker()
Description copied from interface:DataNodeGets the factory which should in general be used to generate descendant nodes.- Specified by:
getChildMakerin interfaceDataNode- Overrides:
getChildMakerin classDefaultDataNode- Returns:
- the factory used for generating children
-
allowsChildren
public boolean allowsChildren()
Description copied from class:DefaultDataNodeThe DefaultDataNode implementation of this method returns false.- Specified by:
allowsChildrenin interfaceDataNode- Overrides:
allowsChildrenin classDefaultDataNode- Returns:
trueif the node is of a type which can have child nodes,falseotherwise
-
getChildIterator
public java.util.Iterator getChildIterator()
Description copied from class:DefaultDataNodeThe DefaultDataNode implementation of this method throws UnsupportedOperationException (DefaultDataNode.allowsChildren()is false).- Specified by:
getChildIteratorin interfaceDataNode- Overrides:
getChildIteratorin classDefaultDataNode- Returns:
- an
Iteratorover the children. Each object iterated over should be aDataNode. Behaviour is undefined if this method is called on an object for whichallowsChildrenreturnsfalse.
-
configureDetail
public void configureDetail(DetailViewer dv)
Description copied from class:DefaultDataNodeNo custom configuration is performed.- Specified by:
configureDetailin interfaceDataNode- Overrides:
configureDetailin 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
-
-