The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15



Tips ‘n’ Tricks


:: com :: sun :: star :: document ::

service FilterFactory
factory to create filter components.

After a generic TypeDetection an internal type name will be known. Further a generic ::com::sun::star::frame::FrameLoader can use this information, to search a suitable filter (may the default filter) at this factory and use it for loading the document into a specified frame.

This factory implements read/write access on the underlying configuration set. and further a validate and flush mechanism for more performance and a special query mode can be used here too.

Developers Guide
OfficeDev - Integrating Import and Export Filters

Exported Interfaces - Summary

factory interface to create and initialize filter components. (details)


provides read access to the complete set of configuration data. (details)


provides a write access to the configuration data. (details)


provides search on the configuration data set. (details)


can be used to perform container changes. (details)

Exported Interfaces - Details
factory interface to create and initialize filter components.

Current behaviour

The methods createInstance() or createInstanceWithArguments() of this interface must be called with an internal type name!. This name is used internaly to search a suitable (mostly the default) filter for this type then. The found filter will be created, initialized and returned then. Creation of a filter by using it's internal filter name directly can be reached by using createInstanceWithArguments() with an optional property "FilterName" only. See the following example:

 private createFilterDirect( xFilterFactory ,
 java.lang.String sInternalFilterName )
 { aFilterProp = new;
 aFilterProp.Name = "FilterName";
 aFilterProp.Value = sInternalFilterName;[] lProps = new[1];
 lProps[0] = aFilterProp;

 java.lang.Object aFilter = xFilterFactory.createInstanceWithArguments("", lProps);
 return (, aFilter);

Proposed behaviour

Searching of a suitable filter for a given internal type name, must be done by the new interface ::com::sun::star::container::XContainerQuery, available on this factory too. The factory interface can be used to create filter components by it's internal filter name only.

How it can be distinguished?

The new prosposed implementation will throw an ::com::sun::star::container::NoSuchElementException if the first parameter of createInstance() or createInstanceWithArguments() does not match to a valid container (means filter) item. Further it will throw an ::com::sun::star::lang::IllegalArgumentException if the optional parameter "FilterName" could not be detected inside the argument list of call createInstanceWithArguments().

Initialization of a filter component

Every filter, which was created by this factory can(!) be intialized with it's own configuration data and may given optional arguments of the corresponding createInstanceWithArguments() request. To do so the filter instance must support the optional interface ::com::sun::star::lang::XInitialization. The arguments parameter will have the following structure:

  • sequence< Any >[0] contains a sequence< PropertyValue >, which represent the configuration data set of this filter. The used properties are the same, as they are available at the container interface of this factoyr service. (see below)
  • Every following item of the argument list sequence< Any >[1..n] contains the copied argument of the corresponding createInstanceWithArguments() call. That means: Item 0 or the original list was copied as item 1 of the destination list ... etc.

provides read access to the complete set of configuration data.

Every container item is specified as a set of properties and will be represented by a sequence< PropertyValue > structure. Follow properties are supported: (But note: not all of them must be present everytimes!)

Property Name Value Type Description
Name [string] The internal name is the only value, which makes a container item unique.
UIName [string] It contains the localized name for this filter for the current locale.
UINames [sequence< string >] It contains all available localized names for this filter. The are organized in pairs and represented as a structure of sequence< PropertyValue >. The name of such property must be interpreted as locale; it's value as the localized filter name corresponding to this locale.
Type [string] Every filter is registered for a type. This value contains the internal name of it. (see service TypeDetection for further informations)
DocumentService [string] It's the uno service name of the document type, which can be handled by this filter. (e.g. ::com::sun::star::text::TextDocument)
FilterService [string] It means the uno implementation name of the filter component. Note: It means the realy the implementation instead of the uno service name. Because it's not possible to distinguish between more then one filters; if all of them uses a generic identifier!
Flags [integer] They describe the filter more specific.
(e.g. they mark it as IMPORT/EXPORT or DEFAULT filter.)
UserData [string] This field contains filter specific configuration data.
FileFormatVersion [integer] It specifies the supported file format version if there exist more then ones.
TemplateName [string] It's the name of a suitable default template.

All elements of this container will be adressed by his internal name, and it must be an unambigous value.

Usage Restrictions
provides a write access to the configuration data.
provides search on the configuration data set.

Against simple property search it provides some complex algorithms too. For further informations please read the SDK documentation.

Usage Restrictions
can be used to perform container changes.

Because the complexness of such configuration set can be very high, it seams not very usefull to update the undelying configuration layer on every container change request immediatly. Another strategy can be to make all changes (adding/changing/removing of items) and call flush at the end. That will validate the whole container and reject inconsistent data sets. Only in case all made changes was correct, they will be written back to the configuration. Further this interface provides the possibelity, that interested changes listener can be registered too.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.