Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

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

XalanDocument.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 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(XALANDOCUMENT_HEADER_GUARD_1357924680)
00058 #define XALANDOCUMENT_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <XalanDOM/XalanDOMDefinitions.hpp>
00063 #include <XalanDOM/XalanNode.hpp>
00064 
00065 
00066 
00067 class XalanAttr;
00068 class XalanCDATASection;
00069 class XalanComment;
00070 class XalanDocumentFragment;
00071 class XalanDocumentType;
00072 class XalanDOMImplementation;
00073 class XalanElement;
00074 class XalanEntityReference;
00075 class XalanProcessingInstruction;
00076 class XalanText;
00077 
00078 
00079 
00080 /*
00081  * <meta name="usage" content="experimental"/>
00082  *
00083  * Base class for the DOM Document interface.
00084  *
00085  * This class is experimental and subject to change!!
00086  */
00087 
00088 class XALAN_DOM_EXPORT XalanDocument : public XalanNode
00089 {
00090 public:
00091 
00092     XalanDocument();
00093 
00094     virtual
00095     ~XalanDocument();
00096 
00097     // These interfaces are inherited from XalanNode...
00098 
00099     virtual XalanDOMString
00100     getNodeName() const = 0;
00101 
00105     virtual XalanDOMString
00106     getNodeValue() const = 0;
00107 
00111     virtual NodeType
00112     getNodeType() const = 0;
00113 
00123     virtual XalanNode*
00124     getParentNode() const = 0;
00125 
00139     virtual const XalanNodeList*
00140     getChildNodes() const = 0;
00141 
00147     virtual XalanNode*
00148     getFirstChild() const = 0;
00149 
00155     virtual XalanNode*
00156     getLastChild() const = 0;
00157 
00163     virtual XalanNode*
00164     getPreviousSibling() const = 0;
00165 
00171     virtual XalanNode*
00172     getNextSibling() const = 0;
00173 
00178     virtual const XalanNamedNodeMap*
00179     getAttributes() const = 0;
00180 
00190     virtual XalanDocument*
00191     getOwnerDocument() const = 0;
00192 
00193     //@}
00195     //@{
00196 
00215 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00216     virtual XalanNode*
00217 #else
00218     virtual XalanDocument*
00219 #endif
00220     cloneNode(bool deep) const = 0;
00221 
00222     //@}
00224     //@{
00225 
00242     virtual XalanNode*
00243     insertBefore(
00244             XalanNode*  newChild,
00245             XalanNode*  refChild) = 0;
00246 
00260     virtual XalanNode*
00261     replaceChild(
00262             XalanNode*  newChild,
00263             XalanNode*  oldChild) = 0;
00264 
00272     virtual XalanNode*
00273     removeChild(XalanNode*  oldChild) = 0;
00274 
00286     virtual XalanNode*
00287     appendChild(XalanNode*  newChild) = 0;
00288 
00289     //@}
00291     //@{
00292 
00300     virtual bool
00301     hasChildNodes() const = 0;
00302 
00303 
00304     //@}
00306     //@{
00307 
00308 
00322     virtual void
00323     setNodeValue(const XalanDOMString&      nodeValue) = 0;
00324 
00325     //@}
00327     //@{
00328 
00345     virtual void
00346     normalize() = 0;
00347 
00361     virtual bool
00362     supports(
00363             const XalanDOMString&   feature,
00364             const XalanDOMString&   version) const = 0;
00365 
00379     virtual XalanDOMString
00380     getNamespaceURI() const = 0;
00381 
00386     virtual XalanDOMString
00387     getPrefix() const = 0;
00388 
00396     virtual XalanDOMString
00397     getLocalName() const = 0;
00398 
00428     virtual void
00429     setPrefix(const XalanDOMString& prefix) = 0;
00430 
00436     virtual bool
00437     isIndexed() const = 0;
00438 
00445     virtual unsigned long
00446     getIndex() const = 0;
00447 
00454     virtual XalanDOMString
00455     getXSLTData() const = 0;
00456 
00457     //@}
00458 
00459     // These interfaces are new to XalanDocument...
00460 
00470     virtual XalanElement*
00471     createElement(const XalanDOMString& tagName) = 0;
00472 
00479     virtual XalanDocumentFragment*
00480     createDocumentFragment() = 0;
00481 
00489     virtual XalanText*
00490     createTextNode(const XalanDOMString&    data) = 0;
00491 
00499     virtual XalanComment*
00500     createComment(const XalanDOMString& data) = 0;
00501 
00511     virtual XalanCDATASection*
00512     createCDATASection(const XalanDOMString&    data) = 0;
00513 
00525     virtual XalanProcessingInstruction*
00526     createProcessingInstruction(
00527             const XalanDOMString&   target,
00528             const XalanDOMString&   data) = 0;
00529 
00546     virtual XalanAttr*
00547     createAttribute(const XalanDOMString&   name) = 0;
00548 
00559     virtual XalanEntityReference*
00560     createEntityReference(const XalanDOMString &name) = 0;
00561 
00562     //@}
00564     //@{
00574     virtual XalanDocumentType*
00575     getDoctype() const = 0;
00576 
00577 
00581     virtual XalanDOMImplementation*
00582     getImplementation() const = 0;
00583 
00584 
00588     virtual XalanElement*
00589     getDocumentElement() const = 0;
00590 
00605     virtual XalanNodeList*
00606     getElementsByTagName(const XalanDOMString&      tagname) const = 0;
00607 
00608     //@}
00610     //@{
00611 
00634     virtual XalanNode*
00635     importNode(
00636             XalanNode*  importedNode,
00637             bool        deep) = 0;
00638 
00661     virtual XalanElement*
00662     createElementNS(
00663             const XalanDOMString&   namespaceURI,
00664             const XalanDOMString&   qualifiedName) = 0;
00665 
00694     virtual XalanAttr*
00695     createAttributeNS(
00696             const XalanDOMString& namespaceURI,
00697             const XalanDOMString& qualifiedName) = 0;
00698 
00715     virtual XalanNodeList*
00716     getElementsByTagNameNS(
00717             const XalanDOMString&   namespaceURI,
00718             const XalanDOMString&   localName) const = 0;
00719 
00735     virtual XalanElement*
00736     getElementById(const XalanDOMString&    elementId) const = 0;
00737 
00738     // This interface is a Xalan-specific extension.
00739 
00740     //@}
00741 
00742 protected:
00743 
00744     XalanDocument(const XalanDocument&  theSource);
00745 
00746     XalanDocument&
00747     operator=(const XalanDocument&  theSource);
00748 
00749     bool
00750     operator==(const XalanDocument&     theRHS) const;
00751 
00752 private:
00753 };
00754 
00755 
00756 
00757 #endif  // !defined(XALANDOCUMENT_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.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.