Class OutputAttribute

  • All Implemented Interfaces:
    Node, OutputNode

    class OutputAttribute
    extends java.lang.Object
    implements OutputNode
    The OutputAttribute object is used to represent a node added to the output node map. It represents a simple name value pair that is used as an attribute by an output element. This shares its namespaces with the parent element so that any namespaces added to the attribute are actually added to the parent element, which ensures correct scoping.
    See Also:
    Node
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String name
      Represents the name of this node object instance.
      private java.lang.String reference
      Represents the namespace reference for this node.
      private NamespaceMap scope
      This contains the namespaces for the parent element.
      private OutputNode source
      Represents the output node that this node requires.
      private java.lang.String value
      Represents the value of this node object instance.
    • Constructor Summary

      Constructors 
      Constructor Description
      OutputAttribute​(OutputNode source, java.lang.String name, java.lang.String value)
      Constructor for the OutputAttribute object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void commit()
      The commit method is used flush and commit any child nodes that have been created by this node.
      NodeMap<OutputNode> getAttributes()
      This returns a NodeMap which can be used to add nodes to the element before that element has been committed.
      OutputNode getChild​(java.lang.String name)
      This is used to create a child element within the element that this object represents.
      java.lang.String getComment()
      This is used to get the text comment for the element.
      Mode getMode()
      The Mode is used to indicate the output mode of this node.
      java.lang.String getName()
      Returns the name of the node that this represents.
      NamespaceMap getNamespaces()
      This returns the NamespaceMap for this node.
      OutputNode getParent()
      This is used to acquire the Node that is the parent of this node.
      java.lang.String getPrefix()
      This is used to acquire the prefix for this output node.
      java.lang.String getPrefix​(boolean inherit)
      This is used to acquire the prefix for this output node.
      java.lang.String getReference()
      This is used to acquire the namespace URI reference associated with this node.
      java.lang.String getValue()
      Returns the value for the node that this represents.
      boolean isCommitted()
      This is used to determine whether the node has been committed.
      boolean isRoot()
      This method is used to determine if this node is the root node for the XML document.
      void remove()
      This is used to remove any uncommitted changes.
      OutputNode setAttribute​(java.lang.String name, java.lang.String value)
      This method is used for convinience to add an attribute node to the attribute NodeMap.
      void setComment​(java.lang.String comment)
      This is used to set a text comment to the element.
      void setData​(boolean data)
      This is used to set the output mode of this node to either be CDATA or escaped.
      void setMode​(Mode mode)
      This is used to set the output mode of this node to either be CDATA, escaped, or inherited.
      void setName​(java.lang.String name)
      This is used to change the name of an output node.
      void setReference​(java.lang.String reference)
      This is used to set the reference for the node.
      void setValue​(java.lang.String value)
      This is used to set a text value to the attribute.
      java.lang.String toString()
      This is used to acquire the name and value of the attribute.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • scope

        private NamespaceMap scope
        This contains the namespaces for the parent element.
      • source

        private OutputNode source
        Represents the output node that this node requires.
      • reference

        private java.lang.String reference
        Represents the namespace reference for this node.
      • name

        private java.lang.String name
        Represents the name of this node object instance.
      • value

        private java.lang.String value
        Represents the value of this node object instance.
    • Constructor Detail

      • OutputAttribute

        public OutputAttribute​(OutputNode source,
                               java.lang.String name,
                               java.lang.String value)
        Constructor for the OutputAttribute object. This is used to create a simple name value pair attribute holder.
        Parameters:
        name - this is the name that is used for the node
        value - this is the value used for the node
    • Method Detail

      • getValue

        public java.lang.String getValue()
        Returns the value for the node that this represents. This is a modifiable property for the node and can be changed. When set this forms the value the attribute contains in the parent XML element, which is written in quotations.
        Specified by:
        getValue in interface Node
        Returns:
        the name of the value for this node instance
      • setValue

        public void setValue​(java.lang.String value)
        This is used to set a text value to the attribute. This should be added to the attribute if the attribute is to be written to the parent element. Without a value this is invalid.
        Specified by:
        setValue in interface OutputNode
        Parameters:
        value - this is the text value to add to this attribute
      • setName

        public void setName​(java.lang.String name)
        This is used to change the name of an output node. This will only affect the name of the node if the node has not yet been committed. If the node is committed then this will not be reflected in the resulting XML generated.
        Specified by:
        setName in interface OutputNode
        Parameters:
        name - this is the name to change the node to
      • getName

        public java.lang.String getName()
        Returns the name of the node that this represents. This is an immutable property and should not change for any node. If this is null then the attribute will not be added to the node map, all attributes must have a valid key.
        Specified by:
        getName in interface Node
        Returns:
        returns the name of the node that this represents
      • getParent

        public OutputNode getParent()
        This is used to acquire the Node that is the parent of this node. This will return the node that is the direct parent of this node and allows for siblings to make use of nodes with their parents if required.
        Specified by:
        getParent in interface Node
        Specified by:
        getParent in interface OutputNode
        Returns:
        this returns the parent node for this node
      • getAttributes

        public NodeMap<OutputNode> getAttributes()
        This returns a NodeMap which can be used to add nodes to the element before that element has been committed. Nodes can be removed or added to the map and will appear as attributes on the written element when it is committed.
        Specified by:
        getAttributes in interface OutputNode
        Returns:
        returns the node map used to manipulate attributes
      • getChild

        public OutputNode getChild​(java.lang.String name)
        This is used to create a child element within the element that this object represents. When a new child is created with this method then the previous child is committed to the document. The created OutputNode object can be used to add attributes to the child element as well as other elements.
        Specified by:
        getChild in interface OutputNode
        Parameters:
        name - this is the name of the child element to create
      • getComment

        public java.lang.String getComment()
        This is used to get the text comment for the element. This can be null if no comment has been set. If no comment is set on the node then no comment will be written to the resulting XML.
        Specified by:
        getComment in interface OutputNode
        Returns:
        this is the comment associated with this element
      • setComment

        public void setComment​(java.lang.String comment)
        This is used to set a text comment to the element. This will be written just before the actual element is written. Only a single comment can be set for each output node written.
        Specified by:
        setComment in interface OutputNode
        Parameters:
        comment - this is the comment to set on the node
      • getMode

        public Mode getMode()
        The Mode is used to indicate the output mode of this node. Three modes are possible, each determines how a value, if specified, is written to the resulting XML document. This is determined by the setData method which will set the output to be CDATA or escaped, if neither is specified the mode is inherited.
        Specified by:
        getMode in interface OutputNode
        Returns:
        this returns the mode of this output node object
      • setMode

        public void setMode​(Mode mode)
        This is used to set the output mode of this node to either be CDATA, escaped, or inherited. If the mode is set to data then any value specified will be written in a CDATA block, if this is set to escaped values are escaped. If however this method is set to inherited then the mode is inherited from the parent node.
        Specified by:
        setMode in interface OutputNode
        Parameters:
        mode - this is the output mode to set the node to
      • setData

        public void setData​(boolean data)
        This is used to set the output mode of this node to either be CDATA or escaped. If this is set to true the any value specified will be written in a CDATA block, if this is set to false the values is escaped. If however this method is never invoked then the mode is inherited from the parent.
        Specified by:
        setData in interface OutputNode
        Parameters:
        data - if true the value is written as a CDATA block
      • getPrefix

        public java.lang.String getPrefix()
        This is used to acquire the prefix for this output node. If the output node is an element then this will search its parent nodes until the prefix that is currently in scope is found. If however this node is an attribute then the hierarchy of nodes is not searched as attributes to not inherit namespaces.
        Specified by:
        getPrefix in interface OutputNode
        Returns:
        this returns the prefix associated with this node
      • getPrefix

        public java.lang.String getPrefix​(boolean inherit)
        This is used to acquire the prefix for this output node. If the output node is an element then this will search its parent nodes until the prefix that is currently in scope is found. If however this node is an attribute then the hierarchy of nodes is not searched as attributes to not inherit namespaces.
        Specified by:
        getPrefix in interface OutputNode
        Parameters:
        inherit - if there is no explicit prefix then inherit
        Returns:
        this returns the prefix associated with this node
      • getReference

        public java.lang.String getReference()
        This is used to acquire the namespace URI reference associated with this node. Although it is recommended that the namespace reference is a URI it does not have to be, it can be any unique identifier that can be used to distinguish the qualified names.
        Specified by:
        getReference in interface OutputNode
        Returns:
        this returns the namespace URI reference for this
      • setReference

        public void setReference​(java.lang.String reference)
        This is used to set the reference for the node. Setting the reference implies that the node is a qualified node within the XML document. Both elements and attributes can be qualified. Depending on the prefix set on this node or, failing that, any parent node for the reference, the element will appear in the XML document with that string prefixed to the node name.
        Specified by:
        setReference in interface OutputNode
        Parameters:
        reference - this is used to set the reference for the node
      • getNamespaces

        public NamespaceMap getNamespaces()
        This returns the NamespaceMap for this node. Only an element can have namespaces, so if this node represents an attribute the elements namespaces will be provided when this is requested. By adding a namespace it becomes in scope for the current element all all child elements of that element.
        Specified by:
        getNamespaces in interface OutputNode
        Returns:
        this returns the namespaces associated with the node
      • setAttribute

        public OutputNode setAttribute​(java.lang.String name,
                                       java.lang.String value)
        This method is used for convinience to add an attribute node to the attribute NodeMap. The attribute added can be removed from the element by useing the node map.
        Specified by:
        setAttribute in interface OutputNode
        Parameters:
        name - this is the name of the attribute to be added
        value - this is the value of the node to be added
        Returns:
        this returns the node that has just been added
      • remove

        public void remove()
        This is used to remove any uncommitted changes. Removal of an output node can only be done if it has no siblings and has not yet been committed. If the node is committed then this will throw an exception to indicate that it cannot be removed.
        Specified by:
        remove in interface OutputNode
      • commit

        public void commit()
        The commit method is used flush and commit any child nodes that have been created by this node. This allows the output to be completed when building of the XML document has been completed. If output fails an exception is thrown.
        Specified by:
        commit in interface OutputNode
      • isRoot

        public boolean isRoot()
        This method is used to determine if this node is the root node for the XML document. The root node is the first node in the document and has no sibling nodes. This is false if the node has a parent node or a sibling node.
        Specified by:
        isRoot in interface OutputNode
        Returns:
        true if this is the root node within the document
      • isCommitted

        public boolean isCommitted()
        This is used to determine whether the node has been committed. If the node has been committed, then this will return true. When committed the node can no longer produce child nodes.
        Specified by:
        isCommitted in interface OutputNode
        Returns:
        true if this node has already been committed
      • toString

        public java.lang.String toString()
        This is used to acquire the name and value of the attribute. Implementing this method ensures that debugging the output node is simplified as it is possible to get the actual value.
        Overrides:
        toString in class java.lang.Object
        Returns:
        this returns the details of this output node