| org.geotools.xml.Node
All known Subclasses: org.geotools.xml.impl.NodeImpl,
| Node | | public interface Node (Code) | | Represents a value in the parse tree. A node has a corresponds to a
particular instance component of a document (element or attribute). Each node
contains a parsed value, as well as a reference to the instance.
author:
Justin Deoliveira,Refractions Research Inc.,jdeolive@refractions.net |
| Method Summary | |
| Node | getAttribute(String name)
Returns the node corresonding to the attribute with the specified name. | | Node | getAttribute(Class clazz)
Returns the node corresponding to the attribute which has a parsed value
which is an instance of clazz. | | Object | getAttributeValue(String name)
Helper method for access to the parsed value of the attribute with
the specified name.
Parameters:
name - The name of the attribute in which to retreive the parsedvalue from. | | Object | getAttributeValue(Class clazz)
Helper method for access to the parsed value of the attribute whose
parsed value is an instance of clazz. | | List | getAttributeValues(Class clazz)
Helper method for access ot the parsed values of attribute nodes whose
parsed values are instances of clazz.
Parameters:
clazz - The class of parsed attribute values. | | List | getAttributes()
Returns all nodes corresponding to attributes. | | List | getAttributes(Class clazz)
Returns all nodes corresponding to attributes which has a parsed values
which are instances of clazz.
Parameters:
clazz - The class of parsed attribute values. | | Node | getChild(String name)
Returns a node corresponding to a child element. | | Node | getChild(Class clazz)
Returns a node corresponding to a child element which has a parsed value
which is an instance of clazz. | | Object | getChildValue(int index)
Helper method for access to child's parsed contents. | | Object | getChildValue(String name)
Helper method for access to child's parsed contents by element name.
In the event that the node has multiple children mathing name
the first encountered is returned, there is no guarantee of order. | | Object | getChildValue(Class clazz)
Helper method for access to child's parsed contents by class.
In the event that the node has multiple children which are instances of
clazz, the first is returned, there is no guarantee of
order. | | List | getChildValues(String name)
Helper method for access to the set of parse child values with the
specified name.
Parameters:
name - The name of the child element in which to retreive theparsed value. | | List | getChildValues(Class clazz)
Helper method for access to the set of parsed child values which are
instances of the specified class.
Parameters:
clazz - The class of the child values. | | List | getChildren()
Returns all nodes corresponding child elements. | | List | getChildren(String name)
Returns all nodes corresponding child elements with the specified name.
This method returns an empty list if it finds no nodes corresponding to
the specified name.
Parameters:
name - The name of a child element. | | List | getChildren(Class clazz)
Returns all nodes corresponding to child elements with the parsed values
that are instances of clazz
Parameters:
clazz - The class of parsed child values. | | InstanceComponent | getComponent()
| | Object | getValue()
| | boolean | hasAttribute(String name)
Determines if the node has an attribute with the specified name. | | boolean | hasAttribute(Class clazz)
Determines if the node has an attribute whose value is of the specified class. | | boolean | hasChild(String name)
Determines if the node has a child with the specified name.
Parameters:
name - The name of a child node. | | boolean | hasChild(Class clazz)
Determines if the node has a child whose value is of the specified class.
Parameters:
clazz - The class of the child node value. | | void | setValue(Object value)
Sets the value of the node. |
| getAttribute | | Node getAttribute(String name)(Code) | | Returns the node corresonding to the attribute with the specified name.
This method returns null if it finds no such attribute node matching the
specified name.
Parameters:
name - The name of the attribute. |
| getAttribute | | Node getAttribute(Class clazz)(Code) | | Returns the node corresponding to the attribute which has a parsed value
which is an instance of clazz. In the event that the node
contains multple attributes matching the above criteria, the first
encountered is returned, with no guaratnee of order. For all nodes
matching this criteria use
Node.getAttributes(Class) .
Parameters:
clazz - The class of parsed attribute values. The attribute node whose parsed value is an instance ofclazz, or null if no such node exists. |
| getAttributeValue | | Object getAttributeValue(String name)(Code) | | Helper method for access to the parsed value of the attribute with
the specified name.
Parameters:
name - The name of the attribute in which to retreive the parsedvalue from. the parsed value of the attribute matching the criteria, ornull if no such attribute is found. |
| getAttributeValue | | Object getAttributeValue(Class clazz)(Code) | | Helper method for access to the parsed value of the attribute whose
parsed value is an instance of clazz. In the event that the
node contains multple attributes matching the above criteria, the first
encountered is returned, with no guaratnee of order. For all values
matching this criteria use
Node.getAttributeValues(Class) .
Parameters:
clazz - The class of parsed attribute values. the parsed value of the attribute matching the criteria, ornull if no such attribute is found. |
| getAttributeValues | | List getAttributeValues(Class clazz)(Code) | | Helper method for access ot the parsed values of attribute nodes whose
parsed values are instances of clazz.
Parameters:
clazz - The class of parsed attribute values. The list of attribute values which are instances ofclazz, or an empty list. |
| getAttributes | | List getAttributes()(Code) | | Returns all nodes corresponding to attributes.
A list containing objects of type node. |
| getAttributes | | List getAttributes(Class clazz)(Code) | | Returns all nodes corresponding to attributes which has a parsed values
which are instances of clazz.
Parameters:
clazz - The class of parsed attribute values. A list of attribute nodes whose parsed values are instances ofclazz, or an empty list. |
| getChild | | Node getChild(String name)(Code) | | Returns a node corresponding to a child element. This method returns the
first such node it finds and no order is guaranteed, it is provided for
convenience. This method returns null if it finds no such child node
matching the specified name.
Parameters:
name - The name of a child element. The first node that matches a child element with the specifiedname. |
| getChild | | Node getChild(Class clazz)(Code) | | Returns a node corresponding to a child element which has a parsed value
which is an instance of clazz. This method returns the
first such node it finds an dno order is guarenteed, it is providedd
for convenience. This method returns null if it finds no
such child mathing the above criteria.
Parameters:
clazz - The class of the parsed value of a child element. The first node found, or null. |
| getChildValue | | Object getChildValue(int index)(Code) | | Helper method for access to child's parsed contents.
Should be in the range of getChildren().size()
Simple helper method for the contents of getChildren:
return ((Node)getChildren.get( index )).getValue();
Parameters:
index - the value of the child at the given index |
| getChildValue | | Object getChildValue(String name)(Code) | | Helper method for access to child's parsed contents by element name.
In the event that the node has multiple children mathing name
the first encountered is returned, there is no guarantee of order. For a
list of all values matching name use
Node.getChildValues(String) .
the value of the child with the given name, or null if the childdoes not exist. |
| getChildValue | | Object getChildValue(Class clazz)(Code) | | Helper method for access to child's parsed contents by class.
In the event that the node has multiple children which are instances of
clazz, the first is returned, there is no guarantee of
order. For a list of all values which are instances of clazz
use
Node.getChildValues(Class) .
the value of the child which is an instance of clazz,or null if no such child exists.
Parameters:
clazz - |
| getChildValues | | List getChildValues(String name)(Code) | | Helper method for access to the set of parse child values with the
specified name.
Parameters:
name - The name of the child element in which to retreive theparsed value. A list of values representing the parsed values of the children,or an empty list of no such values exist. |
| getChildValues | | List getChildValues(Class clazz)(Code) | | Helper method for access to the set of parsed child values which are
instances of the specified class.
Parameters:
clazz - The class of the child values. A list of child values which are instances of class,or an empty list if no such values exist. |
| getChildren | | List getChildren()(Code) | | Returns all nodes corresponding child elements.
A list containing objects of type Node. |
| getChildren | | List getChildren(String name)(Code) | | Returns all nodes corresponding child elements with the specified name.
This method returns an empty list if it finds no nodes corresponding to
the specified name.
Parameters:
name - The name of a child element. A list containing objects of type Node. |
| getChildren | | List getChildren(Class clazz)(Code) | | Returns all nodes corresponding to child elements with the parsed values
that are instances of clazz
Parameters:
clazz - The class of parsed child values. A list containing objects of type Node, such that node#getValue()is an instance of clazz, or an empty list. |
| getValue | | Object getValue()(Code) | | The parsed value of the instance component. |
| hasAttribute | | boolean hasAttribute(String name)(Code) | | Determines if the node has an attribute with the specified name.
Parameters:
name - The name of an attribute true if am attribute exists with the name, otehrwise false. |
| hasAttribute | | boolean hasAttribute(Class clazz)(Code) | | Determines if the node has an attribute whose value is of the specified class.
Parameters:
clazz - The class of the attribute value true if an attribute exists with the class, otherwise false. |
| hasChild | | boolean hasChild(String name)(Code) | | Determines if the node has a child with the specified name.
Parameters:
name - The name of a child node. true if a child node exists with the name, otehrwise false. |
| hasChild | | boolean hasChild(Class clazz)(Code) | | Determines if the node has a child whose value is of the specified class.
Parameters:
clazz - The class of the child node value. true if a child node exists with the class, otherwise false. |
| setValue | | void setValue(Object value)(Code) | | Sets the value of the node.
Parameters:
value - The new parse value. |
|
|