:: com :: sun :: star :: ucb ::

service HierarchyDataReadAccess

Exported Interfaces - Summary
::com::sun::star::container::XNameAccess

gives access to the data members of a hierarchy data node. (details)

::com::sun::star::container::XHierarchicalNameAccess

gives access to the data members of a hierarchy data node as well as to any child nodes or to the data members of child nodes using a hierarchical name. (details)

::com::sun::star::util::XChangesNotifier

allows registering listeners that observe the hierarchy data source. (details)

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

allows controlling or observing the lifetime of the hierarchy data access object.

Exported Interfaces - Details
::com::sun::star::container::XNameAccess
Description
gives access to the data members of a hierarchy data node.

Examples:

  • getByName( "Title" ) will return an `any` containing a string containing the title of the node.
  • getByName( "Children" ) will return an `any` containing an implementation of service HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service HierarchyDataReadWriteAccess if it was called on a writable node.
::com::sun::star::container::XHierarchicalNameAccess
Description
gives access to the data members of a hierarchy data node as well as to any child nodes or to the data members of child nodes using a hierarchical name.

A hierarchical name consists of segments that are separated by a single slash ("/"). There is neither a leading nor a trailing slash allowed.

  • path = segment ( '/' segment )*
  • segment = '[' quoted-string ']'
  • quoted-string = "'" escaped-string "'"
  • escaped-string = escaped according to XML attribute naming conventions

Examples:

  • getByHierarchicalName( "Title" ) will return an `any` containing a string containing the title of the node itself.
  • getByHierarchicalName( "Children/['subnode1']" ) will give access to the child node named "subnode1" of the node. It will return an `any` containing an implementation of service HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service HierarchyDataReadWriteAccess if it was called on a writable node.
  • getByHierarchicalName( "Children/['subnode2']/TargetURL" ) will give direct access to the "TargetURL" data member of the child node named "subnode2" of the node. It will return an `any` containing a `string` containing the target URL of the node.
  • getByHierarchicalName( "Children/['subnode3']/Children" ) will give direct access to the "Children" data member of the child node named "subnode3" of the node. It will return an `any` containing an implementation of service HierarchyDataReadAccess, if it was called on a read-only node. It will return an implementation of service HierarchyDataReadWriteAccess if it was called on a writable node.
::com::sun::star::util::XChangesNotifier
Description
allows registering listeners that observe the hierarchy data source.

A client can register an com::sun::star::util::XChangesListener, which will receive notifications for any changes within the hierarchy (fragment) this object represents.

An implementation should collect as many changes as possible into a single com::sun::star::util::ChangesEvent.

::com::sun::star::lang::XComponent
Description
allows controlling or observing the lifetime of the hierarchy data access object.

 
Top of Page