Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

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 <xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 #include <xalanc/XalanDOM/XalanProcessingInstruction.hpp>
00067 
00068 
00069 
00070 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00071 
00072 
00073 
00074 XALAN_CPP_NAMESPACE_BEGIN
00075 
00076 
00077 
00078 class XalanSourceTreeComment;
00079 class XalanSourceTreeDocument;
00080 class XalanSourceTreeDocumentFragment;
00081 class XalanSourceTreeElement;
00082 class XalanSourceTreeText;
00083 
00084 
00085 
00086 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeProcessingInstruction : public XalanProcessingInstruction
00087 {
00088 public:
00089 
00103     XalanSourceTreeProcessingInstruction(
00104             const XalanDOMString&       theTarget,
00105             const XalanDOMString&       theData,
00106             XalanSourceTreeDocument*    theOwnerDocument,
00107             XalanNode*                  theParentNode = 0,
00108             XalanNode*                  thePreviousSibling = 0,
00109             XalanNode*                  theNextSibling = 0,
00110             IndexType                   theIndex = 0);
00111 
00112     virtual
00113     ~XalanSourceTreeProcessingInstruction();
00114 
00115 
00116     // These interfaces are inherited from XalanNode...
00117 
00118     virtual const XalanDOMString&
00119     getNodeName() const;
00120 
00124     virtual const XalanDOMString&
00125     getNodeValue() const;
00126 
00130     virtual NodeType
00131     getNodeType() const;
00132 
00142     virtual XalanNode*
00143     getParentNode() const;
00144 
00158     virtual const XalanNodeList*
00159     getChildNodes() const;
00160 
00166     virtual XalanNode*
00167     getFirstChild() const;
00168 
00174     virtual XalanNode*
00175     getLastChild() const;
00176 
00182     virtual XalanNode*
00183     getPreviousSibling() const;
00184 
00190     virtual XalanNode*
00191     getNextSibling() const;
00192 
00197     virtual const XalanNamedNodeMap*
00198     getAttributes() const;
00199 
00209     virtual XalanDocument*
00210     getOwnerDocument() const;
00211 
00213 
00215 
00234 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00235     virtual XalanNode*
00236 #else
00237     virtual XalanSourceTreeProcessingInstruction*
00238 #endif
00239     cloneNode(bool deep) const;
00240 
00242 
00244 
00261     virtual XalanNode*
00262     insertBefore(
00263             XalanNode*  newChild,
00264             XalanNode*  refChild);
00265 
00279     virtual XalanNode*
00280     replaceChild(
00281             XalanNode*  newChild,
00282             XalanNode*  oldChild);
00283 
00291     virtual XalanNode*
00292     removeChild(XalanNode*  oldChild);
00293 
00305     virtual XalanNode*
00306     appendChild(XalanNode*  newChild);
00307 
00309 
00311 
00319     virtual bool
00320     hasChildNodes() const;
00321 
00322 
00324 
00326 
00327 
00341     virtual void
00342     setNodeValue(const XalanDOMString&  nodeValue);
00343 
00345 
00347 
00364     virtual void
00365     normalize();
00366 
00380     virtual bool
00381     isSupported(
00382             const XalanDOMString&   feature,
00383             const XalanDOMString&   version) const;
00384 
00398     virtual const XalanDOMString&
00399     getNamespaceURI() const;
00400 
00405     virtual const XalanDOMString&
00406     getPrefix() const;
00407 
00415     virtual const XalanDOMString&
00416     getLocalName() const;
00417 
00447     virtual void
00448     setPrefix(const XalanDOMString&     prefix);
00449 
00450     virtual bool
00451     isIndexed() const;
00452 
00453     virtual IndexType
00454     getIndex() const;
00455 
00457 
00458     // These interfaces are inherited from XalanProcessingInstruction...
00459 
00461 
00463 
00469     virtual const XalanDOMString&
00470     getTarget() const;
00471 
00481     virtual const XalanDOMString&
00482     getData() const;
00483 
00485 
00487 
00495     virtual void
00496     setData(const XalanDOMString&   data);
00498 
00499 
00500     // public interfaces not inherited from XalanProcessingInstruction...
00501 
00502     void
00503     setParent(XalanSourceTreeElement*   theParent);
00504 
00505     void
00506     setParent(XalanSourceTreeDocumentFragment*  theParent);
00507 
00508     void
00509     setPreviousSibling(XalanSourceTreeComment*  thePreviousSibling);
00510 
00511     void
00512     setPreviousSibling(XalanSourceTreeElement*  thePreviousSibling);
00513 
00514     void
00515     setPreviousSibling(XalanSourceTreeProcessingInstruction*    thePreviousSibling);
00516 
00517     void
00518     setPreviousSibling(XalanSourceTreeText*     thePreviousSibling);
00519 
00520     void
00521     appendSiblingNode(XalanSourceTreeComment*   theSibling);
00522 
00523     void
00524     appendSiblingNode(XalanSourceTreeElement*   theSibling);
00525 
00526     void
00527     appendSiblingNode(XalanSourceTreeProcessingInstruction*     theSibling);
00528 
00529     void
00530     appendSiblingNode(XalanSourceTreeText*  theSibling);
00531 
00532     void
00533     setIndex(IndexType  theIndex)
00534     {
00535         m_index = theIndex;
00536     }
00537 
00538 protected:
00539 
00540     XalanSourceTreeProcessingInstruction(
00541             const XalanSourceTreeProcessingInstruction&     theSource,
00542             bool                                            deep = false);
00543 
00544 private:
00545 
00546     // Not implemented...
00547     XalanSourceTreeProcessingInstruction&
00548 	operator=(const XalanSourceTreeProcessingInstruction&  theSource);
00549 
00550     bool
00551 	operator==(const XalanSourceTreeProcessingInstruction&     theRHS) const;
00552 
00553 
00554     // Data members...
00555     const XalanDOMString&       m_target;
00556 
00557     const XalanDOMString&       m_data;
00558 
00559     XalanSourceTreeDocument*    m_ownerDocument;
00560 
00561     XalanNode*                  m_parentNode;
00562 
00563     XalanNode*                  m_previousSibling;
00564 
00565     XalanNode*                  m_nextSibling;
00566 
00567     IndexType                   m_index;
00568 };
00569 
00570 
00571 
00572 XALAN_CPP_NAMESPACE_END
00573 
00574 
00575 
00576 #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.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.