1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_xml_sax_XFastSAXSerializable_idl__
29#define __com_sun_star_xml_sax_XFastSAXSerializable_idl__
30
31#ifndef __com_sun_star_xml_sax_XFastDocumentHandler_idl__
32#include <com/sun/star/xml/sax/XFastDocumentHandler.idl>
33#endif
34
35#ifndef __com_sun_star_xml_sax_XFastTokenHandler_idl__
36#include <com/sun/star/xml/sax/XFastTokenHandler.idl>
37#endif
38
39#ifndef __com_sun_star_beans_StringPair_idl__
40#include <com/sun/star/beans/StringPair.idl>
41#endif
42
43#ifndef __com_sun_star_beans_Pair_idl__
44#include <com/sun/star/beans/Pair.idl>
45#endif
46
47module com { module sun { module star { module xml { module sax {
48
49//=============================================================================
50/** serializes a DOM tree by generating FastSAX events.
51
52    <p>
53    </p>
54
55    @since OOo 3.1
56
57*/
58interface XFastSAXSerializable
59{
60
61	//-------------------------------------------------------------------------
62    /** serializes an object (e.g. a DOM tree) that represents an XML document
63        by generating fast SAX events.
64
65        @param  handler
66            the SAX event handler that should receive the generated events
67        @param  tokenHandler
68            the fast SAX token handler that is used to translate names
69        @param  namespaces
70            a list of namespace declarations that will be added to the root
71            element node of the XML document
72            <p>
73            This is necessary mostly because the DOM implementation does
74            not permit attaching namespaces declarations directly to nodes,
75            which may lead to duplicate namespace declarations on export,
76            and thus larger documents.
77            Note that the first part of each tuple is the prefix,
78            e.g. "office", and the second is the numeric namespace identifier.
79            </p>
80        @param  registerNamespaces
81            a list of namespace url / namespace token pairs. you need
82            to register all namespace in order to have them recognized
83            during export. Namespace tokens must be greater than
84            FastToken::NAMESPACE.
85            </p>
86
87        @throws com::sun::star::xml::sax::SAXException
88                 if serializing the XML document fails
89     */
90    void fastSerialize([in] sax::XFastDocumentHandler handler,
91                       [in] sax::XFastTokenHandler tokenHandler,
92                       [in] sequence< beans::StringPair > namespaces,
93                       [in] sequence< beans::Pair<string, long> > registerNamespaces)
94        raises( com::sun::star::xml::sax::SAXException );
95};
96
97}; }; }; }; };
98
99#endif
100