forms/source/xforms/submission/serialization.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_FORMS_SOURCE_XFORMS_SUBMISSION_SERIALIZATION_HXX
  21 #define INCLUDED_FORMS_SOURCE_XFORMS_SUBMISSION_SERIALIZATION_HXX
  22
  23 #include <map>
  24
  25 #include <sal/types.h>
  26 #include <rtl/ustring.hxx>
  27 #include <com/sun/star/uno/Reference.hxx>
  28 #include <com/sun/star/uno/Sequence.hxx>
  29 #include <com/sun/star/beans/NamedValue.hpp>
  30 #include <com/sun/star/io/XInputStream.hpp>
  31 #include <com/sun/star/xml/xpath/XXPathObject.hpp>
  32 #include <com/sun/star/xml/dom/XDocumentFragment.hpp>
  33
  34 /**
  35 Serialize an XObject
  36 */
  37
  38 typedef std::map<OUString, OUString> PropMap;
  39
  40 class CSerialization
  41 {
  42 protected:
  43     css::uno::Reference< css::xml::dom::XDocumentFragment > m_aFragment;
  44     PropMap m_properties;
  45
  46 public:
  47     virtual ~CSerialization() {}
  48
  49     /**
  50     sets the XObject that is to serialized
  51     */
  52     void setSource(const css::uno::Reference< css::xml::dom::XDocumentFragment >& aFragment)
  53     {
  54         m_aFragment = aFragment;
  55     }
  56
  57     /**
  58     set the properties from the submission element
  59     that control aspects of the serialization
  60     eachs serialization may support individual properties
  61     */
  62     void setProperties(const css::uno::Sequence< css::beans::NamedValue >& props)
  63     {
  64         m_properties.clear();
  65         OUString aValue;
  66         for (sal_Int32 i=0; i<props.getLength(); i++)
  67         {
  68             if (props[i].Value >>= aValue)
  69                 m_properties.insert(PropMap::value_type(props[i].Name, aValue));
  70         }
  71     }
  72
  73     /**
  74     start the serialization process
  75     */
  76     virtual void serialize()=0;
  77
  78     /**
  79     get the serialized bytes.
  80     reads up to buffer->getLength() bytes and returns the number of
  81     bytes read.
  82     returns -1 on error
  83     */
  84     virtual css::uno::Reference< css::io::XInputStream > getInputStream() = 0;
  85
  86 };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */