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  

XalanCharacterData.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(XALANCHARACTERDATA_HEADER_GUARD_1357924680)
00058 #define XALANCHARACTERDATA_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 CharacterData interface.
00075  *
00076  * This class is experimental and subject to change!!
00077  */
00078 
00079 class XALAN_DOM_EXPORT XalanCharacterData : public XalanNode
00080 {
00081 public:
00082 
00083     XalanCharacterData();
00084 
00085     virtual
00086     ~XalanCharacterData();
00087 
00088     // These interfaces are inherited from XalanNode...
00089     virtual const XalanDOMString&
00090     getNodeName() const = 0;
00091 
00095     virtual const XalanDOMString&
00096     getNodeValue() const = 0;
00097 
00101     virtual NodeType
00102     getNodeType() const = 0;
00103 
00113     virtual XalanNode*
00114     getParentNode() const = 0;
00115 
00129     virtual const XalanNodeList*
00130     getChildNodes() const = 0;
00131 
00137     virtual XalanNode*
00138     getFirstChild() const = 0;
00139 
00145     virtual XalanNode*
00146     getLastChild() const = 0;
00147 
00153     virtual XalanNode*
00154     getPreviousSibling() const = 0;
00155 
00161     virtual XalanNode*
00162     getNextSibling() const = 0;
00163 
00168     virtual const XalanNamedNodeMap*
00169     getAttributes() const = 0;
00170 
00180     virtual XalanDocument*
00181     getOwnerDocument() const = 0;
00182 
00184 
00186 
00205 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00206     virtual XalanNode*
00207 #else
00208     virtual XalanCharacterData*
00209 #endif
00210     cloneNode(bool deep) const = 0;
00211 
00213 
00215 
00232     virtual XalanNode*
00233     insertBefore(
00234             XalanNode*  newChild,
00235             XalanNode*  refChild) = 0;
00236 
00250     virtual XalanNode*
00251     replaceChild(
00252             XalanNode*  newChild,
00253             XalanNode*  oldChild) = 0;
00254 
00262     virtual XalanNode*
00263     removeChild(XalanNode*  oldChild) = 0;
00264 
00276     virtual XalanNode*
00277     appendChild(XalanNode*  newChild) = 0;
00278 
00280 
00282 
00290     virtual bool
00291     hasChildNodes() const = 0;
00292 
00293 
00295 
00297 
00311     virtual void
00312     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00313 
00315 
00317 
00334     virtual void
00335     normalize() = 0;
00336 
00350     virtual bool
00351     isSupported(
00352             const XalanDOMString&   feature,
00353             const XalanDOMString&   version) const = 0;
00354 
00368     virtual const XalanDOMString&
00369     getNamespaceURI() const = 0;
00370 
00375     virtual const XalanDOMString&
00376     getPrefix() const = 0;
00377 
00385     virtual const XalanDOMString&
00386     getLocalName() const = 0;
00387 
00417     virtual void
00418     setPrefix(const XalanDOMString&     prefix) = 0;
00419 
00425     virtual bool
00426     isIndexed() const = 0;
00427 
00434     virtual IndexType
00435     getIndex() const = 0;
00436 
00438 
00439     // These interfaces are new to XalanCharacterData...
00440 
00443 
00459     virtual const XalanDOMString&
00460     getData() const = 0;
00461 
00469     virtual unsigned int
00470     getLength() const = 0;
00471 
00487     virtual XalanDOMString
00488     substringData(
00489             unsigned int    offset, 
00490             unsigned int    count) const = 0;
00491 
00493 
00495 
00504     virtual void
00505     appendData(const XalanDOMString&    arg) = 0;
00506 
00517     virtual void
00518     insertData(
00519             unsigned int            offset,
00520             const  XalanDOMString&  arg) = 0;
00521 
00538     virtual void
00539     deleteData(
00540             unsigned int    offset, 
00541             unsigned int    count) = 0;
00542 
00561     virtual void
00562     replaceData(
00563             unsigned int            offset, 
00564             unsigned int            count, 
00565             const XalanDOMString&   arg) = 0;
00566 
00568 
00569 protected:
00570 
00571     XalanCharacterData(const XalanCharacterData&    theSource);
00572 
00573     XalanCharacterData&
00574 	operator=(const XalanCharacterData&    theSource);
00575 
00576     bool
00577 	operator==(const XalanCharacterData&   theRHS) const;
00578 
00579 private:
00580 };
00581 
00582 
00583 
00584 XALAN_CPP_NAMESPACE_END
00585 
00586 
00587 
00588 #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++ XSLT Processor Version 1.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.