Package uk.ac.starlink.datanode.nodes
Class DocumentDataNode
java.lang.Object
uk.ac.starlink.datanode.nodes.DefaultDataNode
uk.ac.starlink.datanode.nodes.DocumentDataNode
- All Implemented Interfaces:
DataNode
- Direct Known Subclasses:
VOTableDataNode
DataNode implementation which describes a top-level XML document.
DOM building is deferred.
- Author:
- Mark Taylor (Starlink)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanThe DefaultDataNode implementation of this method returns false.protected voidcheckTopElement(String localName, String namespaceURI) protected voidcheckTopLocalName(String localName) voidNo custom configuration is performed.The DefaultDataNode implementation of this method throws UnsupportedOperationException (DefaultDataNode.allowsChildren()is false).protected IteratorgetChildIterator(Node parentNode) protected DOMSourceReturns a DOMSource corresponding to the XMLDocument underlying this data node.The DefaultDataNode implementation returns the string "...".Returns a short sentence indicating what kind of node this is.Returns a default separator string.Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode
beep, getChildMaker, getCreator, getDataObject, getDescription, getIcon, getLabel, getName, getParentObject, getPathElement, hasDataObject, makeChild, makeErrorChild, registerDataObject, setChildMaker, setCreator, setDescription, setIconID, setLabel, setName, setParentObject, toString
-
Constructor Details
-
DocumentDataNode
-
DocumentDataNode
- Throws:
NoSuchDataException
-
-
Method Details
-
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
-
getNodeTLA
Description copied from class:DefaultDataNodeThe DefaultDataNode implementation returns the string "...".- Specified by:
getNodeTLAin interfaceDataNode- Overrides:
getNodeTLAin classDefaultDataNode- Returns:
- "..."
-
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
Description copied from class:DefaultDataNodeReturns a default separator string.- Specified by:
getPathSeparatorin interfaceDataNode- Overrides:
getPathSeparatorin classDefaultDataNode- Returns:
- "."
-
checkTopElement
- Throws:
NoSuchDataException
-
checkTopLocalName
- Throws:
NoSuchDataException
-
getChildIterator
-
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
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
-
getDocument
Returns a DOMSource corresponding to the XMLDocument underlying this data node. Its node will be a Document node. If the DOM is not already available a parse will be performed to construct it.- Throws:
IOExceptionSAXException
-