xref: /AOO41X/main/forms/source/xforms/submission/serialization.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef __SERIALIZATION_HXX
29*cdf0e10cSrcweir #define __SERIALIZATION_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <map>
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir #include <sal/types.h>
34*cdf0e10cSrcweir #include <rtl/ustring.hxx>
35*cdf0e10cSrcweir #include <com/sun/star/uno/Reference.hxx>
36*cdf0e10cSrcweir #include <com/sun/star/uno/Sequence.hxx>
37*cdf0e10cSrcweir #include <com/sun/star/beans/NamedValue.hpp>
38*cdf0e10cSrcweir #include <com/sun/star/io/XInputStream.hpp>
39*cdf0e10cSrcweir #include <com/sun/star/xml/xpath/XXPathObject.hpp>
40*cdf0e10cSrcweir #include <com/sun/star/xml/dom/XDocumentFragment.hpp>
41*cdf0e10cSrcweir 
42*cdf0e10cSrcweir namespace CSS = com::sun::star;
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir /**
45*cdf0e10cSrcweir Serialize an XObject
46*cdf0e10cSrcweir */
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir typedef std::map<rtl::OUString, rtl::OUString> PropMap;
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir class CSerialization
51*cdf0e10cSrcweir {
52*cdf0e10cSrcweir protected:
53*cdf0e10cSrcweir     CSS::uno::Reference< CSS::xml::dom::XDocumentFragment > m_aFragment;
54*cdf0e10cSrcweir     PropMap m_properties;
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir public:
57*cdf0e10cSrcweir     virtual ~CSerialization() {}
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir     /**
60*cdf0e10cSrcweir     sets the XObject that is to serialized
61*cdf0e10cSrcweir     */
62*cdf0e10cSrcweir     virtual void setSource(const CSS::uno::Reference< CSS::xml::dom::XDocumentFragment >& aFragment)
63*cdf0e10cSrcweir     {
64*cdf0e10cSrcweir         m_aFragment = aFragment;
65*cdf0e10cSrcweir     }
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir     /**
68*cdf0e10cSrcweir     set the properties from the submission element
69*cdf0e10cSrcweir     that control aspects of the serialization
70*cdf0e10cSrcweir     eachs serialization may support individual properties
71*cdf0e10cSrcweir     */
72*cdf0e10cSrcweir     void setProperties(const CSS::uno::Sequence< CSS::beans::NamedValue >& props)
73*cdf0e10cSrcweir     {
74*cdf0e10cSrcweir         m_properties.clear();
75*cdf0e10cSrcweir         rtl::OUString aValue;
76*cdf0e10cSrcweir         for (sal_Int32 i=0; i<props.getLength(); i++)
77*cdf0e10cSrcweir         {
78*cdf0e10cSrcweir             if (props[i].Value >>= aValue)
79*cdf0e10cSrcweir                 m_properties.insert(PropMap::value_type(props[i].Name, aValue));
80*cdf0e10cSrcweir         }
81*cdf0e10cSrcweir     }
82*cdf0e10cSrcweir 
83*cdf0e10cSrcweir     /**
84*cdf0e10cSrcweir     start the serialization process
85*cdf0e10cSrcweir     */
86*cdf0e10cSrcweir     virtual void serialize()=0;
87*cdf0e10cSrcweir 
88*cdf0e10cSrcweir     /**
89*cdf0e10cSrcweir     get the serialized bytes.
90*cdf0e10cSrcweir     reads up to buffer->getLength() bytes and returns the number of
91*cdf0e10cSrcweir     bytes read.
92*cdf0e10cSrcweir     returns -1 on error
93*cdf0e10cSrcweir     */
94*cdf0e10cSrcweir     virtual CSS::uno::Reference< CSS::io::XInputStream > getInputStream() = 0;
95*cdf0e10cSrcweir 
96*cdf0e10cSrcweir };
97*cdf0e10cSrcweir 
98*cdf0e10cSrcweir #endif
99