org.sourceforge.jemm.database
Interface ObjectAccessor

All Known Subinterfaces:

DBObjectHandler

All Known Implementing Classes:

DefaultDBObjectHandler

public interface ObjectAccessor

Interface to reduce direct coupling between ObjectHandlers and their users.

Author:

Rory Graves

Method Summary

boolean	checkExists(ID objectId)
ID	createObject(ClientId clientId, ClassId classId)
StoredListObject	getListObject(ID objectId) Returns the stored jemm list object referred to by 'id'
StoredMapObject	getMapObject(ID id) Returns the stored jemm map object referred to by 'id'
StoredObject	getObject(ID objectId)
java.util.Set<ID>	getObjectChildren(ID id)
StoredSetObject	getSetObject(ID id) Returns the stored jemm set object referred to by 'id'
StoredUserObject	getUserObject(ID objectId)
java.util.Iterator<ID>	idIterator() Returns an iterator over the currently active ID set
void	release(StoredObject object)
void	removeObject(ID id)

Method Detail

getObject

StoredObject getObject(ID objectId)

getUserObject

StoredUserObject getUserObject(ID objectId)

getListObject

StoredListObject getListObject(ID objectId)

Returns the stored jemm list object referred to by 'id'

Parameters:

id - The id of the set to retrieve.

Throws:

java.lang.IllegalArgumentException - If 'id' is null or is not JLIST type id.

java.lang.IllegalStateException - If the object is not in the database (an internal error), or the type of the retrieved object is not a stored jemm list.

getSetObject

StoredSetObject getSetObject(ID id)

Returns the stored jemm set object referred to by 'id'

Parameters:

id - The id of the set to retrieve.

Throws:

java.lang.IllegalArgumentException - If 'id' is null or is not JSET type id.

java.lang.IllegalStateException - If the object is not in the database (an internal error), or the type of the retrieved object is not a stored jemm set.

getMapObject

StoredMapObject getMapObject(ID id)

Returns the stored jemm map object referred to by 'id'

Parameters:

id - The id of the map to retrieve.

Throws:

java.lang.IllegalArgumentException - If 'id' is null or is not JSET type id.

java.lang.IllegalStateException - If the object is not in the database (an internal error), or the type of the retrieved object is not a stored jemm map.

checkExists

boolean checkExists(ID objectId)

release

void release(StoredObject object)

idIterator

java.util.Iterator<ID> idIterator()

Returns an iterator over the currently active ID set

Returns:

An iterator over valid IDs

removeObject

void removeObject(ID id)

getObjectChildren

java.util.Set<ID> getObjectChildren(ID id)

createObject

ID createObject(ClientId clientId,
                ClassId classId)