This is a temporary interface that is introduced to temporarily optimize the document storing process. More...

import"XOptimizedStorage.idl";

Public Member Functions
void	insertRawNonEncrStreamElementDirect ([in] string sStreamName, [in] ::com::sun::star::io::XInputStream xInStream) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::packages::NoRawFormatException, ::com::sun::star::container::ElementExistException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to insert a raw stream representing non-encrypted stream with header. More...

void	insertStreamElementDirect ([in] string sStreamName, [in] ::com::sun::star::io::XInputStream xInStream, [in] sequence< ::com::sun::star::beans::PropertyValue > aProperties) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::ElementExistException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to insert a stream to the storage directly. More...

void	copyElementDirectlyTo ([in] string sSourceName, [in] ::com::sun::star::embed::XOptimizedStorage xTargetStorage, [in] string sTargetName) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::container::ElementExistException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to copy storage element directly, not guaranteed to work. More...

void	writeAndAttachToStream ([in] ::com::sun::star::io::XStream xStream) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to switch storage persistence to the provided stream. More...

void	attachToURL ([in] string sURL, [in] boolean bReadOnly) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to switch storage persistence to the provided URL. More...

any	getElementPropertyValue ([in] string sElementName, [in] string sPropertyName) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::io::IOException, ::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::embed::StorageWrappedTargetException )
	allows to get property of the child element with the specified name. More...

void	copyStreamElementData ([in] string sStreamName, [in] ::com::sun::star::io::XStream xTargetStream) raises ( ::com::sun::star::embed::InvalidStorageException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::packages::WrongPasswordException, ::com::sun::star::io::IOException, ::com::sun::star::embed::StorageWrappedTargetException )
	fills the provided stream with the last flushed version of data from the child stream of the storage. More...

Detailed Description

This is a temporary interface that is introduced to temporarily optimize the document storing process.

PLEASE DO NOT USE IT, it might change in any time and will be deprecated soon! Another solution will be introduced as final one.

Member Function Documentation

◆ attachToURL()

void attachToURL	(	[in] string	sURL,
		[in] boolean	bReadOnly
	)
raises	(	::com::sun::star::embed::InvalidStorageException,
		::com::sun::star::lang::IllegalArgumentException,
		::com::sun::star::io::IOException,
		::com::sun::star::embed::StorageWrappedTargetException
	)

allows to switch storage persistence to the provided URL.

The caller is responsible to be sure that the file referenced by the URL contains the same contents as the stream the storage is based currently. Thus using of this method is very dangerous and should be avoided when possible. It is applicable only for root storages.

◆ copyElementDirectlyTo()

void copyElementDirectlyTo	(	[in] string	sSourceName,
		[in] ::com::sun::star::embed::XOptimizedStorage	xTargetStorage,
		[in] string	sTargetName
	)
raises	(	::com::sun::star::embed::InvalidStorageException,
		::com::sun::star::lang::IllegalArgumentException,
		::com::sun::star::container::NoSuchElementException,
		::com::sun::star::container::ElementExistException,
		::com::sun::star::io::IOException,
		::com::sun::star::embed::StorageWrappedTargetException
	)

allows to copy storage element directly, not guaranteed to work.

◆ copyStreamElementData()

void copyStreamElementData	(	[in] string	sStreamName,
		[in] ::com::sun::star::io::XStream	xTargetStream
	)
raises	(	::com::sun::star::embed::InvalidStorageException,
		::com::sun::star::lang::IllegalArgumentException,
		::com::sun::star::packages::WrongPasswordException,
		::com::sun::star::io::IOException,
		::com::sun::star::embed::StorageWrappedTargetException
	)

fills the provided stream with the last flushed version of data from the child stream of the storage.

Parameters

sStreamName	the name of the substream that should be copied
xTargetStream	the target stream where the data must be copied to

Exceptions

com::sun::star::embed::InvalidStorageException	this storage is in invalid state for any reason
com::sun::star::lang::IllegalArgumentException	one of provided arguments is illegal
com::sun::star::packages::WrongPasswordException	the provided password is wrong
com::sun::star::io::IOException	in case of io errors during stream opening
com::sun::star::embed::StorageWrappedTargetException	wraps other exceptions

◆ getElementPropertyValue()

any getElementPropertyValue	(	[in] string	sElementName,
		[in] string	sPropertyName
	)
raises	(	::com::sun::star::embed::InvalidStorageException,
		::com::sun::star::lang::IllegalArgumentException,
		::com::sun::star::container::NoSuchElementException,
		::com::sun::star::io::IOException,
		::com::sun::star::beans::UnknownPropertyException,
		::com::sun::star::beans::PropertyVetoException,
		::com::sun::star::embed::StorageWrappedTargetException
	)

allows to get property of the child element with the specified name.

The implementation of the method might allow to access only subset of the supported by element properties.

◆ insertRawNonEncrStreamElementDirect()

void insertRawNonEncrStreamElementDirect	(	[in] string	sStreamName,
		[in] ::com::sun::star::io::XInputStream	xInStream
	)
raises	(	::com::sun::star::embed::InvalidStorageException,
		::com::sun::star::lang::IllegalArgumentException,
		::com::sun::star::packages::NoRawFormatException,
		::com::sun::star::container::ElementExistException,
		::com::sun::star::io::IOException,
		::com::sun::star::embed::StorageWrappedTargetException
	)

allows to insert a raw stream representing non-encrypted stream with header.

◆ insertStreamElementDirect()

void insertStreamElementDirect	(	[in] string	sStreamName,
		[in] ::com::sun::star::io::XInputStream	xInStream,
		[in] sequence< ::com::sun::star::beans::PropertyValue >	aProperties
	)
raises	(	::com::sun::star::embed::InvalidStorageException,
		::com::sun::star::lang::IllegalArgumentException,
		::com::sun::star::container::ElementExistException,
		::com::sun::star::io::IOException,
		::com::sun::star::embed::StorageWrappedTargetException
	)

allows to insert a stream to the storage directly.

The stream must stay alive till the storage is committed.

◆ writeAndAttachToStream()

void writeAndAttachToStream	(	[in] ::com::sun::star::io::XStream	xStream	)
raises	(	::com::sun::star::embed::InvalidStorageException,
		::com::sun::star::lang::IllegalArgumentException,
		::com::sun::star::io::IOException,
		::com::sun::star::embed::StorageWrappedTargetException
	)

allows to switch storage persistence to the provided stream.

The stream will be filled by the storage. If an empty reference is provided, the storage will create a temporary stream to switch to itself. It is applicable only for root storages.

The documentation for this interface was generated from the following file:

com/sun/star/embed/XOptimizedStorage.idl

Public Member Functions