omero.model

Class DBPatchI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.DBPatch

omero.model.DBPatchI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _DBPatchOperations, _DBPatchOperationsNC, _IObjectOperations, _IObjectOperationsNC

public class DBPatchI
extends DBPatch
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CURRENTPATCH
static java.lang.String	CURRENTVERSION
static java.lang.String	DETAILS
static java.lang.String	FINISHED
static java.lang.String	MESSAGE
static java.lang.String	PREVIOUSPATCH
static java.lang.String	PREVIOUSVERSION

Fields inherited from class omero.model.DBPatch

__ids, currentPatch, currentVersion, finished, message, previousPatch, previousVersion, serialVersionUID

Fields inherited from class omero.model.IObject

details, id, loaded

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor and Description
DBPatchI()
DBPatchI(long id, boolean loaded)
DBPatchI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method and Description
static java.util.List<DBPatchI>	cast(java.util.List list) Casts (without warning) the given list to a list of the current type.
void	copyObject(ome.util.Filterable model, ome.util.ModelMapper _mapper) Used by IceMapper to inject an "ome.model" object into this "omero.model" object.
protected void	errorIfUnloaded()
ome.util.Filterable	fillObject(ome.util.ReverseModelMapper _mapper) Used by IceMapper produce an "ome.model" object from this "omero.model" object.
RInt	getCurrentPatch(Ice.Current current)
RString	getCurrentVersion(Ice.Current current)
Details	getDetails(Ice.Current current)
RTime	getFinished(Ice.Current current)
RLong	getId(Ice.Current current)
RString	getMessage(Ice.Current current)
RInt	getPreviousPatch(Ice.Current current)
RString	getPreviousVersion(Ice.Current current)
boolean	isAnnotated(Ice.Current current) Allows for the attachment of any omero.model.Annotation subclasses.
boolean	isGlobal(Ice.Current current) Marker interface which means that special rules apply for both reading and writing these instances.
boolean	isLink(Ice.Current current) A link between two other types.
boolean	isLoaded(Ice.Current current) Tests if the objects are loaded or not.
boolean	isMutable(Ice.Current current) The server will persist changes made to these types.
IObject	proxy(Ice.Current current) Return another instance of the same type as this instance constructed as if by: new InstanceI( this.id.val, false );
void	setCurrentPatch(RInt currentPatch, Ice.Current current)
void	setCurrentVersion(RString currentVersion, Ice.Current current)
void	setFinished(RTime finished, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setMessage(RString message, Ice.Current current)
void	setPreviousPatch(RInt previousPatch, Ice.Current current)
void	setPreviousVersion(RString previousVersion, Ice.Current current)
IObject	shallowCopy(Ice.Current current) Return another instance of the same type as this instance with all single-value entities unloaded and all members of collections also unloaded.
protected void	throwNullCollectionException(java.lang.String propertyName)
protected void	toggleCollectionsLoaded(boolean load)
void	unload(Ice.Current current) Sets the loaded boolean to false and empties all state from this entity to make sending it over the network less costly.
void	unloadCollections(Ice.Current current) Each collection can also be unloaded, independently of the object itself.
void	unloadCurrentPatch()
void	unloadCurrentVersion()
void	unloadDetails(Ice.Current current) As with collections, the objects under details can link to many other objects.
void	unloadFinished()
void	unloadMessage()
void	unloadPreviousPatch()
void	unloadPreviousVersion()

Methods inherited from class omero.model.DBPatch

___getCurrentPatch, ___getCurrentVersion, ___getFinished, ___getMessage, ___getPreviousPatch, ___getPreviousVersion, ___setCurrentPatch, ___setCurrentVersion, ___setFinished, ___setMessage, ___setPreviousPatch, ___setPreviousVersion, __dispatch, __readImpl, __writeImpl, clone, getCurrentPatch, getCurrentVersion, getFinished, getMessage, getPreviousPatch, getPreviousVersion, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, setCurrentPatch, setCurrentVersion, setFinished, setMessage, setPreviousPatch, setPreviousVersion

Methods inherited from class omero.model.IObject

___getDetails, ___getId, ___isAnnotated, ___isGlobal, ___isLink, ___isLoaded, ___isMutable, ___proxy, ___setId, ___shallowCopy, ___unload, ___unloadCollections, ___unloadDetails, getDetails, getId, isAnnotated, isGlobal, isLink, isLoaded, isMutable, proxy, setId, shallowCopy, unload, unloadCollections, unloadDetails

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __read, __read, __readImpl, __write, __write, __writeImpl, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface omero.model._IObjectOperationsNC

getDetails, getId, isAnnotated, isGlobal, isLink, isLoaded, isMutable, proxy, setId, shallowCopy, unload, unloadCollections, unloadDetails

Field Detail

CURRENTVERSION

public static final java.lang.String CURRENTVERSION

See Also:

Constant Field Values

CURRENTPATCH

public static final java.lang.String CURRENTPATCH

See Also:

Constant Field Values

PREVIOUSVERSION

public static final java.lang.String PREVIOUSVERSION

See Also:

Constant Field Values

PREVIOUSPATCH

public static final java.lang.String PREVIOUSPATCH

See Also:

Constant Field Values

FINISHED

public static final java.lang.String FINISHED

See Also:

Constant Field Values

MESSAGE

public static final java.lang.String MESSAGE

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

DBPatchI

public DBPatchI()

DBPatchI

public DBPatchI(long id,
                boolean loaded)

DBPatchI

public DBPatchI(RLong id,
                boolean loaded)

Method Detail

errorIfUnloaded

protected void errorIfUnloaded()
                        throws UnloadedEntityException

Throws:

UnloadedEntityException

throwNullCollectionException

protected void throwNullCollectionException(java.lang.String propertyName)
                                     throws UnloadedCollectionException

Throws:

UnloadedCollectionException

toggleCollectionsLoaded

protected void toggleCollectionsLoaded(boolean load)

unload

public void unload(Ice.Current current)

Description copied from interface: _IObjectOperations

Sets the loaded boolean to false and empties all state from this entity to make sending it over the network less costly.

Specified by:

unload in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isLoaded

public boolean isLoaded(Ice.Current current)

Description copied from interface: _IObjectOperations

Tests if the objects are loaded or not. If this value is false, then any method call on this instance other than getId or setId will result in an exception.

Specified by:

isLoaded in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

unloadCollections

public void unloadCollections(Ice.Current current)

Description copied from interface: _IObjectOperations

Each collection can also be unloaded, independently of the object itself. To unload all collections, use: object.unloadCollections(); This is useful when it is possible that a collection no longer represents the state in the database, and passing the collections back to the server might delete some entities. Sending back empty collections can also save a significant amount of bandwidth, when working with large data graphs.

Specified by:

unloadCollections in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isGlobal

public boolean isGlobal(Ice.Current current)

Description copied from interface: _IObjectOperations

Marker interface which means that special rules apply for both reading and writing these instances.

Specified by:

isGlobal in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isMutable

public boolean isMutable(Ice.Current current)

Description copied from interface: _IObjectOperations

The server will persist changes made to these types. Methods provided: - getVersion() - setVersion()

Specified by:

isMutable in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isAnnotated

public boolean isAnnotated(Ice.Current current)

Description copied from interface: _IObjectOperations

Allows for the attachment of any omero.model.Annotation subclasses. Methods provided are: - linkAnnotation(Annotation) -

Specified by:

isAnnotated in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

isLink

public boolean isLink(Ice.Current current)

Description copied from interface: _IObjectOperations

A link between two other types. Methods provided: - getParent() - getChild()

Specified by:

isLink in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

shallowCopy

public IObject shallowCopy(Ice.Current current)

Description copied from interface: _IObjectOperations

Return another instance of the same type as this instance with all single-value entities unloaded and all members of collections also unloaded.

Specified by:

shallowCopy in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

proxy

public IObject proxy(Ice.Current current)

Description copied from interface: _IObjectOperations

Return another instance of the same type as this instance constructed as if by: new InstanceI( this.id.val, false );

Specified by:

proxy in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

getId

public RLong getId(Ice.Current current)

Specified by:

getId in interface _IObjectOperations

setId

public void setId(RLong id,
                  Ice.Current current)

Specified by:

setId in interface _IObjectOperations

getDetails

public Details getDetails(Ice.Current current)

Specified by:

getDetails in interface _IObjectOperations

unloadDetails

public void unloadDetails(Ice.Current current)

Description copied from interface: _IObjectOperations

As with collections, the objects under details can link to many other objects. Unloading the details can same bandwidth and simplify the server logic.

Specified by:

unloadDetails in interface _IObjectOperations

Parameters:

current - The Current object for the invocation.

unloadCurrentVersion

public void unloadCurrentVersion()

getCurrentVersion

public RString getCurrentVersion(Ice.Current current)
                          throws UnloadedEntityException

Specified by:

getCurrentVersion in interface _DBPatchOperations

Throws:

UnloadedEntityException

setCurrentVersion

public void setCurrentVersion(RString currentVersion,
                              Ice.Current current)
                       throws UnloadedEntityException

Specified by:

setCurrentVersion in interface _DBPatchOperations

Throws:

UnloadedEntityException

unloadCurrentPatch

public void unloadCurrentPatch()

getCurrentPatch

public RInt getCurrentPatch(Ice.Current current)
                     throws UnloadedEntityException

Specified by:

getCurrentPatch in interface _DBPatchOperations

Throws:

UnloadedEntityException

setCurrentPatch

public void setCurrentPatch(RInt currentPatch,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:

setCurrentPatch in interface _DBPatchOperations

Throws:

UnloadedEntityException

unloadPreviousVersion

public void unloadPreviousVersion()

getPreviousVersion

public RString getPreviousVersion(Ice.Current current)
                           throws UnloadedEntityException

Specified by:

getPreviousVersion in interface _DBPatchOperations

Throws:

UnloadedEntityException

setPreviousVersion

public void setPreviousVersion(RString previousVersion,
                               Ice.Current current)
                        throws UnloadedEntityException

Specified by:

setPreviousVersion in interface _DBPatchOperations

Throws:

UnloadedEntityException

unloadPreviousPatch

public void unloadPreviousPatch()

getPreviousPatch

public RInt getPreviousPatch(Ice.Current current)
                      throws UnloadedEntityException

Specified by:

getPreviousPatch in interface _DBPatchOperations

Throws:

UnloadedEntityException

setPreviousPatch

public void setPreviousPatch(RInt previousPatch,
                             Ice.Current current)
                      throws UnloadedEntityException

Specified by:

setPreviousPatch in interface _DBPatchOperations

Throws:

UnloadedEntityException

unloadFinished

public void unloadFinished()

getFinished

public RTime getFinished(Ice.Current current)
                  throws UnloadedEntityException

Specified by:

getFinished in interface _DBPatchOperations

Throws:

UnloadedEntityException

setFinished

public void setFinished(RTime finished,
                        Ice.Current current)
                 throws UnloadedEntityException

Specified by:

setFinished in interface _DBPatchOperations

Throws:

UnloadedEntityException

unloadMessage

public void unloadMessage()

getMessage

public RString getMessage(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

getMessage in interface _DBPatchOperations

Throws:

UnloadedEntityException

setMessage

public void setMessage(RString message,
                       Ice.Current current)
                throws UnloadedEntityException

Specified by:

setMessage in interface _DBPatchOperations

Throws:

UnloadedEntityException

copyObject

public void copyObject(ome.util.Filterable model,
                       ome.util.ModelMapper _mapper)

Used by IceMapper to inject an "ome.model" object into this "omero.model" object.

Specified by:

copyObject in interface ome.model.ModelBased

fillObject

public ome.util.Filterable fillObject(ome.util.ReverseModelMapper _mapper)

Used by IceMapper produce an "ome.model" object from this "omero.model" object.

Specified by:

fillObject in interface ome.model.ModelBased

cast

public static java.util.List<DBPatchI> cast(java.util.List list)

Casts (without warning) the given list to a list of the current type.

Throws:

java.lang.ClassCastException