|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Node
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.
Method Summary | |
---|---|
Node |
getAttribute(Class clazz)
Returns the node corresponding to the attribute which has a parsed value which is an instance of clazz . |
Node |
getAttribute(String name)
Returns the node corresonding to the attribute with the specified name. |
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 . |
Object |
getAttributeValue(Class clazz)
Helper method for access to the parsed value of the attribute whose parsed value is an instance of clazz . |
Object |
getAttributeValue(Class clazz,
Object defaultValue)
Helper method for access to the parsed value of the attribute whose parsed value is an instance of clazz , returning a
defaultValue when no such attribute is present. |
Object |
getAttributeValue(String name)
Helper method for access to the parsed value of the attribute with the specified name. |
Object |
getAttributeValue(String name,
Object defaultValue)
Helper method for access to the parsed value of the attribute with the specified name, returning a defaultValue when no such
attribute is present |
List |
getAttributeValues(Class clazz)
Helper method for access ot the parsed values of attribute nodes whose parsed values are instances of clazz . |
Node |
getChild(Class clazz)
Returns a node corresponding to a child element which has a parsed value which is an instance of clazz . |
Node |
getChild(String name)
Returns a node corresponding to a child element. |
List |
getChildren()
Returns all nodes corresponding child elements. |
List |
getChildren(Class clazz)
Returns all nodes corresponding to child elements with the parsed values that are instances of clazz |
List |
getChildren(String name)
Returns all nodes corresponding child elements with the specified name. |
Object |
getChildValue(Class clazz)
Helper method for access to child's parsed contents by class. |
Object |
getChildValue(Class clazz,
Object defaultValue)
Helper method for access to child's parsed contents by class, returning a defaultValue when no such value is present In the event that the node has multiple children which are instances of clazz , the first is returned, there is no guarantee of
order. |
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. |
Object |
getChildValue(String name,
Object defaultValue)
Helper method for access to child's parsed contents by element name.returning a defaultValue when no such value is present In the event that the node has multiple children mathing name
the first encountered is returned, there is no guarantee of order. |
List |
getChildValues(Class clazz)
Helper method for access to the set of parsed child values which are instances of the specified class. |
List |
getChildValues(String name)
Helper method for access to the set of parse child values with the specified name. |
InstanceComponent |
getComponent()
|
Node |
getParent()
Returns the parent node for this node |
Object |
getValue()
|
boolean |
hasAttribute(Class clazz)
Determines if the node has an attribute whose value is of the specified class. |
boolean |
hasAttribute(String name)
Determines if the node has an attribute with the specified name. |
boolean |
hasChild(Class clazz)
Determines if the node has a child whose value is of the specified class. |
boolean |
hasChild(String name)
Determines if the node has a child with the specified name. |
void |
setParent(Node node)
Sets the parent pointer for this node. |
void |
setValue(Object value)
Sets the value of the node. |
Method Detail |
---|
InstanceComponent getComponent()
Object getValue()
void setValue(Object value)
value
- The new parse value.boolean hasChild(String name)
name
- The name of a child node.
true
if a child node exists with the name, otehrwise false
.boolean hasChild(Class clazz)
clazz
- The class of the child node value.
true
if a child node exists with the class, otherwise false
.List getChildren()
List getChildren(String name)
name
- The name of a child element.
List getChildren(Class clazz)
clazz
clazz
- The class of parsed child values.
clazz, or an empty list.
Node getChild(String name)
name
- The name of a child element.
Node getChild(Class clazz)
clazz
. This method returns the
first such node it finds and no 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.
- Returns:
- The first node found, or null.
Object getChildValue(int index)
Should be in the range of getChildren().size()
Simple helper method for the contents of getChildren:
return ((Node)getChildren.get( index )).getValue();
index
-
Object getChildValue(String 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
getChildValues(String)
.
name
- The name of the child which parsed content is to be retrived.
null
if the child does not exist.Object getChildValue(String name, Object defaultValue)
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
getChildValues(String)
.
name
- The name of the child which parsed content is to be retrived.defaultValue
- A defaultValue to return, if no such child found.
defaultValue
if the child does not exist.Object getChildValue(Class clazz)
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 getChildValues(Class)
.
clazz
- The class of parsed child value.
clazz
,
or null
if no such child exists.Object getChildValue(Class clazz, Object defaultValue)
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 getChildValues(Class)
.
clazz
- The class of parsed child value.defaultValue
- A defaultValue to return, if no such child found.
clazz
,
or defaultValue
if no such child exists.List getChildValues(String name)
name
- The name of the child element in which to retreive the
parsed value.
List getChildValues(Class clazz)
clazz
- The class of the child values.
class,
or an empty list if no such values exist.
boolean hasAttribute(String name)
name
- The name of an attribute
true
if am attribute exists with the name, otehrwise false
.boolean hasAttribute(Class clazz)
clazz
- The class of the attribute value
true
if an attribute exists with the class, otherwise false
.List getAttributes()
List getAttributes(Class clazz)
clazz
.
clazz
- The class of parsed attribute values.
clazz
, or an empty list.Node getAttribute(String name)
name
- The name of the attribute.Node getAttribute(Class clazz)
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 getAttributes(Class)
.
clazz
- The class of parsed attribute values.
clazz
, or null
if no such node exists.Object getAttributeValue(String name)
name
- The name of the attribute in which to retreive the parsed
value from.
null
if no such attribute is found.Object getAttributeValue(String name, Object defaultValue)
defaultValue
when no such
attribute is present
name
- The name of the attribute in which to retreive the parsed
value from.defaultValue
- A defaultValue to return, if no such attribute
found.
defaultValue
if no such attribute is found.Object getAttributeValue(Class clazz)
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 getAttributeValues(Class)
.
clazz
- The class of parsed attribute values.
null
if no such attribute is found.Object getAttributeValue(Class clazz, Object defaultValue)
clazz
, returning a
defaultValue
when no such attribute is present. 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 getAttributeValues(Class)
.
clazz
- The class of parsed attribute values.defaultValue
- A defaultValue to return, if no such attribute
found.
defaultValue
if no such attribute is found.List getAttributeValues(Class clazz)
clazz
.
clazz
- The class of parsed attribute values.
clazz
, or an empty list.Node getParent()
void setParent(Node node)
node
- The new parent node. Passing null will clear the parent pointer.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |