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

interface XAtomServer
Description
an interface to map between strings and ids

a note on atoms:
Atoms are abbreviations for strings. When a string gets registered, it is assigned a numeric id so that said string can always be referred to by this id. This way strings have to be transported only once over remote connections. Valid ids are (in this implementation) non zero, signed 32 bit values. An atom of 0 means that the string in question is not registered

Additionally there is the abstraction of atom class:
Atoms are grouped into classes, so that an id can be assigned to multiple strings, depending on the class context. The main advantage of this is that atoms in one class may be kept to small numbers, so that bandwidth can be reduced by sending the atoms only as 16 bit values. Note that it is up to the user in this case to handle overflows.


Methods' Summary
getClass returns a whole atom class  
getClasses returns mutltiple atom classes  
getAtomDescriptions returns the strings for an arbitrary amount of atoms of multiple classes  
getRecentAtoms returns the atoms that have been registered to a class after an already known atom  
getAtom registers or searches for a string  
Methods' Details
getClass
sequence< AtomDescription >
getClass( [in] long  atomClass );

Description
returns a whole atom class
Parameter atomClass
which class to return
Returns
the descriptions for all atoms of class atomClass
getClasses
sequence< sequence< AtomDescription > >
getClasses( [in] sequence< long >  atomClasses );

Description
returns mutltiple atom classes
Parameter atomClasses
which classes to return
Returns
the descriptions for all atoms of the requested classes
getAtomDescriptions
sequence< string >
getAtomDescriptions( [in] sequence< AtomClassRequest >  atoms );

Description
returns the strings for an arbitrary amount of atoms of multiple classes
Parameter atoms
describes which strings to return
Returns
the strings for the requested atoms
getRecentAtoms
sequence< AtomDescription >
getRecentAtoms( [in] long  atomClass,
[in] long  atom );

Description
returns the atoms that have been registered to a class after an already known atom

Hint to implementor: using ascending atoms is the easiest way to decide, which atoms are recent.

Parameter atomClass
the class in question
Parameter atom
the last known atom
Returns
all atom description that have been added to class atomClass after atom
getAtom
long
getAtom( [in] long  atomClass,
[in] string  description,
[in] boolean  create );

Description
registers or searches for a string
Parameter atomClass
the class of atoms in question
Parameter description
the string in question
Parameter create
if true a new atom will be created for an unknown string else the invalid atom (0) will be returned for an unknown string
Returns
the atom for the string description
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.