Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.7

Main Page   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-2004 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 <xalanc/XalanDOM/XalanDOMDefinitions.hpp>
00063 #include <xalanc/XalanDOM/XalanNode.hpp>
00064 
00065 
00066 
00067 XALAN_CPP_NAMESPACE_BEGIN
00068 
00069 
00070 
00071 /*
00072  * <meta name="usage" content="experimental"/>
00073  *
00074  * Base class for the DOM Entity interface.
00075  *
00076  * This class is experimental and subject to change!!
00077  */
00078 
00079 class XALAN_DOM_EXPORT XalanEntity : public XalanNode
00080 {
00081 public:
00082 
00083     XalanEntity();
00084 
00085     virtual
00086     ~XalanEntity();
00087 
00088 
00089     // These interfaces are inherited from XalanNode...
00090 
00091     virtual const XalanDOMString&
00092     getNodeName() const = 0;
00093 
00097     virtual const XalanDOMString&
00098     getNodeValue() const = 0;
00099 
00103     virtual NodeType
00104     getNodeType() const = 0;
00105 
00115     virtual XalanNode*
00116     getParentNode() const = 0;
00117 
00131     virtual const XalanNodeList*
00132     getChildNodes() const = 0;
00133 
00139     virtual XalanNode*
00140     getFirstChild() const = 0;
00141 
00147     virtual XalanNode*
00148     getLastChild() const = 0;
00149 
00155     virtual XalanNode*
00156     getPreviousSibling() const = 0;
00157 
00163     virtual XalanNode*
00164     getNextSibling() const = 0;
00165 
00170     virtual const XalanNamedNodeMap*
00171     getAttributes() const = 0;
00172 
00182     virtual XalanDocument*
00183     getOwnerDocument() const = 0;
00184 
00186 
00188 
00207     virtual XalanNode*
00208     cloneNode(bool deep) const = 0;
00209 
00211 
00213 
00230     virtual XalanNode*
00231     insertBefore(
00232             XalanNode*  newChild,
00233             XalanNode*  refChild) = 0;
00234 
00248     virtual XalanNode*
00249     replaceChild(
00250             XalanNode*  newChild,
00251             XalanNode*  oldChild) = 0;
00252 
00260     virtual XalanNode*
00261     removeChild(XalanNode*  oldChild) = 0;
00262 
00274     virtual XalanNode*
00275     appendChild(XalanNode*  newChild) = 0;
00276 
00278 
00280 
00288     virtual bool
00289     hasChildNodes() const = 0;
00290 
00291 
00293 
00295 
00296 
00310     virtual void
00311     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00312 
00314 
00316 
00333     virtual void
00334     normalize() = 0;
00335 
00349     virtual bool
00350     isSupported(
00351             const XalanDOMString&   feature,
00352             const XalanDOMString&   version) const = 0;
00353 
00367     virtual const XalanDOMString&
00368     getNamespaceURI() const = 0;
00369 
00374     virtual const XalanDOMString&
00375     getPrefix() const = 0;
00376 
00384     virtual const XalanDOMString&
00385     getLocalName() const = 0;
00386 
00416     virtual void
00417     setPrefix(const XalanDOMString& prefix) = 0;
00418 
00424     virtual bool
00425     isIndexed() const = 0;
00426 
00433     virtual IndexType
00434     getIndex() const = 0;
00435 
00437 
00438     // These interfaces are new to XalanEntity...
00439 
00447     virtual const XalanDOMString&
00448     getPublicId() const = 0;
00449 
00457     virtual const XalanDOMString&
00458     getSystemId() const = 0;
00459 
00465     virtual const XalanDOMString&
00466     getNotationName() const = 0;
00467 
00468 protected:
00469 
00470     XalanEntity(const XalanEntity&  theSource);
00471 
00472     XalanEntity&
00473 	operator=(const XalanEntity&   theSource);
00474 
00475     bool
00476 	operator==(const XalanEntity&  theRHS) const;
00477 
00478 private:
00479 };
00480 
00481 
00482 
00483 XALAN_CPP_NAMESPACE_END
00484 
00485 
00486 
00487 #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++ XSLT Processor Version 1.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.