Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

service ExtendedTypeDetectionFactory
Description
factory to create extended type detection components.

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.

Since
OOo 1.1.2

Exported Interfaces - Summary
::com::sun::star::lang::XMultiServiceFactory

factory interface to create and initialize extended type detection components. (details)

::com::sun::star::container::XNameAccess

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

::com::sun::star::container::XNameContainer

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

::com::sun::star::container::XContainerQuery

provides search on the configuration data set. (details)

::com::sun::star::util::XFlushable

can be used to perform container changes. (details)

Exported Interfaces - Details
::com::sun::star::lang::XMultiServiceFactory
Description
factory interface to create and initialize extended type detection components.

A detection component must be specified by it's uno implementation name and will be crated then. Every new created component can be intialized with it's own configuration data and may given optional arguments of the corresponding createInstanceWithArguments() request. To do so the service 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 detector component. 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.

::com::sun::star::container::XNameAccess
Description
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] It means the uno implementation name of the detector 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 components; if all of them uses a generic service identifier!
Types [sequence< string >] It's a list of all types, which can be detected by this extended detection component. All items of this list must match an item of the TypeDetection container service.

::com::sun::star::container::XNameContainer
Usage Restrictions
optional
Description
provides a write access to the configuration data.
::com::sun::star::container::XContainerQuery
Usage Restrictions
optional
Description
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.

::com::sun::star::util::XFlushable
Usage Restrictions
optional
Description
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 and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.