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  

XalanEntity.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(XALANENTITY_HEADER_GUARD_1357924680)
00058 #define XALANENTITY_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <XalanDOM/XalanDOMDefinitions.hpp>
00063 #include <XalanDOM/XalanNode.hpp>
00064 
00065 
00066 
00067 /*
00068  * <meta name="usage" content="experimental"/>
00069  *
00070  * Base class for the DOM Entity interface.
00071  *
00072  * This class is experimental and subject to change!!
00073  */
00074 
00075 class XALAN_DOM_EXPORT XalanEntity : public XalanNode
00076 {
00077 public:
00078 
00079     XalanEntity();
00080 
00081     virtual
00082     ~XalanEntity();
00083 
00084 
00085     // These interfaces are inherited from XalanNode...
00086 
00087     virtual XalanDOMString
00088     getNodeName() const = 0;
00089 
00093     virtual XalanDOMString
00094     getNodeValue() const = 0;
00095 
00099     virtual NodeType
00100     getNodeType() const = 0;
00101 
00111     virtual XalanNode*
00112     getParentNode() const = 0;
00113 
00127     virtual const XalanNodeList*
00128     getChildNodes() const = 0;
00129 
00135     virtual XalanNode*
00136     getFirstChild() const = 0;
00137 
00143     virtual XalanNode*
00144     getLastChild() const = 0;
00145 
00151     virtual XalanNode*
00152     getPreviousSibling() const = 0;
00153 
00159     virtual XalanNode*
00160     getNextSibling() const = 0;
00161 
00166     virtual const XalanNamedNodeMap*
00167     getAttributes() const = 0;
00168 
00178     virtual XalanDocument*
00179     getOwnerDocument() const = 0;
00180 
00181     //@}
00183     //@{
00184 
00203     virtual XalanNode*
00204     cloneNode(bool deep) const = 0;
00205 
00206     //@}
00208     //@{
00209 
00226     virtual XalanNode*
00227     insertBefore(
00228             XalanNode*  newChild,
00229             XalanNode*  refChild) = 0;
00230 
00244     virtual XalanNode*
00245     replaceChild(
00246             XalanNode*  newChild,
00247             XalanNode*  oldChild) = 0;
00248 
00256     virtual XalanNode*
00257     removeChild(XalanNode*  oldChild) = 0;
00258 
00270     virtual XalanNode*
00271     appendChild(XalanNode*  newChild) = 0;
00272 
00273     //@}
00275     //@{
00276 
00284     virtual bool
00285     hasChildNodes() const = 0;
00286 
00287 
00288     //@}
00290     //@{
00291 
00292 
00306     virtual void
00307     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00308 
00309     //@}
00311     //@{
00312 
00329     virtual void
00330     normalize() = 0;
00331 
00345     virtual bool
00346     supports(
00347             const XalanDOMString&   feature,
00348             const XalanDOMString&   version) const = 0;
00349 
00363     virtual XalanDOMString
00364     getNamespaceURI() const = 0;
00365 
00370     virtual XalanDOMString
00371     getPrefix() const = 0;
00372 
00380     virtual XalanDOMString
00381     getLocalName() const = 0;
00382 
00412     virtual void
00413     setPrefix(const XalanDOMString& prefix) = 0;
00414 
00420     virtual bool
00421     isIndexed() const = 0;
00422 
00429     virtual unsigned long
00430     getIndex() const = 0;
00431 
00438     virtual XalanDOMString
00439     getXSLTData() const = 0;
00440 
00441     //@}
00442 
00443     // These interfaces are new to XalanEntity...
00444 
00452     virtual XalanDOMString
00453     getPublicId() const = 0;
00454 
00462     virtual XalanDOMString
00463     getSystemId() const = 0;
00464 
00470     virtual XalanDOMString
00471     getNotationName() const = 0;
00472 
00473 protected:
00474 
00475     XalanEntity(const XalanEntity&  theSource);
00476 
00477     XalanEntity&
00478     operator=(const XalanEntity&    theSource);
00479 
00480     bool
00481     operator==(const XalanEntity&   theRHS) const;
00482 
00483 private:
00484 };
00485 
00486 
00487 
00488 #endif  // !defined(XALANENTITY_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.