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 :: ucb ::

service HierarchyDataSource
Description
manages one or more complete sets of hierarchy data and serves as a factory for objects that provide access to a subset of the data.

Note: This is an abstract service. This means, that there should never be implementations that can be instanciated using the service name com.sun.star.ucb.HierarchyDataSource. Each implementation must provide its own service name that can be used to create instances of that service implementation. Important for those service specifications is also to specify which of the optional parts are supported by the implementation.


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

allows creating access objects for specific views such as subsets and fragments of the hierrachy data. (details)

::com::sun::star::lang::XComponent

allows controlling or observing the lifetime of the hierarchy data source and its views.

Exported Interfaces - Details
::com::sun::star::lang::XMultiServiceFactory
Description
allows creating access objects for specific views such as subsets and fragments of the hierrachy data.

The parameter aServiceSpecifier passed to ::com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments supports at least the service specifier "com.sun.star.ucb.HierarchyDataReadAccess", which will create a read-only view to the data. The object that is created implements the service HierarchyDataReadAccess.

Optionally the factory may support writable views. A writable view is requested by passing the service specifier "com.sun.star.ucb.HierarchyDataReadWriteAccess" to ::com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments The object that is created implements the service HierarchyDataReadWriteAccess.

The arguments passed to ::com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments in parameter aArguments specify the view of the data that should be created. That is, they determine the subset of elements that can be accessed starting from the returned object. Each element of the argument sequence should be a ::com::sun::star::beans::PropertyValue, so that the parameters can be identified by name rather than by position.

With both of the standard service specifiers above, an implementation must accept a property named nodepath of type string. This property must contain the absolute path to an element of the data. The view that is selected consists of the named element and all its decendants. A path consists of segments that are separated by a single slash ('/'). There is neither a leading nor a trailing slash allowed. The root of the hierarchy data always has an empty path. Refer to HierarchyDataReadAccess for more informtion on hierarchical names.

Other arguments can be used to control the behavior of the view. These are different for different implementations. Whether and how they are used may also depend on the configuration store and configuration that were selected when the provider was created.

An implementation must ignore unknown arguments.

The implementation of ::com::sun::star::lang::XMultiServiceFactory::createInstance must behave exactly as if ::com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments were called passing one single property named nodepath where the property value is an empty string. Thus it always creates a view to the root of the hierarchy data.

::com::sun::star::lang::XComponent
Description
allows controlling or observing the lifetime of the hierarchy data source and its views.

 
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.