Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XalanSourceTreeProcessingInstruction.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(XALANSOURCETREEPROCESSINGINSTRUCTION_HEADER_GUARD_1357924680)
00058 #define XALANSOURCETREEPROCESSINGINSTRUCTION_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 #include <XalanDOM/XalanProcessingInstruction.hpp>
00067 
00068 
00069 
00070 #include <XalanDOM/XalanDOMString.hpp>
00071 
00072 
00073 
00074 class XalanSourceTreeComment;
00075 class XalanSourceTreeDocument;
00076 class XalanSourceTreeElement;
00077 class XalanSourceTreeText;
00078 
00079 
00080 
00081 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeProcessingInstruction : public XalanProcessingInstruction
00082 {
00083 public:
00084 
00098     XalanSourceTreeProcessingInstruction(
00099             const XalanDOMString&       theTarget,
00100             const XalanDOMString&       theData,
00101             XalanSourceTreeDocument*    theOwnerDocument,
00102             XalanSourceTreeElement*     theParentElement = 0,
00103             XalanNode*                  thePreviousSibling = 0,
00104             XalanNode*                  theNextSibling = 0,
00105             unsigned int                theIndex = 0);
00106 
00107     virtual
00108     ~XalanSourceTreeProcessingInstruction();
00109 
00110 
00111     // These interfaces are inherited from XalanNode...
00112 
00113     virtual const XalanDOMString&
00114     getNodeName() const;
00115 
00119     virtual const XalanDOMString&
00120     getNodeValue() const;
00121 
00125     virtual NodeType
00126     getNodeType() const;
00127 
00137     virtual XalanNode*
00138     getParentNode() const;
00139 
00153     virtual const XalanNodeList*
00154     getChildNodes() const;
00155 
00161     virtual XalanNode*
00162     getFirstChild() const;
00163 
00169     virtual XalanNode*
00170     getLastChild() const;
00171 
00177     virtual XalanNode*
00178     getPreviousSibling() const;
00179 
00185     virtual XalanNode*
00186     getNextSibling() const;
00187 
00192     virtual const XalanNamedNodeMap*
00193     getAttributes() const;
00194 
00204     virtual XalanDocument*
00205     getOwnerDocument() const;
00206 
00208 
00210 
00229 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00230     virtual XalanNode*
00231 #else
00232     virtual XalanSourceTreeProcessingInstruction*
00233 #endif
00234     cloneNode(bool deep) const;
00235 
00237 
00239 
00256     virtual XalanNode*
00257     insertBefore(
00258             XalanNode*  newChild,
00259             XalanNode*  refChild);
00260 
00274     virtual XalanNode*
00275     replaceChild(
00276             XalanNode*  newChild,
00277             XalanNode*  oldChild);
00278 
00286     virtual XalanNode*
00287     removeChild(XalanNode*  oldChild);
00288 
00300     virtual XalanNode*
00301     appendChild(XalanNode*  newChild);
00302 
00304 
00306 
00314     virtual bool
00315     hasChildNodes() const;
00316 
00317 
00319 
00321 
00322 
00336     virtual void
00337     setNodeValue(const XalanDOMString&  nodeValue);
00338 
00340 
00342 
00359     virtual void
00360     normalize();
00361 
00375     virtual bool
00376     supports(
00377             const XalanDOMString&   feature,
00378             const XalanDOMString&   version) const;
00379 
00393     virtual const XalanDOMString&
00394     getNamespaceURI() const;
00395 
00400     virtual const XalanDOMString&
00401     getPrefix() const;
00402 
00410     virtual const XalanDOMString&
00411     getLocalName() const;
00412 
00442     virtual void
00443     setPrefix(const XalanDOMString& prefix);
00444 
00445     virtual bool
00446     isIndexed() const;
00447 
00448     virtual unsigned long
00449     getIndex() const;
00450 
00452 
00453     // These interfaces are inherited from XalanProcessingInstruction...
00454 
00456 
00458 
00464     virtual const XalanDOMString&
00465     getTarget() const;
00466 
00476     virtual const XalanDOMString&
00477     getData() const;
00478 
00480 
00482 
00490     virtual void
00491     setData(const XalanDOMString&   data);
00493 
00494 
00495     // public interfaces not inherited from XalanProcessingInstruction...
00496 
00497     XalanSourceTreeElement*
00498     getParentElement() const
00499     {
00500         return m_parentElement;
00501     }
00502 
00503     void
00504     setParentElement(XalanSourceTreeElement*    theParentElement)
00505     {
00506         m_parentElement = theParentElement;
00507     }
00508 
00509     void
00510     setPreviousSibling(XalanSourceTreeComment*  thePreviousSibling);
00511 
00512     void
00513     setPreviousSibling(XalanSourceTreeElement*  thePreviousSibling);
00514 
00515     void
00516     setPreviousSibling(XalanSourceTreeProcessingInstruction*    thePreviousSibling);
00517 
00518     void
00519     setPreviousSibling(XalanSourceTreeText*     thePreviousSibling);
00520 
00521     void
00522     appendSiblingNode(XalanSourceTreeComment*   theSibling);
00523 
00524     void
00525     appendSiblingNode(XalanSourceTreeElement*   theSibling);
00526 
00527     void
00528     appendSiblingNode(XalanSourceTreeProcessingInstruction*     theSibling);
00529 
00530     void
00531     appendSiblingNode(XalanSourceTreeText*  theSibling);
00532 
00533     void
00534     setIndex(unsigned int   theIndex)
00535     {
00536         m_index = theIndex;
00537     }
00538 
00539 protected:
00540 
00541     XalanSourceTreeProcessingInstruction(
00542             const XalanSourceTreeProcessingInstruction&     theSource,
00543             bool                                            deep = false);
00544 
00545 private:
00546 
00547     // Not implemented...
00548     XalanSourceTreeProcessingInstruction&
00549     operator=(const XalanSourceTreeProcessingInstruction&   theSource);
00550 
00551     bool
00552     operator==(const XalanSourceTreeProcessingInstruction&      theRHS) const;
00553 
00554 
00555     // Data members...
00556     const XalanDOMString&       m_target;
00557 
00558     const XalanDOMString&       m_data;
00559 
00560     XalanSourceTreeDocument*    m_ownerDocument;
00561 
00562     XalanSourceTreeElement*     m_parentElement;
00563 
00564     XalanNode*                  m_previousSibling;
00565 
00566     XalanNode*                  m_nextSibling;
00567 
00568     unsigned int                m_index;
00569 };
00570 
00571 
00572 
00573 #endif  // !defined(XALANSOURCETREEPROCESSINGINSTRUCTION_HEADER_GUARD_1357924680)

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.