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  

XalanNotation.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(XALANNOTATION_HEADER_GUARD_1357924680)
00058 #define XALANNOTATION_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 Notation interface.
00071  *
00072  * This class is experimental and subject to change!!
00073  */
00074 
00075 class XALAN_DOM_EXPORT XalanNotation : public XalanNode
00076 {
00077 public:
00078 
00079     XalanNotation();
00080 
00081     virtual
00082     ~XalanNotation();
00083 
00084 
00085     // These interfaces are inherited from XalanNode...
00086     virtual XalanDOMString
00087     getNodeName() const = 0;
00088 
00092     virtual XalanDOMString
00093     getNodeValue() const = 0;
00094 
00098     virtual NodeType
00099     getNodeType() const = 0;
00100 
00110     virtual XalanNode*
00111     getParentNode() const = 0;
00112 
00126     virtual const XalanNodeList*
00127     getChildNodes() const = 0;
00128 
00134     virtual XalanNode*
00135     getFirstChild() const = 0;
00136 
00142     virtual XalanNode*
00143     getLastChild() const = 0;
00144 
00150     virtual XalanNode*
00151     getPreviousSibling() const = 0;
00152 
00158     virtual XalanNode*
00159     getNextSibling() const = 0;
00160 
00165     virtual const XalanNamedNodeMap*
00166     getAttributes() const = 0;
00167 
00177     virtual XalanDocument*
00178     getOwnerDocument() const = 0;
00179 
00180     //@}
00182     //@{
00183 
00202     virtual XalanNode*
00203     cloneNode(bool deep) const = 0;
00204 
00205     //@}
00207     //@{
00208 
00225     virtual XalanNode*
00226     insertBefore(
00227             XalanNode*  newChild,
00228             XalanNode*  refChild) = 0;
00229 
00243     virtual XalanNode*
00244     replaceChild(
00245             XalanNode*  newChild,
00246             XalanNode*  oldChild) = 0;
00247 
00255     virtual XalanNode*
00256     removeChild(XalanNode*  oldChild) = 0;
00257 
00269     virtual XalanNode*
00270     appendChild(XalanNode*  newChild) = 0;
00271 
00272     //@}
00274     //@{
00275 
00283     virtual bool
00284     hasChildNodes() const = 0;
00285 
00286 
00287     //@}
00289     //@{
00290 
00291 
00305     virtual void
00306     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00307 
00308     //@}
00310     //@{
00311 
00328     virtual void
00329     normalize() = 0;
00330 
00344     virtual bool
00345     supports(
00346             const XalanDOMString&   feature,
00347             const XalanDOMString&   version) const = 0;
00348 
00362     virtual XalanDOMString
00363     getNamespaceURI() const = 0;
00364 
00369     virtual XalanDOMString
00370     getPrefix() const = 0;
00371 
00379     virtual XalanDOMString
00380     getLocalName() const = 0;
00381 
00411     virtual void
00412     setPrefix(const XalanDOMString&     prefix) = 0;
00413 
00419     virtual bool
00420     isIndexed() const = 0;
00421 
00428     virtual unsigned long
00429     getIndex() const = 0;
00430 
00437     virtual XalanDOMString
00438     getXSLTData() const = 0;
00439 
00440     //@}
00441 
00442     // These interfaces are new to XalanNotation...
00443 
00451     virtual XalanDOMString
00452     getPublicId() const = 0;
00453 
00461     virtual XalanDOMString
00462     getSystemId() const = 0;
00463 
00464 protected:
00465 
00466     XalanNotation(const XalanNotation&  theSource);
00467 
00468     XalanNotation&
00469     operator=(const XalanNotation&  theSource);
00470 
00471     bool
00472     operator==(const XalanNotation&     theRHS) const;
00473 
00474 private:
00475 };
00476 
00477 
00478 
00479 #endif  // !defined(XALANNOTATION_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.