Home » Castor-1.3-src » org.exolab.castor » types » [javadoc | source]
org.exolab.castor.types
public final class: AnyNode [javadoc | source]
java.lang.Object
   org.exolab.castor.types.AnyNode

All Implemented Interfaces:
    Serializable

A class used to represent an XML node. This is an alternative to DOM which is too heavy for our purpose (mainly handle XML Fragment when {@literal } is used in an XML schema). The model is based on XPath Node. An AnyNode can be a:
Field Summary
public static final  short ELEMENT    Representation for an element node. 
public static final  short ATTRIBUTE    Representation for an attribute node. 
public static final  short NAMESPACE    Representation for a Namespace node. 
public static final  short PI    Representation for a processing instruction node. 
public static final  short COMMENT    Representation for a comment node. 
public static final  short TEXT    Representation for a text node. 
Constructor:
 public AnyNode() 
 public AnyNode(short type,
    String localName,
    String prefix,
    String uri,
    String value) 
    Creates a node given all the necessary information: type, localName, prefix, uri and value. This constructor is not user-friendly and launched RunTime exception is you try to instantiate non-valid node.
    Parameters:
    type - the node type.
    localName - the name of the node.
    prefix - the prefix if any of the namespace.
    uri - the namespace uri of this node.
    value - the value of this node.
Method from org.exolab.castor.types.AnyNode Summary:
addAnyNode,   addAttribute,   addChild,   addNamespace,   appendSibling,   getFirstAttribute,   getFirstChild,   getFirstChildNode,   getFirstNamespace,   getLocalName,   getNamespacePrefix,   getNamespaceURI,   getNextSibling,   getNodeType,   getStringValue,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.exolab.castor.types.AnyNode Detail:
 public  void addAnyNode(AnyNode node) 
    Adds an AnyNode to the current node
 public  void addAttribute(AnyNode node) 
    Adds an attribute to the current node.
 public  void addChild(AnyNode node) 

    Adds a child AnyNode to this node. A 'child' can be either an ELEMENT node, a COMMENT node, a TEXT node or a PROCESSING INSTRUCTION. If the current node already has a child then the node to add will be append as a sibling.

    Note: you cannot add a child to a TEXT node.

 public  void addNamespace(AnyNode node) 
    Appends an namespace to the current node.
 protected  void appendSibling(AnyNode node) 
    Appends a sibling AnyNode to the current node. The node to append will be added at the end of the sibling branch.
 public AnyNode getFirstAttribute() 
    Returns the first attribute of the current ELEMENT node or null. The next attribute,if any,is the sibling of the returned node.
 public AnyNode getFirstChild() 
    Returns the first Child node of this node. A 'child' can be either an ELEMENT node, a COMMENT node, a TEXT node or a PROCESSING INSTRUCTION.
 protected AnyNode getFirstChildNode() 
    Returns the first child node in the tree.
 public AnyNode getFirstNamespace() 
    Returns the first namespace of the current ELEMENT node or null. The next attribute if any is the sibling of the returned node.
 public String getLocalName() 
    Returns the local name of the node. Returns the local name of an element or attribute, the prefix of a namespace node, the target of a processing instruction, or null for all other node types.
 public String getNamespacePrefix() 
    Returns the namespace prefix associated with the namespace URI of this node. Returns null if no prefix. is defined for this namespace URI. Returns an empty string if the default prefix is associated with this namespace URI.
 public String getNamespaceURI() 
    Returns the namespace URI of the node. Returns the namespace URI of an element, attribute or namespace node, or null for all other node types.
 public AnyNode getNextSibling() 
    Returns the next sibling of the current node. When the AnyNode is an ATTRIBUTE, it will return the next ATTRIBUTE node. When the AnyNode is a NAMESPACE, it will return the next NAMESPACE node.
 public short getNodeType() 
    Returns the type of this node.
 public String getStringValue() 
    Returns the string value of the node. The string value of a text node or an attribute node is its text value. The string value of an element or a root node is the concatenation of the string value of all its child nodes. The string value of a namespace node is its namespace URI. The string value of a processing instruction is the instruction, and the string value of a comment is the comment text.
 public String toString() 
    Returns the String representation of this AnyNode. The String representation is a xml well-formed fragment corresponding to the representation of this node.