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  

DOMServices.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(DOMSERVICES_HEADER_GUARD_1357924680)
00058 #define DOMSERVICES_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <DOMSupport/DOMSupportDefinitions.hpp>
00064 
00065 
00066 
00067 #include <XalanDOM/XalanDOMString.hpp>
00068 
00069 
00070 
00071 #if defined(XALAN_INLINE_INITIALIZATION)
00072 #include <PlatformSupport/DOMStringHelper.hpp>
00073 #endif
00074 
00075 
00076 
00077 class XalanAttr;
00078 class XalanComment;
00079 class XalanDocument;
00080 class XalanDocumentFragment;
00081 class XalanElement;
00082 class XalanNode;
00083 class XalanProcessingInstruction;
00084 class XalanText;
00085 
00086 
00087 
00088 class XALAN_DOMSUPPORT_EXPORT DOMServices
00089 {
00090 public:
00091 
00092     static const XalanDOMString&    s_XMLString;
00093     static const XalanDOMString&    s_XMLNamespaceURI;
00094     static const XalanDOMString&    s_XMLNamespace;
00095     static const XalanDOMString&    s_XMLNamespaceWithSeparator;
00096     static const XalanDOMString&    s_XMLNamespaceSeparatorString;
00097 
00098     static const unsigned int&      s_XMLStringLength;
00099     static const unsigned int&      s_XMLNamespaceURILength;
00100     static const unsigned int&      s_XMLNamespaceLength;
00101     static const unsigned int&      s_XMLNamespaceWithSeparatorLength;
00102     static const unsigned int&      s_XMLNamespaceSeparatorStringLength;
00103 
00104 
00105     class XALAN_DOMSUPPORT_EXPORT WhitespaceSupport
00106     {
00107     public:
00108 
00109         WhitespaceSupport();
00110 
00111         virtual
00112         ~WhitespaceSupport();
00113 
00121         virtual bool
00122         isIgnorableWhitespace(const XalanText&  node) const = 0;
00123     };
00124 
00125     // A default implementation using the values from the XML spec.
00126     class XALAN_DOMSUPPORT_EXPORT WhitespaceSupportDefault : public WhitespaceSupport
00127     {
00128     public:
00129 
00130         WhitespaceSupportDefault();
00131 
00132         virtual
00133         ~WhitespaceSupportDefault();
00134 
00142         virtual bool
00143         isIgnorableWhitespace(const XalanText&  node) const;
00144     };
00145 
00150     static void
00151     initialize();
00152 
00157     static void
00158     terminate();
00159 
00166     static XalanDOMString
00167     getNodeData(const XalanNode&    node);
00168 
00175     static XalanDOMString
00176     getNodeData(const XalanAttr&    attribute);
00177 
00184     static XalanDOMString
00185     getNodeData(const XalanComment&     comment);
00186 
00193     static XalanDOMString
00194     getNodeData(const XalanDocument&    document);
00195 
00202     static XalanDOMString
00203     getNodeData(const XalanDocumentFragment&    documentFragment);
00204 
00211     static XalanDOMString
00212     getNodeData(const XalanElement&     element);
00213 
00220     static XalanDOMString
00221     getNodeData(const XalanProcessingInstruction&   pi);
00222 
00229     static XalanDOMString
00230     getNodeData(const XalanText&    text);
00231 
00240     static XalanDOMString
00241     getNameOfNode(const XalanNode&  n);
00242 
00251     static XalanDOMString
00252     getLocalNameOfNode(const XalanNode&     n);
00253 
00261     static XalanNode*
00262     getParentOfNode(const XalanNode&    node);
00263 
00271     static XalanDOMString
00272     getNamespaceForPrefix(
00273             const XalanDOMString&   prefix,
00274             const XalanElement&     namespaceContext);
00275 
00283     static bool
00284     isNodeAfter(
00285             const XalanNode&    node1,
00286             const XalanNode&    node2);
00287 
00296     static bool
00297     isNodeAfterSibling(
00298             const XalanNode&    parent,
00299             const XalanNode&    child1,
00300             const XalanNode&    child2);
00301 
00302 };  // class DOMServices
00303 
00304 
00305 
00306 #endif  // DOMSERVICES_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.