Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.5

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XSLTResultTarget.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2002 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  * $ Id: $
00058  
00059  */
00060 
00061 #if !defined(XALAN_XSLTRESULTTARGET_HEADER_GUARD)
00062 #define XALAN_XSLTRESULTTARGET_HEADER_GUARD
00063 
00064 // Base include file.  Must be first.
00065 #include "XSLTDefinitions.hpp"
00066 
00067 
00068 
00069 #if defined(XALAN_CLASSIC_IOSTREAMS)
00070 class ostream;
00071 #else
00072 #include <iosfwd>
00073 #endif
00074 
00075 
00076 
00077 #include <XalanDOM/XalanDOMString.hpp>
00078 
00079 
00080 
00081 XALAN_CPP_NAMESPACE_BEGIN
00082 
00083 
00084 
00085 class FormatterListener;
00086 class Writer;
00087 
00088 
00089 
00090 class XALAN_XSLT_EXPORT XSLTResultTarget
00091 {
00092 public:
00093 
00094 #if defined(XALAN_NO_STD_NAMESPACE)
00095     typedef ostream         StreamType;
00096 #else
00097     typedef std::ostream    StreamType;
00098 #endif
00099 
00100     explicit
00101     XSLTResultTarget();
00102 
00108     XSLTResultTarget(const XalanDOMString&  fileName);
00109 
00115     XSLTResultTarget(const XalanDOMChar*    fileName);
00116 
00122     XSLTResultTarget(const char*    fileName);
00123 
00129     XSLTResultTarget(StreamType*    theStream);
00130 
00136     XSLTResultTarget(StreamType&    theStream);
00137 
00144     XSLTResultTarget(Writer*    characterStream);
00145 
00151     XSLTResultTarget(FormatterListener&     flistener);
00152 
00153     ~XSLTResultTarget();
00154 
00160     void
00161     setFileName(const char*     fileName)
00162     {
00163         if (fileName == 0)
00164         {
00165             m_fileName.clear();
00166         }
00167         else
00168         {
00169             m_fileName = fileName;
00170         }
00171     }
00172 
00178     void
00179     setFileName(const XalanDOMString&   fileName)
00180     {
00181         m_fileName = fileName;
00182     }
00183 
00189     const XalanDOMString&
00190     getFileName() const
00191     {
00192         return m_fileName;
00193     }
00194 
00201     void
00202     setByteStream(StreamType*           byteStream)
00203     {
00204         m_byteStream = byteStream;
00205     }
00206 
00212     StreamType*
00213     getByteStream() const
00214     {
00215         return m_byteStream;
00216     }
00217 
00223     void
00224     setEncoding(const XalanDOMChar*     encoding)
00225     {
00226         if (encoding == 0)
00227         {
00228             m_encoding.clear();
00229         }
00230         else
00231         {
00232             m_encoding = encoding;
00233         }
00234     }
00235 
00241     void
00242     setEncoding(const XalanDOMString&   encoding)
00243     {
00244         m_encoding = encoding;
00245     }
00246 
00252     const XalanDOMString&
00253     getEncoding() const
00254     {
00255         return m_encoding;
00256     }
00257 
00264     void
00265     setCharacterStream(Writer*  characterStream)
00266     {
00267         m_characterStream = characterStream;
00268     }
00269 
00275     Writer*
00276     getCharacterStream() const
00277     {
00278         return m_characterStream;
00279     }
00280 
00286     void
00287     setFormatterListener(FormatterListener*     handler)
00288     {
00289         m_formatterListener = handler;
00290     }
00291 
00297     FormatterListener*
00298     getFormatterListener() const
00299     {
00300         return m_formatterListener;
00301     }
00302 
00303 private:
00304 
00305     XalanDOMString          m_fileName;
00306 
00307     StreamType*             m_byteStream;
00308 
00309     XalanDOMString          m_encoding;
00310 
00311     Writer*                 m_characterStream;
00312 
00313     FormatterListener*      m_formatterListener;
00314 };
00315 
00316 
00317 
00318 XALAN_CPP_NAMESPACE_END
00319 
00320 
00321 
00322 #endif  // XALAN_XSLTRESULTTARGET_HEADER_GUARD

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.5
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.