b9337e22ce
see https://gerrit.libreoffice.org/#/c/3367/ and Change-Id: I00c96fa77d04b33a6f8c8cd3490dfcd9bdc9e84a for details Change-Id: I199a75bc4042af20817265d5ef85b1134a96ff5a
208 lines
9 KiB
C++
208 lines
9 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef _SFX_DOCUMENTMETADATAACCESS_HXX_
|
|
#define _SFX_DOCUMENTMETADATAACCESS_HXX_
|
|
|
|
#include <sal/config.h>
|
|
|
|
#include <sfx2/dllapi.h>
|
|
|
|
#include <com/sun/star/uno/XComponentContext.hpp>
|
|
#include <com/sun/star/rdf/XDocumentMetadataAccess.hpp>
|
|
#include <com/sun/star/rdf/XRepositorySupplier.hpp>
|
|
|
|
#include <cppuhelper/implbase1.hxx>
|
|
|
|
#include <boost/utility.hpp>
|
|
|
|
#include <memory>
|
|
|
|
|
|
/** Implementation of the interface com.sun.star.rdf.XDocumentMetadataAccess
|
|
|
|
This is not a service only because it needs some kind of XML ID registry
|
|
from the document, and i do not like defining an API for that.
|
|
Also, the implementation does _no_ locking, so make sure access is
|
|
protected externally.
|
|
|
|
@author mst
|
|
*/
|
|
|
|
namespace com { namespace sun { namespace star { namespace embed {
|
|
class XStorage;
|
|
} } } }
|
|
|
|
namespace sfx2 {
|
|
|
|
|
|
/** create a base URI for loading metadata from an ODF (sub)document.
|
|
|
|
@param i_xContext component context
|
|
@param i_xStorage storage for the document; FileSystemStorage is allowed
|
|
@param i_rPkgURI the URI for the package
|
|
@param i_rSubDocument (optional) path of the subdocument in package
|
|
|
|
@return a base URI suitable for XDocumentMetadataAccess::loadFromStorage
|
|
*/
|
|
::com::sun::star::uno::Reference< ::com::sun::star::rdf::XURI> SFX2_DLLPUBLIC
|
|
createBaseURI(
|
|
::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>
|
|
const & i_xContext,
|
|
::com::sun::star::uno::Reference< ::com::sun::star::embed::XStorage>
|
|
const & i_xStorage,
|
|
OUString const & i_rPkgURI,
|
|
OUString const & i_rSubDocument = OUString());
|
|
|
|
|
|
class IXmlIdRegistrySupplier;
|
|
struct DocumentMetadataAccess_Impl;
|
|
|
|
|
|
class SFX2_DLLPUBLIC DocumentMetadataAccess :
|
|
private boost::noncopyable,
|
|
public ::cppu::WeakImplHelper1<
|
|
::com::sun::star::rdf::XDocumentMetadataAccess>
|
|
{
|
|
public:
|
|
explicit DocumentMetadataAccess(::com::sun::star::uno::Reference<
|
|
::com::sun::star::uno::XComponentContext > const & i_xContext,
|
|
IXmlIdRegistrySupplier const & i_rRegistrySupplier,
|
|
OUString const & i_rBaseURI);
|
|
// N.B.: in contrast to previous, this constructor does _not_ initialize!
|
|
// caller must immediately call loadFromStorage/Medium!
|
|
explicit DocumentMetadataAccess(::com::sun::star::uno::Reference<
|
|
::com::sun::star::uno::XComponentContext > const & i_xContext,
|
|
IXmlIdRegistrySupplier const & i_rRegistrySupplier);
|
|
virtual ~DocumentMetadataAccess();
|
|
|
|
// ::com::sun::star::rdf::XNode:
|
|
virtual OUString SAL_CALL getStringValue()
|
|
throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
// ::com::sun::star::rdf::XURI:
|
|
virtual OUString SAL_CALL getNamespace()
|
|
throw (::com::sun::star::uno::RuntimeException);
|
|
virtual OUString SAL_CALL getLocalName()
|
|
throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
// ::com::sun::star::rdf::XRepositorySupplier:
|
|
virtual ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XRepository > SAL_CALL getRDFRepository()
|
|
throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
// ::com::sun::star::rdf::XDocumentMetadataAccess:
|
|
virtual ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XMetadatable > SAL_CALL
|
|
getElementByMetadataReference(
|
|
const ::com::sun::star::beans::StringPair & i_rReference)
|
|
throw (::com::sun::star::uno::RuntimeException);
|
|
virtual ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XMetadatable > SAL_CALL
|
|
getElementByURI(const ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XURI > & i_xURI)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException);
|
|
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XURI > > SAL_CALL getMetadataGraphsWithType(
|
|
const ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XURI > & i_xType)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException);
|
|
virtual ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XURI> SAL_CALL
|
|
addMetadataFile(const OUString & i_rFileName,
|
|
const ::com::sun::star::uno::Sequence<
|
|
::com::sun::star::uno::Reference< ::com::sun::star::rdf::XURI >
|
|
> & i_rTypes)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::container::ElementExistException);
|
|
virtual ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XURI> SAL_CALL
|
|
importMetadataFile(::sal_Int16 i_Format,
|
|
const ::com::sun::star::uno::Reference<
|
|
::com::sun::star::io::XInputStream > & i_xInStream,
|
|
const OUString & i_rFileName,
|
|
const ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XURI > & i_xBaseURI,
|
|
const ::com::sun::star::uno::Sequence<
|
|
::com::sun::star::uno::Reference< ::com::sun::star::rdf::XURI >
|
|
> & i_rTypes)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::datatransfer::UnsupportedFlavorException,
|
|
::com::sun::star::container::ElementExistException,
|
|
::com::sun::star::rdf::ParseException,
|
|
::com::sun::star::io::IOException);
|
|
virtual void SAL_CALL removeMetadataFile(
|
|
const ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XURI > & i_xGraphName)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::container::NoSuchElementException);
|
|
virtual void SAL_CALL addContentOrStylesFile(
|
|
const OUString & i_rFileName)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::container::ElementExistException);
|
|
virtual void SAL_CALL removeContentOrStylesFile(
|
|
const OUString & i_rFileName)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::container::NoSuchElementException);
|
|
|
|
virtual void SAL_CALL loadMetadataFromStorage(
|
|
const ::com::sun::star::uno::Reference<
|
|
::com::sun::star::embed::XStorage > & i_xStorage,
|
|
const ::com::sun::star::uno::Reference<
|
|
::com::sun::star::rdf::XURI > & i_xBaseURI,
|
|
const ::com::sun::star::uno::Reference<
|
|
::com::sun::star::task::XInteractionHandler> & i_xHandler)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::lang::WrappedTargetException);
|
|
virtual void SAL_CALL storeMetadataToStorage(
|
|
const ::com::sun::star::uno::Reference<
|
|
::com::sun::star::embed::XStorage > & i_xStorage)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::lang::WrappedTargetException);
|
|
virtual void SAL_CALL loadMetadataFromMedium(
|
|
const ::com::sun::star::uno::Sequence<
|
|
::com::sun::star::beans::PropertyValue > & i_rMedium)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::lang::WrappedTargetException);
|
|
virtual void SAL_CALL storeMetadataToMedium(
|
|
const ::com::sun::star::uno::Sequence<
|
|
::com::sun::star::beans::PropertyValue > & i_rMedium)
|
|
throw (::com::sun::star::uno::RuntimeException,
|
|
::com::sun::star::lang::IllegalArgumentException,
|
|
::com::sun::star::lang::WrappedTargetException);
|
|
|
|
private:
|
|
std::auto_ptr<DocumentMetadataAccess_Impl> m_pImpl;
|
|
};
|
|
|
|
} // namespace sfx2
|
|
|
|
#endif // _SFX_DOCUMENTMETADATAACCESS_HXX_
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|