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  

XercesEntityBridge.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(XERCESENTITYBRIDGE_HEADER_GUARD_1357924680)
00058 #define XERCESENTITYBRIDGE_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <xalanc/XercesParserLiaison/XercesParserLiaisonDefinitions.hpp>
00063 
00064 
00065 
00066 #if XERCES_VERSION_MAJOR >= 2
00067 #include <xercesc/dom/deprecated/DOM_Entity.hpp>
00068 #else
00069 #include <xercesc/dom/DOM_Entity.hpp>
00070 #endif
00071 
00072 
00073 
00074 #include <xalanc/XalanDOM/XalanEntity.hpp>
00075 
00076 
00077 
00078 #include <xalanc/XercesParserLiaison/XercesNodeListBridge.hpp>
00079 
00080 
00081 
00082 XALAN_CPP_NAMESPACE_BEGIN
00083 
00084 
00085 
00086 class XercesBridgeNavigator;
00087 
00088 
00089 
00090 class XALAN_XERCESPARSERLIAISON_EXPORT XercesEntityBridge : public XalanEntity
00091 {
00092 public:
00093 
00094     typedef XERCES_CPP_NAMESPACE_QUALIFIER DOM_Entity           DOM_EntityType;
00095 
00096     XercesEntityBridge(
00097             const DOM_EntityType&           theXercesDOMEntity,
00098             const XercesBridgeNavigator&    theNavigator);
00099 
00100     virtual
00101     ~XercesEntityBridge();
00102 
00103 
00104     // These interfaces are inherited from XalanNode...
00105 
00106     virtual const XalanDOMString&
00107     getNodeName() const;
00108 
00112     virtual const XalanDOMString&
00113     getNodeValue() const;
00114 
00118     virtual NodeType
00119     getNodeType() const;
00120 
00130     virtual XalanNode*
00131     getParentNode() const;
00132 
00146     virtual const XalanNodeList*
00147     getChildNodes() const;
00148 
00154     virtual XalanNode*
00155     getFirstChild() const;
00156 
00162     virtual XalanNode*
00163     getLastChild() const;
00164 
00170     virtual XalanNode*
00171     getPreviousSibling() const;
00172 
00178     virtual XalanNode*
00179     getNextSibling() const;
00180 
00185     virtual const XalanNamedNodeMap*
00186     getAttributes() const;
00187 
00197     virtual XalanDocument*
00198     getOwnerDocument() const;
00199 
00201 
00203 
00222 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00223     virtual XalanNode*
00224 #else
00225     virtual XercesEntityBridge*
00226 #endif
00227     cloneNode(bool deep) const;
00228 
00230 
00232 
00249     virtual XalanNode*
00250     insertBefore(
00251             XalanNode*  newChild,
00252             XalanNode*  refChild);
00253 
00267     virtual XalanNode*
00268     replaceChild(
00269             XalanNode*  newChild,
00270             XalanNode*  oldChild);
00271 
00279     virtual XalanNode*
00280     removeChild(XalanNode*  oldChild);
00281 
00293     virtual XalanNode*
00294     appendChild(XalanNode*  newChild);
00295 
00297 
00299 
00307     virtual bool
00308     hasChildNodes() const;
00309 
00310 
00312 
00314 
00315 
00329     virtual void
00330     setNodeValue(const XalanDOMString&      nodeValue);
00331 
00333 
00335 
00352     virtual void
00353     normalize();
00354 
00368     virtual bool
00369     isSupported(
00370             const XalanDOMString&   feature,
00371             const XalanDOMString&   version) const;
00372 
00386     virtual const XalanDOMString&
00387     getNamespaceURI() const;
00388 
00393     virtual const XalanDOMString&
00394     getPrefix() const;
00395 
00403     virtual const XalanDOMString&
00404     getLocalName() const;
00405 
00435     virtual void
00436     setPrefix(const XalanDOMString& prefix);
00437 
00438     virtual bool
00439     isIndexed() const;
00440 
00441     virtual IndexType
00442     getIndex() const;
00443 
00445 
00446     // These interfaces are inherited from XalanEntity...
00447 
00455     virtual const XalanDOMString&
00456     getPublicId() const;
00457 
00465     virtual const XalanDOMString&
00466     getSystemId() const;
00467 
00473     virtual const XalanDOMString&
00474     getNotationName() const;
00475 
00481     DOM_EntityType
00482     getXercesNode() const
00483     {
00484         return m_xercesNode;
00485     }
00486 
00487 private:
00488 
00489     // Not implemented...
00490     XercesEntityBridge(const XercesEntityBridge&    theSource);
00491 
00492     XercesEntityBridge&
00493 	operator=(const XercesEntityBridge&        theSource);
00494 
00495     bool
00496 	operator==(const XercesEntityBridge&       theRHS) const;
00497 
00498     // Data members...
00499     // $$$ Note that there is an order dependency here,
00500     // due do a code generation bug with MSVC 6.0.  The
00501     // call to construct the XercesNodeListBridge uses
00502     // the m_xercesNode data member instead of the 
00503     // constructor parameter.  I have no idea why MSVC
00504     // generate bogus code when using the parameter, but
00505     // it does...
00506     DOM_EntityType                  m_xercesNode;
00507 
00508     const XercesBridgeNavigator&    m_navigator;
00509 
00510     XercesNodeListBridge            m_children;
00511 };
00512 
00513 
00514 
00515 XALAN_CPP_NAMESPACE_END
00516 
00517 
00518 
00519 #endif  // !defined(XERCESENTITYBRIDGE_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.