XMLDataNode (Starjava Datanode API)

java.lang.Object
- uk.ac.starlink.datanode.nodes.DefaultDataNode
- - uk.ac.starlink.datanode.nodes.XMLDataNode

All Implemented Interfaces:: DataNode

public class XMLDataNode
extends DefaultDataNode

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_LINES

Fields
Modifier and Type	Field and Description
`static int`	`MAX_LINES`

Constructor Summary

Constructors
Constructor and Description

XMLDataNode(javax.xml.transform.Source xsrc)

Constructors
Constructor and Description
`XMLDataNode(javax.xml.transform.Source xsrc)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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).
`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.String`	`getPathElement()` The `DefaultDataNode` implementation returns the label as a default path element.
`java.lang.String`	`getPathSeparator()` Returns a default separator string.

Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode
beep, getChildMaker, getCreator, getDataObject, getIcon, 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

- Field Detail
  - MAX_LINES
```
public static final int MAX_LINES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XMLDataNode
```
public XMLDataNode(javax.xml.transform.Source xsrc)
            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 interface DataNode
    
    Overrides:
    
    getName in class DefaultDataNode
    
    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 interface DataNode
    
    Overrides:
    
    getNodeTLA in class DefaultDataNode
    
    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 interface DataNode
    
    Overrides:
    
    getNodeType in class DefaultDataNode
    
    Returns:
    
    a short description of the type of this DataNode
  - getPathElement
```
public java.lang.String getPathElement()
```
    Description copied from class: DefaultDataNode
    
    The DefaultDataNode implementation returns the label as a default path element.
    
    Specified by:
    
    getPathElement in interface DataNode
    
    Overrides:
    
    getPathElement in class DefaultDataNode
    
    Returns:
    
    the node's label
  - getPathSeparator
```
public java.lang.String getPathSeparator()
```
    Description copied from class: DefaultDataNode
    
    Returns a default separator string.
    
    Specified by:
    
    getPathSeparator in interface DataNode
    
    Overrides:
    
    getPathSeparator in class DefaultDataNode
    
    Returns:
    
    "."
  - 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 the 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.
    
    Specified by:
    
    getDescription in interface DataNode
    
    Overrides:
    
    getDescription in class DefaultDataNode
    
    Returns:
    
    a short string describing this object
  - allowsChildren
```
public boolean allowsChildren()
```
    Description copied from class: DefaultDataNode
    
    The DefaultDataNode implementation of this method returns false.
    
    Specified by:
    
    allowsChildren in interface DataNode
    
    Overrides:
    
    allowsChildren in class DefaultDataNode
    
    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 interface DataNode
    
    Overrides:
    
    getChildIterator in class DefaultDataNode
    
    Returns:
    
    an 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.
  - configureDetail
```
public void configureDetail(DetailViewer dv)
```
    Description copied from class: DefaultDataNode
    
    No custom configuration is performed.
    
    Specified by:
    
    configureDetail in interface DataNode
    
    Overrides:
    
    configureDetail in class DefaultDataNode
    
    Parameters:
    
    dv - the detail viewer which this node is given an opportunity to configure

Class XMLDataNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class uk.ac.starlink.datanode.nodes.DefaultDataNode

Methods inherited from class java.lang.Object

Field Detail

MAX_LINES

Constructor Detail

XMLDataNode

Method Detail

getName

getNodeTLA

getNodeType

getPathElement

getPathSeparator

getDescription

allowsChildren

getChildIterator

configureDetail