forms/qa/org/openoffice/xforms/Instance.java

   1 /*
   2  * To change this template, choose Tools | Templates
   3  * and open the template in the editor.
   4  */
   5
   6 package org.openoffice.xforms;
   7
   8 import com.sun.star.xml.dom.DOMException;
   9 import com.sun.star.xml.dom.XDocument;
  10 import com.sun.star.xml.dom.XNode;
  11 import com.sun.star.xml.dom.XNodeList;
  12 import java.util.NoSuchElementException;
  13
  14 /**
  15  *
  16  * @author fs93730
  17  */
  18 public class Instance
  19 {
  20     private Model           m_model;
  21     private XDocument       m_domInstance;
  22
  23     protected Instance( Model _model, XDocument _domInstance )
  24     {
  25         m_model = _model;
  26         m_domInstance = _domInstance;
  27     }
  28
  29     /** creates a new element in the instance
  30      *
  31      * The element will be inserted immediately below the root node of the instance.
  32      *
  33      * @param _elementName
  34      *      the name of the to-be-created element
  35      * @return
  36      *      the node of the newly created element
  37      * @throws com.sun.star.xml.dom.DOMException
  38      */
  39     public XNode createElement( String _elementName ) throws DOMException
  40     {
  41         return createElement( m_domInstance, _elementName, null );
  42     }
  43
  44     /** creates a new element in the instance
  45      *
  46      * The element will be inserted immediately below the root node of the instance.
  47      *
  48      * @param _elementName
  49      *      the name of the to-be-created element
  50      * @param _initialNodeValue
  51      *      the initial value to set at the node. Might be null, in this case no value is set.
  52      * @return
  53      *      the node of the newly created element
  54      * @throws com.sun.star.xml.dom.DOMException
  55      */
  56     public XNode createElement( String _elementName, String _initialNodeValue ) throws DOMException
  57     {
  58         return createElement( m_domInstance, _elementName, _initialNodeValue );
  59     }
  60
  61     /** creates a new element in the instance
  62      *
  63      * The element will be inserted immediately below a given XNode.
  64      *
  65      * @param _parentElement
  66      *      the node whose child shall be created
  67      * @param _elementName
  68      *      the name of the to-be-created element
  69      * @return
  70      *      the node of the newly created element
  71      * @throws com.sun.star.xml.dom.DOMException
  72      */
  73     public XNode createElement( XNode _parentElement, String _elementName ) throws DOMException
  74     {
  75         return createElement( _parentElement, _elementName, null );
  76     }
  77
  78     /** creates a new element in the instance
  79      *
  80      * The element will be inserted immediately below a given XNode.
  81      *
  82      * @param _parentElement
  83      *      the node whose child shall be created
  84      * @param _elementName
  85      *      the name of the to-be-created element
  86      * @param _initialNodeValue
  87      *      the initial value to set at the node. Might be null, in this case no value is set.
  88      * @return
  89      *      the node of the newly created element
  90      * @throws com.sun.star.xml.dom.DOMException
  91      */
  92     public XNode createElement( XNode _parentElement, String _elementName, String _initialNodeValue ) throws DOMException
  93     {
  94         XNode node = _parentElement.appendChild(
  95             m_model.getUIHelper().createElement( _parentElement, _elementName )
  96         );
  97         if ( _initialNodeValue != null )
  98             node.setNodeValue( _initialNodeValue );
  99         return node;
 100     }
 101
 102     /** removes a child of the root-level node from the instance
 103      *
 104      * @param _elementName
 105      *  the name of the to-be-removed child
 106      */
 107     public XNode removeNode( String _elementName ) throws DOMException
 108     {
 109         return removeNode( m_domInstance, _elementName );
 110     }
 111
 112     /** removes a node from the instance
 113      *
 114      * @param _parentElement
 115      *  the node whose child is to be removed
 116      * @param _elementName
 117      *  the name of the to-be-removed child
 118      */
 119     public XNode removeNode( XNode _parentElement, String _elementName ) throws DOMException
 120     {
 121         XNodeList nodes = _parentElement.getChildNodes();
 122         for ( int i=0; i<nodes.getLength(); ++i )
 123         {
 124             XNode node = nodes.item(i);
 125             if ( node.getLocalName().equals( _elementName ) )
 126             {
 127                 _parentElement.removeChild( node );
 128                 return node;
 129             }
 130         }
 131         throw new NoSuchElementException();
 132     }
 133
 134     /** creates an attribute for the root node of the instance
 135      *
 136      * @param _attribName
 137      *      the name of the to-be-created attribute
 138      * @return
 139      *      the DOM node, which has already been inserted into the DOM tree
 140      * @throws com.sun.star.xml.dom.DOMException
 141      */
 142     public XNode createAttribute( String _attribName ) throws DOMException
 143     {
 144         return createAttribute( m_domInstance, _attribName, null );
 145     }
 146
 147     /** creates an attribute for the root node of the instance
 148      *
 149      * @param _attribName
 150      *      the name of the to-be-created attribute
 151      * @param _initialNodeValue
 152      *      the initial value to set at the node. Might be null, in this case no value is set.
 153      * @return
 154      *      the DOM node, which has already been inserted into the DOM tree
 155      * @throws com.sun.star.xml.dom.DOMException
 156      */
 157     public XNode createAttribute( String _attribName, String _initialNodeValue ) throws DOMException
 158     {
 159         return createAttribute( m_domInstance, _attribName, _initialNodeValue );
 160     }
 161
 162     /** creates an attribute for the given node
 163      *
 164      * @param _parentElement
 165      *      the element at which the attribute should be created
 166      * @param _attribName
 167      *      the name of the to-be-created attribute
 168      * @return
 169      *      the DOM node, which has already been inserted into the DOM tree
 170      * @throws com.sun.star.xml.dom.DOMException
 171      */
 172     public XNode createAttribute( XNode _parentElement, String _attribName ) throws DOMException
 173     {
 174         return createAttribute( _parentElement, _attribName, null );
 175     }
 176
 177     /** creates an attribute for the given node
 178      *
 179      * @param _parentElement
 180      *      the element at which the attribute should be created
 181      * @param _attribName
 182      *      the name of the to-be-created attribute
 183      * @param _initialNodeValue
 184      *      the initial value to set at the node. Might be null, in this case no value is set.
 185      * @return
 186      *      the DOM node, which has already been inserted into the DOM tree
 187      * @throws com.sun.star.xml.dom.DOMException
 188      */
 189     public XNode createAttribute( XNode _parentElement, String _attribName, String _initialNodeValue ) throws DOMException
 190     {
 191         XNode node = _parentElement.appendChild(
 192             m_model.getUIHelper().createAttribute( _parentElement, _attribName )
 193         );
 194         if ( _initialNodeValue != null )
 195             node.setNodeValue( _initialNodeValue );
 196         return node;
 197     }
 198 }