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  

XalanSourceTreeParserLiaison.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(XALANSOURCETREEPARSERLIAISON_HEADER_GUARD_1357924680)
00058 #define XALANSOURCETREEPARSERLIAISON_HEADER_GUARD_1357924680
00059 
00060 
00061 // Base include file.  Must be first.
00062 #include <xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 // Standard Library header files.
00067 #include <map>
00068 
00069 
00070 
00071 #include <xalanc/XercesParserLiaison/XercesDOMSupport.hpp>
00072 #include <xalanc/XercesParserLiaison/XercesParserLiaison.hpp>
00073 
00074 
00075 
00076 XALAN_DECLARE_XERCES_CLASS(ContentHandler)
00077 XALAN_DECLARE_XERCES_CLASS(DTDHandler)
00078 XALAN_DECLARE_XERCES_CLASS(LexicalHandler)
00079 XALAN_DECLARE_XERCES_CLASS(SAX2XMLReader)
00080 
00081 
00082 
00083 XALAN_CPP_NAMESPACE_BEGIN
00084 
00085 
00086 
00087 class XalanSourceTreeDOMSupport;
00088 class XalanSourceTreeDocument;
00089 
00090 
00091 
00092 typedef XERCES_CPP_NAMESPACE_QUALIFIER ContentHandler       ContentHandlerType;
00093 typedef XERCES_CPP_NAMESPACE_QUALIFIER DTDHandler           DTDHandlerType;
00094 typedef XERCES_CPP_NAMESPACE_QUALIFIER LexicalHandler       LexicalHandlerType;
00095 typedef XERCES_CPP_NAMESPACE_QUALIFIER SAX2XMLReader        SAX2XMLReaderType;
00096 
00097 
00098 
00099 class XALAN_XALANSOURCETREE_EXPORT  XalanSourceTreeParserLiaison : public XMLParserLiaison
00100 {
00101 public:
00102 
00110     XalanSourceTreeParserLiaison(XalanSourceTreeDOMSupport&     theSupport);
00111 
00115     XalanSourceTreeParserLiaison();
00116 
00117     virtual
00118     ~XalanSourceTreeParserLiaison();
00119 
00126     bool
00127     getPoolAllText() const
00128     {
00129         return m_poolAllText;
00130     }
00131 
00138     void
00139     setPoolAllText(bool fValue)
00140     {
00141         m_poolAllText = fValue;
00142     }
00143 
00144     // These interfaces are inherited from XMLParserLiaison...
00145 
00146     virtual void
00147     reset();
00148 
00149     virtual ExecutionContext*
00150     getExecutionContext() const;
00151 
00152     virtual void
00153     setExecutionContext(ExecutionContext&   theContext);
00154 
00155     virtual XalanDocument*
00156     parseXMLStream(
00157             const InputSourceType&  reader,
00158             const XalanDOMString&   identifier = XalanDOMString());
00159 
00160     virtual void
00161     parseXMLStream(
00162             const InputSourceType&  inputSource,
00163             DocumentHandlerType&    handler,
00164             const XalanDOMString&   identifier = XalanDOMString());
00165 
00166     virtual XalanDocument*
00167     createDocument();
00168 
00169     virtual XalanDocument*
00170     createDOMFactory();
00171 
00172     virtual void
00173     destroyDocument(XalanDocument*  theDocument);
00174 
00175     virtual int
00176     getIndent() const;
00177 
00178     virtual void
00179     setIndent(int   i);
00180 
00181     virtual bool
00182     getUseValidation() const;
00183 
00184     virtual void
00185     setUseValidation(bool   b);
00186 
00187     virtual const XalanDOMString
00188     getParserDescription() const;
00189 
00190     virtual EntityResolverType*
00191     getEntityResolver() const;
00192 
00193     virtual void
00194     setEntityResolver(EntityResolverType*   resolver);
00195 
00196 
00197     // These interfaces are new to XalanSourceTreeParserLiaison...
00198 
00208     virtual void
00209     parseXMLStream(
00210             const InputSourceType&  theInputSource,
00211             ContentHandlerType&     theContentHandler,
00212             DTDHandlerType*         theDTDHandler = 0,
00213             LexicalHandlerType*     theLexicalHandler = 0,
00214             const XalanDOMString&   theIdentifier = XalanDOMString());
00215 
00226     virtual bool
00227     getIncludeIgnorableWhitespace() const;
00228 
00247     virtual void
00248     setIncludeIgnorableWhitespace(bool  include);
00249 
00255     virtual ErrorHandlerType*
00256     getErrorHandler() const;
00257 
00268     virtual void
00269     setErrorHandler(ErrorHandlerType*   handler);
00270 
00280     virtual bool
00281     getDoNamespaces() const;
00282 
00300     virtual void
00301     setDoNamespaces(bool    newState);
00302 
00312     virtual bool
00313     getExitOnFirstFatalError() const;
00314 
00330     virtual void
00331     setExitOnFirstFatalError(bool   newState);
00332 
00339     virtual const XalanDOMChar*
00340     getExternalSchemaLocation() const;
00341 
00348     virtual void
00349     setExternalSchemaLocation(const XalanDOMChar*   location);
00350 
00357     virtual const XalanDOMChar*
00358     getExternalNoNamespaceSchemaLocation() const;
00359 
00366     virtual void
00367     setExternalNoNamespaceSchemaLocation(const XalanDOMChar*    location);
00368 
00378     XalanSourceTreeDocument*
00379     mapDocument(const XalanDocument*    theDocument) const;
00380 
00386     XalanSourceTreeDocument*
00387     createXalanSourceTreeDocument();
00388 
00389 #if defined(XALAN_NO_STD_NAMESPACE)
00390     typedef map<const XalanDocument*,
00391                 XalanSourceTreeDocument*,
00392                 less<const XalanDocument*> >    DocumentMapType;
00393 #else
00394     typedef std::map<const XalanDocument*,
00395                      XalanSourceTreeDocument*>  DocumentMapType;
00396 #endif
00397 
00398 protected:
00399 
00400     virtual SAX2XMLReaderType*
00401     createReader();
00402 
00403 private:
00404 
00405     // Not implemented...
00406     XalanSourceTreeParserLiaison(const XalanSourceTreeParserLiaison&);
00407 
00408     XalanSourceTreeParserLiaison&
00409     operator=(const XalanSourceTreeParserLiaison&);
00410 
00411 
00412     // Data members...
00413     XercesParserLiaison         m_xercesParserLiaison;
00414 
00415     DocumentMapType             m_documentMap;
00416 
00417     bool                        m_poolAllText;
00418 
00419     static const XalanDOMChar   s_validationString[];
00420 
00421     static const XalanDOMChar   s_dynamicValidationString[];
00422 
00423     static const XalanDOMChar   s_namespacesString[];
00424 
00425     static const XalanDOMChar   s_namespacePrefixesString[];
00426 
00427     static const XalanDOMChar   s_schemaString[];
00428 
00429     static const XalanDOMChar   s_externalSchemaLocationString[];
00430 
00431     static const XalanDOMChar   s_externalNoNamespaceSchemaLocationString[];
00432 };
00433 
00434 
00435 
00436 XALAN_CPP_NAMESPACE_END
00437 
00438 
00439 
00440 #endif  // XALANSOURCETREEPARSERLIAISON_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.