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  

XalanEntityReference.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(XALANENTITYREFERENCE_HEADER_GUARD_1357924680)
00058 #define XALANENTITYREFERENCE_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 EntityReference interface.
00075  *
00076  * This class is experimental and subject to change!!
00077  */
00078 
00079 class XALAN_DOM_EXPORT XalanEntityReference : public XalanNode
00080 {
00081 public:
00082 
00083     XalanEntityReference();
00084 
00085     virtual
00086     ~XalanEntityReference();
00087 
00088 
00089     // These interfaces are inherited from XalanNode...
00090     virtual const XalanDOMString&
00091     getNodeName() const = 0;
00092 
00096     virtual const XalanDOMString&
00097     getNodeValue() const = 0;
00098 
00102     virtual NodeType
00103     getNodeType() const = 0;
00104 
00114     virtual XalanNode*
00115     getParentNode() const = 0;
00116 
00130     virtual const XalanNodeList*
00131     getChildNodes() const = 0;
00132 
00138     virtual XalanNode*
00139     getFirstChild() const = 0;
00140 
00146     virtual XalanNode*
00147     getLastChild() const = 0;
00148 
00154     virtual XalanNode*
00155     getPreviousSibling() const = 0;
00156 
00162     virtual XalanNode*
00163     getNextSibling() const = 0;
00164 
00169     virtual const XalanNamedNodeMap*
00170     getAttributes() const = 0;
00171 
00181     virtual XalanDocument*
00182     getOwnerDocument() const = 0;
00183 
00185 
00187 
00206     virtual XalanNode*
00207     cloneNode(bool deep) const = 0;
00208 
00210 
00212 
00229     virtual XalanNode*
00230     insertBefore(
00231             XalanNode*  newChild,
00232             XalanNode*  refChild) = 0;
00233 
00247     virtual XalanNode*
00248     replaceChild(
00249             XalanNode*  newChild,
00250             XalanNode*  oldChild) = 0;
00251 
00259     virtual XalanNode*
00260     removeChild(XalanNode*  oldChild) = 0;
00261 
00273     virtual XalanNode*
00274     appendChild(XalanNode*  newChild) = 0;
00275 
00277 
00279 
00287     virtual bool
00288     hasChildNodes() const = 0;
00289 
00290 
00292 
00294 
00295 
00309     virtual void
00310     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00311 
00313 
00315 
00332     virtual void
00333     normalize() = 0;
00334 
00348     virtual bool
00349     isSupported(
00350             const XalanDOMString&   feature,
00351             const XalanDOMString&   version) const = 0;
00352 
00366     virtual const XalanDOMString&
00367     getNamespaceURI() const = 0;
00368 
00373     virtual const XalanDOMString&
00374     getPrefix() const = 0;
00375 
00383     virtual const XalanDOMString&
00384     getLocalName() const = 0;
00385 
00415     virtual void
00416     setPrefix(const XalanDOMString& prefix) = 0;
00417 
00423     virtual bool
00424     isIndexed() const = 0;
00425 
00432     virtual IndexType
00433     getIndex() const = 0;
00434 
00436 
00437 protected:
00438 
00439     XalanEntityReference(const XalanEntityReference&    theSource);
00440 
00441     XalanEntityReference&
00442 	operator=(const XalanEntityReference&  theSource);
00443 
00444     bool
00445 	operator==(const XalanEntityReference&     theRHS) const;
00446 
00447 private:
00448 };
00449 
00450 
00451 
00452 XALAN_CPP_NAMESPACE_END
00453 
00454 
00455 
00456 #endif  // !defined(XALANENTITYREFERENCE_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.