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
Generic node for representing VOTable elements.
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionVOComponentDataNode
(Source xsrc) protected
VOComponentDataNode
(Source xsrc, String elname) -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addVOComponentViews
(DetailViewer dv, uk.ac.starlink.votable.VOElement voel) boolean
TheDefaultDataNode
implementation of this method returnsfalse
.void
No custom configuration is performed.TheDefaultDataNode
implementation of this method throwsUnsupportedOperationException
(DefaultDataNode.allowsChildren()
is false).Gets the factory which should in general be used to generate descendant nodes.Gets a concise description of this object.getName()
Gets the name of this object.TheDefaultDataNode
implementation returns the string "...".Returns a short sentence indicating what kind of node this is.Returns an object which is in some sense the parent of the one this node is based on.Returns a default separator string.static 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
-
Field Details
-
vocel
protected final uk.ac.starlink.votable.VOElement vocel -
systemId
-
-
Constructor Details
-
VOComponentDataNode
- Throws:
NoSuchDataException
-
VOComponentDataNode
- Throws:
NoSuchDataException
-
-
Method Details
-
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
Description copied from class:DefaultDataNode
TheDefaultDataNode
implementation returns the string "...".- Specified by:
getNodeTLA
in interfaceDataNode
- Overrides:
getNodeTLA
in classDefaultDataNode
- Returns:
- "..."
-
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
Description copied from class:DefaultDataNode
Returns a default separator string.- Specified by:
getPathSeparator
in interfaceDataNode
- Overrides:
getPathSeparator
in classDefaultDataNode
- Returns:
- "."
-
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 aDataNode
, it is something which may get fed to aDataNodeFactory
to createDataNode
. 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
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
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
TheDefaultDataNode
implementation of this method returnsfalse
.- 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
Description copied from class:DefaultDataNode
TheDefaultDataNode
implementation of this method throwsUnsupportedOperationException
(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
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
-
getSource
Returns a DOM source associated with a given VO Element.- Parameters:
voel
- element- Returns:
- source
-