:: com :: sun :: star :: configuration ::

service HierarchyAccess
Description
provides access to a hierarchy of descendant elements.

Subnodes are accessed by their name. Values that are direct or indirect descendants of this tree node can be retrieved. Non-value subnodes can be navigated using container interfaces. Other interfaces provide access to information about this node. Changes to values in the subtree can be monitored by event listeners.

Elements of this container that are not simple values are similar containers themselves, thus (recursively) forming a hierarchical tree.

Implementations of this service usually also implement service HierarchyElement , which concerns the complementary role of being accessible as an element of the hierarchy.


Exported Interfaces
::com::sun::star::container::XNameAccess
Description
allows access to immediate children of this node.

::com::sun::star::container::XNameAccess::getByName() returns an any holding either a simple value or an interface on another HierarchyAccess if the child is not a simple value.

::com::sun::star::container::XHierarchicalNameAccess
Description
allows access to all descendants of this node

::com::sun::star::container::XHierarchicalNameAccess::getByHierarchicalName() returns an any holding either a simple value or an interface on another HierarchyAccess if the descendant is not a simple value.

::com::sun::star::container::XContainer
Description
allows attaching listeners to this node to monitor changes to immediate child nodes.
::com::sun::star::beans::XExactName
Description
provides support for inexact names.

Exact names can be obtained for simple or hierarchical names for use in ::com::sun::star::container::XNameAccess , ::com::sun::star::container::XHierarchicalNameAccess , ::com::sun::star::beans::XPropertySet or any other interfaces that allow access to or manipulation of subnodes selected by name or hierarchical name.

If an inexact name could be matched to either a simple or a hierachical name, the simple (immediate child) name is preferred.


 
Top of Page