ome.api

Interface IUpdate

All Superinterfaces:

ServiceInterface

All Known Subinterfaces:

LocalUpdate

All Known Implementing Classes:

UpdateImpl

public interface IUpdate
extends ServiceInterface

Provides methods for directly updating object graphs. IUpdate is the lowest level (level-1) interface which may make changes (INSERT, UPDATE, DELETE) to the database. All other methods of changing the database may leave it in an inconsistent state.

All the save* methods act recursively on the entire object graph, replacing placeholders and details where necessary, and then "merging" the final graph. This means that the objects that are passed into IUpdate.save* methods are copied over to new instances which are then returned. The original objects should be discarded.

saveAndReturnIds(IObject[]) behaves slightly differently in that it does not handle object modifications. The graph of objects passed in can consist ONLY if either newly created objects without ids or of unloaded objects with ids. Note: The ids of the saved values may not be in order. This is caused by persistence-by-transitivity. Hibernate may detect an item later in the array if they are interconnected and therefore choose to save it first.

All methods throw ValidationException if the input objects do not pass validation, and OptimisticLockException if the version of a given has already been incremented.

Since:

OMERO3.0

Version:

3.0

Author:

Josh Moore josh.moore@gmx.de

See Also:

Validation, Details

Method Summary

Modifier and Type	Method and Description
void	deleteObject(IObject row) Deletes a single entity.
void	indexObject(IObject row) Initiates full-text indexing for the given object.
IObject[]	saveAndReturnArray(IObject[] graph)
java.util.List<java.lang.Long>	saveAndReturnIds(IObject[] objects) Logic differs from other methods.
<T extends IObject> T	saveAndReturnObject(T graph)
void	saveArray(IObject[] graph)
void	saveCollection(java.util.Collection<IObject> graph)
void	saveObject(IObject graph)

Method Detail

saveAndReturnIds

java.util.List<java.lang.Long> saveAndReturnIds(IObject[] objects)

Logic differs from other methods. See class description

See Also:

IUpdate

saveCollection

void saveCollection(java.util.Collection<IObject> graph)

See Also:

IUpdate

saveObject

void saveObject(IObject graph)

See Also:

IUpdate

saveArray

void saveArray(IObject[] graph)

See Also:

IUpdate

saveAndReturnObject

<T extends IObject> T saveAndReturnObject(T graph)

See Also:

IUpdate

saveAndReturnArray

IObject[] saveAndReturnArray(IObject[] graph)

See Also:

IUpdate

deleteObject

void deleteObject(IObject row)
           throws ValidationException

Deletes a single entity. Unlike the other IUpdate methods, deleteObject does not propagate to related entities (e.g. foreign key relationships) and so calls to deleteObject must be properly ordered. For example, if you would like to delete a FileAnnotation along with the linked OriginalFile, it is necessary to first call deleteObject(OriginalFile) and then deleteObject(FileAnnotation). Instead, you may look to use the more advanced method provided in IDelete which provide support for deleting entire graphs of objects in the correct order.

Parameters:

row - a persistent IObject to be deleted.

Throws:

ValidationException - if the row is locked, has foreign key constraints, or is otherwise marked un-deletable.

indexObject

void indexObject(IObject row)
          throws ValidationException

Initiates full-text indexing for the given object. This may have to wait for the current ome.services.fulltext.FullTextThread to finish. Can only be executed by an admin. Other users must wait for the background Thread to complete.

Parameters:

row - a persistent IObject to be deleted

Throws:

ValidationException - if the object does not exist or is nul