| org.ozoneDB.OzoneInterface
All known Subclasses: org.ozoneDB.AbstractDatabase, org.ozoneDB.Database, org.ozoneDB.ExternalDatabase,
| Field Summary | |
| final public static int | AllLock
Object access right. | | final public static int | AllRead
Object access right. | | final public static int | GroupLock
Object access right. | | final public static int | GroupRead
Object access right. | | final public static int | Private
Object access right. | | final public static int | Public
Object access right. |
| Method Summary | |
| public OzoneProxy | copyObject(OzoneRemote rObj)
Copy an object. | | public OzoneProxy | createObject(String className)
Creates a database object of the specified class without a name and with
default permissions.
Parameters:
className - The fully qualified name of the class. | | public OzoneProxy | createObject(String className, int access)
Creates a database object of the specified class without a name and with
the specified access rights.
Parameters:
className - The fully qualified name of the class.
Parameters:
access - The access rights (ORed). | | public OzoneProxy | createObject(String className, int access, String objName)
Creates a database object of the specified class with the specified name
and the specified access rights.
Parameters:
className - The fully qualified name of the class.
Parameters:
access - The access right. | | public OzoneProxy | createObject(String className, int access, String objName, String sig, Object[] args)
Creates an object by calling the constructor with the specified
signature with the specified parameters. | | public OzoneProxy | createObject(String className, String sig, Object[] args)
Creates an object by calling the constructor with the specified
signature with the specified parameters and default permissions.
Parameters:
className - fully qualified name of the class
Parameters:
sig - The signature string of the constructor.
Parameters:
args - The parameter that are passed to the constructor. | | public OzoneProxy | createObject(Class type)
Creates a database object of the specified class without a name and with
default permissions.
Parameters:
type - the type of the object to be created A proxy object for the newly created object. | | public OzoneProxy | createObject(Class type, int access)
Creates a database object of the specified class without a name and with
the specified access rights.
Parameters:
type - the type of the object to be created
Parameters:
access - The access rights (ORed). | | public OzoneProxy | createObject(Class type, int access, String objName)
Creates a database object of the specified class with the specified name
and the specified access rights.
Parameters:
type - the type of the object to be created
Parameters:
access - The access right. | | public OzoneProxy | createObject(Class type, int access, String objName, String sig, Object[] args)
Creates an object by calling the constructor with the specified
signature with the specified parameters. | | public OzoneProxy | createObject(Class type, String sig, Object[] args)
Creates an object by calling the constructor with the specified
signature with the specified parameters and default permissions.
Parameters:
type - the type of the object to be created
Parameters:
sig - The signature string of the constructor.
Parameters:
args - The parameter that are passed to the constructor. | | public void | deleteObject(OzoneRemote rObj)
Deletes the specified database object. | | public OzoneCompatible | fetch(OzoneProxy rObj, int lockLevel)
Returns the actual target of the given proxy if the actual implementation
is able to do so. | | public Object | invoke(OzoneProxy rObj, String methodName, String sig, Object[] args, int lockLevel)
Invokes a method on the specified object. | | public Object | invoke(OzoneProxy rObj, int methodIndex, Object[] args, int lockLevel)
| | public void | nameObject(OzoneRemote rObj, String name)
Assigns the specified object with the specified name. | | public void | notifyProxyDeath(OzoneProxy proxy)
Internal method. | | public OzoneProxy | objectForHandle(String handle)
Returns the object for the specified handle or null if there is no such
object.
Parameters:
The - handle of the object. | | public OzoneProxy | objectForName(String name)
Returns the object for the specifies name or null if there is no such
object.
Parameters:
The - name name of the object. | | public OzoneProxy[] | objectsOfClass(String name)
Gives all objects of the specified class as array.
Parameters:
name - {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. | | public void | reloadClasses()
Force the database server to reload all classes which extend
OzoneObject. | | public Node | xmlForObject(OzoneRemote rObj, Document domFactory)
Convert the specified object into XML. | | public void | xmlForObject(OzoneRemote rObj, ContentHandler ch)
Converts the specified object into XML. |
| AllLock | | final public static int AllLock(Code) | | Object access right.
|
| AllRead | | final public static int AllRead(Code) | | Object access right.
|
| GroupLock | | final public static int GroupLock(Code) | | Object access right.
|
| GroupRead | | final public static int GroupRead(Code) | | Object access right.
|
| Private | | final public static int Private(Code) | | Object access right.
|
| Public | | final public static int Public(Code) | | Object access right. Combines
AllRead and
AllLock .
|
| copyObject | | public OzoneProxy copyObject(OzoneRemote rObj) throws Exception(Code) | | Copy an object. The new objects gets its own object ID. The specified
object is an instance of OzoneProxy which you may have created by
createObject().
Parameters:
rObj - proxy for the newly created object {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link Exception} To signal an implementation specific problem,such as IOException |
| createObject | | public OzoneProxy createObject(String className) throws RuntimeException(Code) | | Creates a database object of the specified class without a name and with
default permissions.
Parameters:
className - The fully qualified name of the class. A proxy object for the newly created object. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| createObject | | public OzoneProxy createObject(String className, int access) throws RuntimeException(Code) | | Creates a database object of the specified class without a name and with
the specified access rights.
Parameters:
className - The fully qualified name of the class.
Parameters:
access - The access rights (ORed). proxy A proxy object for the newly created database object. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| createObject | | public OzoneProxy createObject(String className, int access, String objName) throws RuntimeException(Code) | | Creates a database object of the specified class with the specified name
and the specified access rights.
Parameters:
className - The fully qualified name of the class.
Parameters:
access - The access right. (ORed)
Parameters:
objName - The name of the object. (optional) A proxy object for the newly created object. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| createObject | | public OzoneProxy createObject(String className, int access, String objName, String sig, Object[] args) throws RuntimeException(Code) | | Creates an object by calling the constructor with the specified
signature with the specified parameters. Generated proxy objects use
this method.
Parameters:
className - fully qualified name of the class
Parameters:
access - access right (ORed)
Parameters:
objName - name of the object (optional
Parameters:
sig - The signature string of the constructor.
Parameters:
args - The parameter that are passed to the constructor. proxy A OzoneProxy object for the newly created object. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| createObject | | public OzoneProxy createObject(String className, String sig, Object[] args) throws RuntimeException(Code) | | Creates an object by calling the constructor with the specified
signature with the specified parameters and default permissions.
Parameters:
className - fully qualified name of the class
Parameters:
sig - The signature string of the constructor.
Parameters:
args - The parameter that are passed to the constructor. proxy A OzoneProxy object for the newly created object. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| createObject | | public OzoneProxy createObject(Class type) throws RuntimeException(Code) | | Creates a database object of the specified class without a name and with
default permissions.
Parameters:
type - the type of the object to be created A proxy object for the newly created object. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| createObject | | public OzoneProxy createObject(Class type, int access) throws RuntimeException(Code) | | Creates a database object of the specified class without a name and with
the specified access rights.
Parameters:
type - the type of the object to be created
Parameters:
access - The access rights (ORed). proxy A proxy object for the newly created database object. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| createObject | | public OzoneProxy createObject(Class type, int access, String objName) throws RuntimeException(Code) | | Creates a database object of the specified class with the specified name
and the specified access rights.
Parameters:
type - the type of the object to be created
Parameters:
access - The access right. (ORed)
Parameters:
objName - The name of the object. (optional) A proxy object for the newly created object. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| createObject | | public OzoneProxy createObject(Class type, int access, String objName, String sig, Object[] args) throws RuntimeException(Code) | | Creates an object by calling the constructor with the specified
signature with the specified parameters. Generated proxy objects use
this method.
Parameters:
type - the type of the object to be created
Parameters:
access - access right (ORed)
Parameters:
objName - name of the object (optional
Parameters:
sig - The signature string of the constructor.
Parameters:
args - The parameter that are passed to the constructor. proxy A OzoneProxy object for the newly created object. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| createObject | | public OzoneProxy createObject(Class type, String sig, Object[] args) throws RuntimeException(Code) | | Creates an object by calling the constructor with the specified
signature with the specified parameters and default permissions.
Parameters:
type - the type of the object to be created
Parameters:
sig - The signature string of the constructor.
Parameters:
args - The parameter that are passed to the constructor. proxy A OzoneProxy object for the newly created object. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| deleteObject | | public void deleteObject(OzoneRemote rObj) throws RuntimeException(Code) | | Deletes the specified database object. The specified object is an
instance of OzoneProxy which you may have created by createObject().
Parameters:
rObj - {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link RuntimeException} To signal an implementation specific problem,such as IOException |
| fetch | | public OzoneCompatible fetch(OzoneProxy rObj, int lockLevel) throws Exception(Code) | | Returns the actual target of the given proxy if the actual implementation
is able to do so. A client will never call this method explicitly.
|
| invoke | | public Object invoke(OzoneProxy rObj, String methodName, String sig, Object[] args, int lockLevel) throws Exception(Code) | | Invokes a method on the specified object. This method is called by
proxy objects to route the call to the corresponding database object.
A client will never call this method explicitly.
Parameters:
rObj - OzoneProxy on which to call the method
Parameters:
methodName -
Parameters:
sig - signature of the method as String
Parameters:
args - array of arguments
Parameters:
update - specifies wether this method changes the state of the object regular object or proxy {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link Exception} To signal an implementation specific problem,such as IOException |
| nameObject | | public void nameObject(OzoneRemote rObj, String name) throws Exception(Code) | | Assigns the specified object with the specified name. This can
also be done at object creation time. The specified object is an
instance of OzoneProxy which you may have created by createObject().
Parameters:
rObj -
Parameters:
name - {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link Exception} To signal an implementation specific problem,such as IOException |
| notifyProxyDeath | | public void notifyProxyDeath(OzoneProxy proxy)(Code) | | Internal method. This method is called by
OzoneProxy s when they are dying (during finalize()). This
is required, as the database may track the references the database client has to objects within the database
in order to properly support garbage collection. If this method is called from anyone else than from the
OzoneProxy .finalize()-Method, data loss may occur!
Parameters:
proxy - the OzoneProxy object which is dying. It may call this method exaclty once. |
| objectForHandle | | public OzoneProxy objectForHandle(String handle) throws Exception(Code) | | Returns the object for the specified handle or null if there is no such
object.
Parameters:
The - handle of the object. A proxy object for the found object or null. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link Exception} To signal an implementation specific problem,such as IOException |
| objectForName | | public OzoneProxy objectForName(String name) throws Exception(Code) | | Returns the object for the specifies name or null if there is no such
object.
Parameters:
The - name name of the object. A proxy object for the found object or null. {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link Exception} To signal an implementation specific problem,such as IOException |
| objectsOfClass | | public OzoneProxy[] objectsOfClass(String name) throws Exception(Code) | | Gives all objects of the specified class as array.
Parameters:
name - {@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link Exception} To signal an implementation specific problem,such as IOException |
| reloadClasses | | public void reloadClasses() throws Exception(Code) | | Force the database server to reload all classes which extend
OzoneObject. This is particularly useful while testing new classes.
{@link OzoneRemoteExc} (or one of its sub-classes) to signal aozone related problem. {@link Exception} To signal an implementation specific problem,such as IOException |
| xmlForObject | | public Node xmlForObject(OzoneRemote rObj, Document domFactory) throws Exception(Code) | | Convert the specified object into XML. This method returns the
generated XML data as DOM tree. For performance reasons you should
try to use
OzoneInterface.xmlForObject(OzoneRemote,ContentHandler) , which
returns SAX events, instead of DOM.
See the doc directory of ozone for a detailed description (XML Schema)
of the XML output of this method.
Parameters:
rObj - The database object to be converted.
Parameters:
factory - The factory for creating DOM nodes. |
| xmlForObject | | public void xmlForObject(OzoneRemote rObj, ContentHandler ch) throws Exception(Code) | | Converts the specified object into XML. This method returns the generated
XML data as SAX events. See the doc directory of ozone for a detailed
description (XML Schema) of the XML output of this method.
Parameters:
rObj - The database object to be converted.
Parameters:
ch - The SAX ContentHandler to which the result is sent. |
|
|