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  

XalanCharacterData.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(XALANCHARACTERDATA_HEADER_GUARD_1357924680)
00058 #define XALANCHARACTERDATA_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 CharacterData interface.
00071  *
00072  * This class is experimental and subject to change!!
00073  */
00074 
00075 class XALAN_DOM_EXPORT XalanCharacterData : public XalanNode
00076 {
00077 public:
00078 
00079     XalanCharacterData();
00080 
00081     virtual
00082     ~XalanCharacterData();
00083 
00084     // These interfaces are inherited from XalanNode...
00085     virtual XalanDOMString
00086     getNodeName() const = 0;
00087 
00091     virtual XalanDOMString
00092     getNodeValue() const = 0;
00093 
00097     virtual NodeType
00098     getNodeType() const = 0;
00099 
00109     virtual XalanNode*
00110     getParentNode() const = 0;
00111 
00125     virtual const XalanNodeList*
00126     getChildNodes() const = 0;
00127 
00133     virtual XalanNode*
00134     getFirstChild() const = 0;
00135 
00141     virtual XalanNode*
00142     getLastChild() const = 0;
00143 
00149     virtual XalanNode*
00150     getPreviousSibling() const = 0;
00151 
00157     virtual XalanNode*
00158     getNextSibling() const = 0;
00159 
00164     virtual const XalanNamedNodeMap*
00165     getAttributes() const = 0;
00166 
00176     virtual XalanDocument*
00177     getOwnerDocument() const = 0;
00178 
00179     //@}
00181     //@{
00182 
00201 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00202     virtual XalanNode*
00203 #else
00204     virtual XalanCharacterData*
00205 #endif
00206     cloneNode(bool deep) const = 0;
00207 
00208     //@}
00210     //@{
00211 
00228     virtual XalanNode*
00229     insertBefore(
00230             XalanNode*  newChild,
00231             XalanNode*  refChild) = 0;
00232 
00246     virtual XalanNode*
00247     replaceChild(
00248             XalanNode*  newChild,
00249             XalanNode*  oldChild) = 0;
00250 
00258     virtual XalanNode*
00259     removeChild(XalanNode*  oldChild) = 0;
00260 
00272     virtual XalanNode*
00273     appendChild(XalanNode*  newChild) = 0;
00274 
00275     //@}
00277     //@{
00278 
00286     virtual bool
00287     hasChildNodes() const = 0;
00288 
00289 
00290     //@}
00292     //@{
00293 
00307     virtual void
00308     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00309 
00310     //@}
00312     //@{
00313 
00330     virtual void
00331     normalize() = 0;
00332 
00346     virtual bool
00347     supports(
00348             const XalanDOMString&   feature,
00349             const XalanDOMString&   version) const = 0;
00350 
00364     virtual XalanDOMString
00365     getNamespaceURI() const = 0;
00366 
00371     virtual XalanDOMString
00372     getPrefix() const = 0;
00373 
00381     virtual XalanDOMString
00382     getLocalName() const = 0;
00383 
00413     virtual void
00414     setPrefix(const XalanDOMString&     prefix) = 0;
00415 
00421     virtual bool
00422     isIndexed() const = 0;
00423 
00430     virtual unsigned long
00431     getIndex() const = 0;
00432 
00439     virtual XalanDOMString
00440     getXSLTData() const = 0;
00441 
00442     //@}
00443 
00444     // These interfaces are new to XalanCharacterData...
00445 
00447     //@{
00464     virtual XalanDOMString
00465     getData() const = 0;
00466 
00474     virtual unsigned int
00475     getLength() const = 0;
00476 
00492     virtual XalanDOMString
00493     substringData(
00494             unsigned int    offset, 
00495             unsigned int    count) const = 0;
00496 
00497     //@}
00499     //@{
00509     virtual void
00510     appendData(const XalanDOMString&    arg) = 0;
00511 
00522     virtual void
00523     insertData(
00524             unsigned int            offset,
00525             const  XalanDOMString&  arg) = 0;
00526 
00543     virtual void
00544     deleteData(
00545             unsigned int    offset, 
00546             unsigned int    count) = 0;
00547 
00566     virtual void
00567     replaceData(
00568             unsigned int            offset, 
00569             unsigned int            count, 
00570             const XalanDOMString&   arg) = 0;
00571 
00572   //@}
00573 
00574 protected:
00575 
00576     XalanCharacterData(const XalanCharacterData&    theSource);
00577 
00578     XalanCharacterData&
00579     operator=(const XalanCharacterData&     theSource);
00580 
00581     bool
00582     operator==(const XalanCharacterData&    theRHS) const;
00583 
00584 private:
00585 };
00586 
00587 
00588 
00589 #endif  // !defined(XALANCHARACTERDATA_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.