Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

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-2000 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 <XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 // Standard Library header files.
00067 #include <map>
00068 
00069 
00070 
00071 #include <XercesParserLiaison/XercesDOMSupport.hpp>
00072 #include <XercesParserLiaison/XercesParserLiaison.hpp>
00073 
00074 
00075 
00076 class ContentHandler;
00077 class DTDHandler;
00078 class LexicalHandler;
00079 class XalanSourceTreeDOMSupport;
00080 class XalanSourceTreeDocument;
00081 
00082 
00083 
00084 class XALAN_XALANSOURCETREE_EXPORT  XalanSourceTreeParserLiaison : public XMLParserLiaison
00085 {
00086 public:
00087 
00093     XalanSourceTreeParserLiaison(XalanSourceTreeDOMSupport&     theSupport);
00094 
00095     virtual
00096     ~XalanSourceTreeParserLiaison();
00097 
00098     // These interfaces are inherited from XMLParserLiaison...
00099 
00100     virtual void
00101     reset();
00102 
00103     virtual ExecutionContext*
00104     getExecutionContext() const;
00105 
00106     virtual void
00107     setExecutionContext(ExecutionContext&   theContext);
00108 
00109     virtual bool
00110     supportsSAX() const;
00111 
00112     virtual XalanDocument*
00113     parseXMLStream(
00114             const InputSource&      reader,
00115             const XalanDOMString&   identifier = XalanDOMString());
00116 
00117     virtual void
00118     parseXMLStream(
00119             const InputSource&      inputSource,
00120             DocumentHandler&        handler,
00121             const XalanDOMString&   identifier = XalanDOMString());
00122 
00123     virtual XalanDocument*
00124     createDocument();
00125 
00126     virtual XalanDocument*
00127     createDOMFactory();
00128 
00129     virtual void
00130     destroyDocument(XalanDocument*  theDocument);
00131 
00132     virtual void
00133     setSpecialCharacters(const XalanDOMString&  str);
00134 
00135     virtual const XalanDOMString&
00136     getSpecialCharacters() const;
00137 
00138     virtual int
00139     getIndent() const;
00140 
00141     virtual void
00142     setIndent(int   i);
00143 
00144     virtual bool
00145     getShouldExpandEntityRefs() const;
00146 
00147     virtual void
00148     SetShouldExpandEntityRefs(bool  b);
00149 
00150     virtual bool
00151     getUseValidation() const;
00152 
00153     virtual void
00154     setUseValidation(bool   b);
00155 
00156     virtual const XalanDOMString
00157     getParserDescription() const;
00158 
00159 
00160     // These interfaces are new to XalanSourceTreeParserLiaison...
00161 
00171     virtual void
00172     parseXMLStream(
00173             const InputSource&      theInputSource,
00174             ContentHandler&         theContentHandler,
00175             DTDHandler*             theDTDHandler = 0,
00176             LexicalHandler*         theLexicalHandler = 0,
00177             const XalanDOMString&   theIdentifier = XalanDOMString());
00178 
00189     virtual bool
00190     getIncludeIgnorableWhitespace() const;
00191 
00210     virtual void
00211     setIncludeIgnorableWhitespace(bool  include);
00212 
00219     virtual ErrorHandler*
00220     getErrorHandler();
00221 
00228     virtual const ErrorHandler*
00229     getErrorHandler() const;
00230 
00241     virtual void
00242     setErrorHandler(ErrorHandler*   handler);
00243 
00253     virtual bool
00254     getDoNamespaces() const;
00255 
00273     virtual void
00274     setDoNamespaces(bool    newState);
00275 
00285     virtual bool
00286     getExitOnFirstFatalError() const;
00287 
00303     virtual void
00304     setExitOnFirstFatalError(bool   newState);
00305 
00312     virtual EntityResolver*
00313     getEntityResolver();
00314 
00321     virtual const EntityResolver*
00322     getEntityResolver() const;
00323 
00335     virtual void
00336     setEntityResolver(EntityResolver*   resolver);
00337 
00347     XalanSourceTreeDocument*
00348     mapDocument(const XalanDocument*    theDocument) const;
00349 
00355     XalanSourceTreeDocument*
00356     createXalanSourceTreeDocument();
00357 
00358 #if defined(XALAN_NO_NAMESPACES)
00359     typedef map<const XalanDocument*,
00360                 XalanSourceTreeDocument*,
00361                 less<const XalanDocument*> >    DocumentMapType;
00362 #else
00363     typedef std::map<const XalanDocument*,
00364                      XalanSourceTreeDocument*>  DocumentMapType;
00365 #endif
00366 
00367 private:
00368 
00369     // Data members...
00370     XercesDOMSupport                m_xercesDOMSupport; // Must be before m_xercesParserLiaison!!!
00371 
00372     XercesParserLiaison             m_xercesParserLiaison;
00373 
00374     DocumentMapType                 m_documentMap;
00375 
00376     XalanSourceTreeDOMSupport&      m_domSupport;
00377 };
00378 
00379 
00380 
00381 #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++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.