omero.model

Class IndexingJobI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.Job

omero.model.IndexingJob

omero.model.IndexingJobI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _IndexingJobOperations, _IndexingJobOperationsNC, _IObjectOperations, _IObjectOperationsNC, _JobOperations, _JobOperationsNC

public class IndexingJobI
extends IndexingJob
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DETAILS
static java.lang.String	FINISHED
static java.lang.String	GROUPNAME
static java.lang.String	MESSAGE
static java.lang.String	ORIGINALFILELINKS
static java.lang.String	SCHEDULEDFOR
static java.lang.String	STARTED
static java.lang.String	STATUS
static java.lang.String	SUBMITTED
static java.lang.String	TYPE
static java.lang.String	USERNAME

Fields inherited from class omero.model.IndexingJob

__ids, serialVersionUID

Fields inherited from class omero.model.Job

finished, groupname, message, originalFileLinksCountPerOwner, originalFileLinksLoaded, originalFileLinksSeq, scheduledFor, started, status, submitted, type, username, version

Fields inherited from class omero.model.IObject

details, id, loaded

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addAllJobOriginalFileLinkSet(java.util.List<JobOriginalFileLink> targets, Ice.Current current)
void	addJobOriginalFileLink(JobOriginalFileLink target, Ice.Current current)
void	addJobOriginalFileLinkToBoth(JobOriginalFileLink link, boolean bothSides, Ice.Current current)
static java.util.List<IndexingJobI>	cast(java.util.List list) Casts (without warning) the given list to a list of the current type.
void	clearOriginalFileLinks(Ice.Current current)
void	copyObject(ome.util.Filterable model, ome.util.ModelMapper _mapper) Used by IceMapper to inject an "ome.model" object into this "omero.model" object.
java.util.List	copyOriginalFileLinks(Ice.Current current)
protected void	errorIfUnloaded()
ome.util.Filterable	fillObject(ome.util.ReverseModelMapper _mapper) Used by IceMapper produce an "ome.model" object from this "omero.model" object.
java.util.List<JobOriginalFileLink>	findJobOriginalFileLink(OriginalFile removal, Ice.Current current)
Details	getDetails(Ice.Current current)
RTime	getFinished(Ice.Current current)
RString	getGroupname(Ice.Current current)
RLong	getId(Ice.Current current)
RString	getMessage(Ice.Current current)
protected java.util.List	getOriginalFileLinks(Ice.Current current)
java.util.Map<java.lang.Long,java.lang.Long>	getOriginalFileLinksCountPerOwner(Ice.Current current)
RTime	getScheduledFor(Ice.Current current)
RTime	getStarted(Ice.Current current)
JobStatus	getStatus(Ice.Current current)
RTime	getSubmitted(Ice.Current current)
RString	getType(Ice.Current current)
RString	getUsername(Ice.Current current)
RInt	getVersion(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.
boolean	isOriginalFileLinksLoaded()
java.util.Iterator	iterateOriginalFileLinks()
java.util.List<OriginalFile>	linkedOriginalFileList(Ice.Current current)
JobOriginalFileLink	linkOriginalFile(OriginalFile addition, Ice.Current current)
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	reloadOriginalFileLinks(Job toCopy, Ice.Current current)
void	removeAllJobOriginalFileLinkSet(java.util.List<JobOriginalFileLink> targets, Ice.Current current)
void	removeJobOriginalFileLink(JobOriginalFileLink target, Ice.Current current)
void	removeJobOriginalFileLinkFromBoth(JobOriginalFileLink link, boolean bothSides, Ice.Current current)
void	setFinished(RTime finished, Ice.Current current)
void	setGroupname(RString groupname, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setMessage(RString message, Ice.Current current)
protected void	setOriginalFileLinks(java.util.List originalFileLinks, Ice.Current current)
void	setScheduledFor(RTime scheduledFor, Ice.Current current)
void	setStarted(RTime started, Ice.Current current)
void	setStatus(JobStatus status, Ice.Current current)
void	setSubmitted(RTime submitted, Ice.Current current)
void	setType(RString type, Ice.Current current)
void	setUsername(RString username, Ice.Current current)
void	setVersion(RInt version, 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.
int	sizeOfOriginalFileLinks(Ice.Current current)
protected void	throwNullCollectionException(java.lang.String propertyName)
protected void	toggleCollectionsLoaded(boolean load)
void	unlinkOriginalFile(OriginalFile removal, Ice.Current current)
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	unloadDetails(Ice.Current current) As with collections, the objects under details can link to many other objects.
void	unloadFinished()
void	unloadGroupname()
void	unloadMessage()
void	unloadOriginalFileLinks(Ice.Current current)
void	unloadScheduledFor()
void	unloadStarted()
void	unloadStatus()
void	unloadSubmitted()
void	unloadType()
void	unloadUsername()

Methods inherited from class omero.model.IndexingJob

__dispatch, __readImpl, __writeImpl, clone, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId

Methods inherited from class omero.model.Job

___addAllJobOriginalFileLinkSet, ___addJobOriginalFileLink, ___addJobOriginalFileLinkToBoth, ___clearOriginalFileLinks, ___copyOriginalFileLinks, ___findJobOriginalFileLink, ___getFinished, ___getGroupname, ___getMessage, ___getOriginalFileLinksCountPerOwner, ___getScheduledFor, ___getStarted, ___getStatus, ___getSubmitted, ___getType, ___getUsername, ___getVersion, ___linkedOriginalFileList, ___linkOriginalFile, ___reloadOriginalFileLinks, ___removeAllJobOriginalFileLinkSet, ___removeJobOriginalFileLink, ___removeJobOriginalFileLinkFromBoth, ___setFinished, ___setGroupname, ___setMessage, ___setScheduledFor, ___setStarted, ___setStatus, ___setSubmitted, ___setType, ___setUsername, ___setVersion, ___sizeOfOriginalFileLinks, ___unlinkOriginalFile, ___unloadOriginalFileLinks, addAllJobOriginalFileLinkSet, addJobOriginalFileLink, addJobOriginalFileLinkToBoth, clearOriginalFileLinks, copyOriginalFileLinks, findJobOriginalFileLink, getFinished, getGroupname, getMessage, getOriginalFileLinksCountPerOwner, getScheduledFor, getStarted, getStatus, getSubmitted, getType, getUsername, getVersion, linkedOriginalFileList, linkOriginalFile, reloadOriginalFileLinks, removeAllJobOriginalFileLinkSet, removeJobOriginalFileLink, removeJobOriginalFileLinkFromBoth, setFinished, setGroupname, setMessage, setScheduledFor, setStarted, setStatus, setSubmitted, setType, setUsername, setVersion, sizeOfOriginalFileLinks, unlinkOriginalFile, unloadOriginalFileLinks

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._JobOperationsNC

addAllJobOriginalFileLinkSet, addJobOriginalFileLink, addJobOriginalFileLinkToBoth, clearOriginalFileLinks, copyOriginalFileLinks, findJobOriginalFileLink, getFinished, getGroupname, getMessage, getOriginalFileLinksCountPerOwner, getScheduledFor, getStarted, getStatus, getSubmitted, getType, getUsername, getVersion, linkedOriginalFileList, linkOriginalFile, reloadOriginalFileLinks, removeAllJobOriginalFileLinkSet, removeJobOriginalFileLink, removeJobOriginalFileLinkFromBoth, setFinished, setGroupname, setMessage, setScheduledFor, setStarted, setStatus, setSubmitted, setType, setUsername, setVersion, sizeOfOriginalFileLinks, unlinkOriginalFile, unloadOriginalFileLinks

Methods inherited from interface omero.model._IObjectOperationsNC

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

Field Detail

USERNAME

public static final java.lang.String USERNAME

See Also:

Constant Field Values

GROUPNAME

public static final java.lang.String GROUPNAME

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

MESSAGE

public static final java.lang.String MESSAGE

See Also:

Constant Field Values

STATUS

public static final java.lang.String STATUS

See Also:

Constant Field Values

SUBMITTED

public static final java.lang.String SUBMITTED

See Also:

Constant Field Values

SCHEDULEDFOR

public static final java.lang.String SCHEDULEDFOR

See Also:

Constant Field Values

STARTED

public static final java.lang.String STARTED

See Also:

Constant Field Values

FINISHED

public static final java.lang.String FINISHED

See Also:

Constant Field Values

ORIGINALFILELINKS

public static final java.lang.String ORIGINALFILELINKS

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

IndexingJobI

public IndexingJobI()

IndexingJobI

public IndexingJobI(long id,
                    boolean loaded)

IndexingJobI

public IndexingJobI(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.

getVersion

public RInt getVersion(Ice.Current current)

Specified by:

getVersion in interface _JobOperations

setVersion

public void setVersion(RInt version,
                       Ice.Current current)

Specified by:

setVersion in interface _JobOperations

unloadUsername

public void unloadUsername()

getUsername

public RString getUsername(Ice.Current current)
                    throws UnloadedEntityException

Specified by:

getUsername in interface _JobOperations

Throws:

UnloadedEntityException

setUsername

public void setUsername(RString username,
                        Ice.Current current)
                 throws UnloadedEntityException

Specified by:

setUsername in interface _JobOperations

Throws:

UnloadedEntityException

unloadGroupname

public void unloadGroupname()

getGroupname

public RString getGroupname(Ice.Current current)
                     throws UnloadedEntityException

Specified by:

getGroupname in interface _JobOperations

Throws:

UnloadedEntityException

setGroupname

public void setGroupname(RString groupname,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setGroupname in interface _JobOperations

Throws:

UnloadedEntityException

unloadType

public void unloadType()

getType

public RString getType(Ice.Current current)
                throws UnloadedEntityException

Specified by:

getType in interface _JobOperations

Throws:

UnloadedEntityException

setType

public void setType(RString type,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setType in interface _JobOperations

Throws:

UnloadedEntityException

unloadMessage

public void unloadMessage()

getMessage

public RString getMessage(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

getMessage in interface _JobOperations

Throws:

UnloadedEntityException

setMessage

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

Specified by:

setMessage in interface _JobOperations

Throws:

UnloadedEntityException

unloadStatus

public void unloadStatus()

getStatus

public JobStatus getStatus(Ice.Current current)
                    throws UnloadedEntityException

Specified by:

getStatus in interface _JobOperations

Throws:

UnloadedEntityException

setStatus

public void setStatus(JobStatus status,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:

setStatus in interface _JobOperations

Throws:

UnloadedEntityException

unloadSubmitted

public void unloadSubmitted()

getSubmitted

public RTime getSubmitted(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

getSubmitted in interface _JobOperations

Throws:

UnloadedEntityException

setSubmitted

public void setSubmitted(RTime submitted,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setSubmitted in interface _JobOperations

Throws:

UnloadedEntityException

unloadScheduledFor

public void unloadScheduledFor()

getScheduledFor

public RTime getScheduledFor(Ice.Current current)
                      throws UnloadedEntityException

Specified by:

getScheduledFor in interface _JobOperations

Throws:

UnloadedEntityException

setScheduledFor

public void setScheduledFor(RTime scheduledFor,
                            Ice.Current current)
                     throws UnloadedEntityException

Specified by:

setScheduledFor in interface _JobOperations

Throws:

UnloadedEntityException

unloadStarted

public void unloadStarted()

getStarted

public RTime getStarted(Ice.Current current)
                 throws UnloadedEntityException

Specified by:

getStarted in interface _JobOperations

Throws:

UnloadedEntityException

setStarted

public void setStarted(RTime started,
                       Ice.Current current)
                throws UnloadedEntityException

Specified by:

setStarted in interface _JobOperations

Throws:

UnloadedEntityException

unloadFinished

public void unloadFinished()

getFinished

public RTime getFinished(Ice.Current current)
                  throws UnloadedEntityException

Specified by:

getFinished in interface _JobOperations

Throws:

UnloadedEntityException

setFinished

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

Specified by:

setFinished in interface _JobOperations

Throws:

UnloadedEntityException

unloadOriginalFileLinks

public void unloadOriginalFileLinks(Ice.Current current)

Specified by:

unloadOriginalFileLinks in interface _JobOperations

getOriginalFileLinks

protected java.util.List getOriginalFileLinks(Ice.Current current)
                                       throws UnloadedEntityException

Throws:

UnloadedEntityException

setOriginalFileLinks

protected void setOriginalFileLinks(java.util.List originalFileLinks,
                                    Ice.Current current)
                             throws UnloadedEntityException

Throws:

UnloadedEntityException

isOriginalFileLinksLoaded

public boolean isOriginalFileLinksLoaded()

sizeOfOriginalFileLinks

public int sizeOfOriginalFileLinks(Ice.Current current)
                            throws UnloadedEntityException

Specified by:

sizeOfOriginalFileLinks in interface _JobOperations

Throws:

UnloadedEntityException

copyOriginalFileLinks

public java.util.List copyOriginalFileLinks(Ice.Current current)
                                     throws UnloadedEntityException

Specified by:

copyOriginalFileLinks in interface _JobOperations

Throws:

UnloadedEntityException

iterateOriginalFileLinks

public java.util.Iterator iterateOriginalFileLinks()
                                            throws UnloadedEntityException

Throws:

UnloadedEntityException

addJobOriginalFileLink

public void addJobOriginalFileLink(JobOriginalFileLink target,
                                   Ice.Current current)
                            throws UnloadedEntityException

Specified by:

addJobOriginalFileLink in interface _JobOperations

Throws:

UnloadedEntityException

addAllJobOriginalFileLinkSet

public void addAllJobOriginalFileLinkSet(java.util.List<JobOriginalFileLink> targets,
                                         Ice.Current current)
                                  throws UnloadedEntityException

Specified by:

addAllJobOriginalFileLinkSet in interface _JobOperations

Throws:

UnloadedEntityException

removeJobOriginalFileLink

public void removeJobOriginalFileLink(JobOriginalFileLink target,
                                      Ice.Current current)
                               throws UnloadedEntityException

Specified by:

removeJobOriginalFileLink in interface _JobOperations

Throws:

UnloadedEntityException

removeAllJobOriginalFileLinkSet

public void removeAllJobOriginalFileLinkSet(java.util.List<JobOriginalFileLink> targets,
                                            Ice.Current current)
                                     throws UnloadedEntityException

Specified by:

removeAllJobOriginalFileLinkSet in interface _JobOperations

Throws:

UnloadedEntityException

clearOriginalFileLinks

public void clearOriginalFileLinks(Ice.Current current)
                            throws UnloadedEntityException

Specified by:

clearOriginalFileLinks in interface _JobOperations

Throws:

UnloadedEntityException

reloadOriginalFileLinks

public void reloadOriginalFileLinks(Job toCopy,
                                    Ice.Current current)
                             throws UnloadedEntityException

Specified by:

reloadOriginalFileLinks in interface _JobOperations

Throws:

UnloadedEntityException

getOriginalFileLinksCountPerOwner

public java.util.Map<java.lang.Long,java.lang.Long> getOriginalFileLinksCountPerOwner(Ice.Current current)

Specified by:

getOriginalFileLinksCountPerOwner in interface _JobOperations

linkOriginalFile

public JobOriginalFileLink linkOriginalFile(OriginalFile addition,
                                            Ice.Current current)
                                     throws UnloadedEntityException

Specified by:

linkOriginalFile in interface _JobOperations

Throws:

UnloadedEntityException

addJobOriginalFileLinkToBoth

public void addJobOriginalFileLinkToBoth(JobOriginalFileLink link,
                                         boolean bothSides,
                                         Ice.Current current)
                                  throws UnloadedEntityException

Specified by:

addJobOriginalFileLinkToBoth in interface _JobOperations

Throws:

UnloadedEntityException

findJobOriginalFileLink

public java.util.List<JobOriginalFileLink> findJobOriginalFileLink(OriginalFile removal,
                                                                   Ice.Current current)
                                                            throws UnloadedEntityException

Specified by:

findJobOriginalFileLink in interface _JobOperations

Throws:

UnloadedEntityException

unlinkOriginalFile

public void unlinkOriginalFile(OriginalFile removal,
                               Ice.Current current)
                        throws UnloadedEntityException

Specified by:

unlinkOriginalFile in interface _JobOperations

Throws:

UnloadedEntityException

removeJobOriginalFileLinkFromBoth

public void removeJobOriginalFileLinkFromBoth(JobOriginalFileLink link,
                                              boolean bothSides,
                                              Ice.Current current)
                                       throws UnloadedEntityException,
                                              UnloadedCollectionException

Specified by:

removeJobOriginalFileLinkFromBoth in interface _JobOperations

Throws:

UnloadedEntityException

UnloadedCollectionException

linkedOriginalFileList

public java.util.List<OriginalFile> linkedOriginalFileList(Ice.Current current)
                                                    throws UnloadedEntityException

Specified by:

linkedOriginalFileList in interface _JobOperations

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<IndexingJobI> cast(java.util.List list)

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

Throws:

java.lang.ClassCastException