Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

Main Page   Namespace List   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 XalanSourceTreeDocumentFragment;
00077 class XalanSourceTreeElement;
00078 class XalanSourceTreeText;
00079 
00080 
00081 
00082 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeProcessingInstruction : public XalanProcessingInstruction
00083 {
00084 public:
00085 
00099     XalanSourceTreeProcessingInstruction(
00100             const XalanDOMString&       theTarget,
00101             const XalanDOMString&       theData,
00102             XalanSourceTreeDocument*    theOwnerDocument,
00103             XalanNode*                  theParentNode = 0,
00104             XalanNode*                  thePreviousSibling = 0,
00105             XalanNode*                  theNextSibling = 0,
00106             unsigned int                theIndex = 0);
00107 
00108     virtual
00109     ~XalanSourceTreeProcessingInstruction();
00110 
00111 
00112     // These interfaces are inherited from XalanNode...
00113 
00114     virtual const XalanDOMString&
00115     getNodeName() const;
00116 
00120     virtual const XalanDOMString&
00121     getNodeValue() const;
00122 
00126     virtual NodeType
00127     getNodeType() const;
00128 
00138     virtual XalanNode*
00139     getParentNode() const;
00140 
00154     virtual const XalanNodeList*
00155     getChildNodes() const;
00156 
00162     virtual XalanNode*
00163     getFirstChild() const;
00164 
00170     virtual XalanNode*
00171     getLastChild() const;
00172 
00178     virtual XalanNode*
00179     getPreviousSibling() const;
00180 
00186     virtual XalanNode*
00187     getNextSibling() const;
00188 
00193     virtual const XalanNamedNodeMap*
00194     getAttributes() const;
00195 
00205     virtual XalanDocument*
00206     getOwnerDocument() const;
00207 
00208     //@}
00210     //@{
00211 
00230 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00231     virtual XalanNode*
00232 #else
00233     virtual XalanSourceTreeProcessingInstruction*
00234 #endif
00235     cloneNode(bool deep) const;
00236 
00237     //@}
00239     //@{
00240 
00257     virtual XalanNode*
00258     insertBefore(
00259             XalanNode*  newChild,
00260             XalanNode*  refChild);
00261 
00275     virtual XalanNode*
00276     replaceChild(
00277             XalanNode*  newChild,
00278             XalanNode*  oldChild);
00279 
00287     virtual XalanNode*
00288     removeChild(XalanNode*  oldChild);
00289 
00301     virtual XalanNode*
00302     appendChild(XalanNode*  newChild);
00303 
00304     //@}
00306     //@{
00307 
00315     virtual bool
00316     hasChildNodes() const;
00317 
00318 
00319     //@}
00321     //@{
00322 
00323 
00337     virtual void
00338     setNodeValue(const XalanDOMString&  nodeValue);
00339 
00340     //@}
00342     //@{
00343 
00360     virtual void
00361     normalize();
00362 
00376     virtual bool
00377     isSupported(
00378             const XalanDOMString&   feature,
00379             const XalanDOMString&   version) const;
00380 
00394     virtual const XalanDOMString&
00395     getNamespaceURI() const;
00396 
00401     virtual const XalanDOMString&
00402     getPrefix() const;
00403 
00411     virtual const XalanDOMString&
00412     getLocalName() const;
00413 
00443     virtual void
00444     setPrefix(const XalanDOMString& prefix);
00445 
00446     virtual bool
00447     isIndexed() const;
00448 
00449     virtual unsigned long
00450     getIndex() const;
00451 
00452     //@}
00453 
00454     // These interfaces are inherited from XalanProcessingInstruction...
00455 
00456     //@}
00458     //@{
00465     virtual const XalanDOMString&
00466     getTarget() const;
00467 
00477     virtual const XalanDOMString&
00478     getData() const;
00479 
00480     //@}
00482     //@{
00491     virtual void
00492     setData(const XalanDOMString&   data);
00493     //@}
00494 
00495 
00496     // public interfaces not inherited from XalanProcessingInstruction...
00497 
00498     void
00499     setParent(XalanSourceTreeElement*   theParent);
00500 
00501     void
00502     setParent(XalanSourceTreeDocumentFragment*  theParent);
00503 
00504     void
00505     setPreviousSibling(XalanSourceTreeComment*  thePreviousSibling);
00506 
00507     void
00508     setPreviousSibling(XalanSourceTreeElement*  thePreviousSibling);
00509 
00510     void
00511     setPreviousSibling(XalanSourceTreeProcessingInstruction*    thePreviousSibling);
00512 
00513     void
00514     setPreviousSibling(XalanSourceTreeText*     thePreviousSibling);
00515 
00516     void
00517     appendSiblingNode(XalanSourceTreeComment*   theSibling);
00518 
00519     void
00520     appendSiblingNode(XalanSourceTreeElement*   theSibling);
00521 
00522     void
00523     appendSiblingNode(XalanSourceTreeProcessingInstruction*     theSibling);
00524 
00525     void
00526     appendSiblingNode(XalanSourceTreeText*  theSibling);
00527 
00528     void
00529     setIndex(unsigned int   theIndex)
00530     {
00531         m_index = theIndex;
00532     }
00533 
00534 protected:
00535 
00536     XalanSourceTreeProcessingInstruction(
00537             const XalanSourceTreeProcessingInstruction&     theSource,
00538             bool                                            deep = false);
00539 
00540 private:
00541 
00542     // Not implemented...
00543     XalanSourceTreeProcessingInstruction&
00544     operator=(const XalanSourceTreeProcessingInstruction&   theSource);
00545 
00546     bool
00547     operator==(const XalanSourceTreeProcessingInstruction&      theRHS) const;
00548 
00549 
00550     // Data members...
00551     const XalanDOMString&       m_target;
00552 
00553     const XalanDOMString&       m_data;
00554 
00555     XalanSourceTreeDocument*    m_ownerDocument;
00556 
00557     XalanNode*                  m_parentNode;
00558 
00559     XalanNode*                  m_previousSibling;
00560 
00561     XalanNode*                  m_nextSibling;
00562 
00563     unsigned int                m_index;
00564 };
00565 
00566 
00567 
00568 #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++ XSLT Processor Version 1.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.