omero.model

Class NodeI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.Node

omero.model.NodeI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _IObjectOperations, _IObjectOperationsNC, _NodeOperations, _NodeOperationsNC

public class NodeI
extends Node
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANNOTATIONLINKS
static java.lang.String	CONN
static java.lang.String	DETAILS
static java.lang.String	DOWN
static java.lang.String	SCALE
static java.lang.String	SESSIONS
static java.lang.String	UP
static java.lang.String	UUID

Fields inherited from class omero.model.Node

__ids, annotationLinksCountPerOwner, annotationLinksLoaded, annotationLinksSeq, conn, down, scale, serialVersionUID, sessionsLoaded, sessionsSeq, up, uuid, 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
NodeI()
NodeI(long id, boolean loaded)
NodeI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method and Description
void	addAllNodeAnnotationLinkSet(java.util.List<NodeAnnotationLink> targets, Ice.Current current)
void	addAllSessionSet(java.util.List<Session> targets, Ice.Current current)
void	addNodeAnnotationLink(NodeAnnotationLink target, Ice.Current current)
void	addNodeAnnotationLinkToBoth(NodeAnnotationLink link, boolean bothSides, Ice.Current current)
void	addSession(Session target, Ice.Current current)
static java.util.List<NodeI>	cast(java.util.List list) Casts (without warning) the given list to a list of the current type.
void	clearAnnotationLinks(Ice.Current current)
void	clearSessions(Ice.Current current)
java.util.List	copyAnnotationLinks(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	copySessions(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<NodeAnnotationLink>	findNodeAnnotationLink(Annotation removal, Ice.Current current)
protected java.util.List	getAnnotationLinks(Ice.Current current)
java.util.Map<java.lang.Long,java.lang.Long>	getAnnotationLinksCountPerOwner(Ice.Current current)
RString	getConn(Ice.Current current)
Details	getDetails(Ice.Current current)
RTime	getDown(Ice.Current current)
RLong	getId(Ice.Current current)
RInt	getScale(Ice.Current current)
protected java.util.List	getSessions(Ice.Current current)
RTime	getUp(Ice.Current current)
RString	getUuid(Ice.Current current)
RInt	getVersion(Ice.Current current)
boolean	isAnnotated(Ice.Current current) Allows for the attachment of any omero.model.Annotation subclasses.
boolean	isAnnotationLinksLoaded()
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	isSessionsLoaded()
java.util.Iterator	iterateAnnotationLinks()
java.util.Iterator	iterateSessions()
NodeAnnotationLink	linkAnnotation(Annotation addition, Ice.Current current)
java.util.List<Annotation>	linkedAnnotationList(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	reloadAnnotationLinks(Node toCopy, Ice.Current current)
void	reloadSessions(Node toCopy, Ice.Current current)
void	removeAllNodeAnnotationLinkSet(java.util.List<NodeAnnotationLink> targets, Ice.Current current)
void	removeAllSessionSet(java.util.List<Session> targets, Ice.Current current)
void	removeNodeAnnotationLink(NodeAnnotationLink target, Ice.Current current)
void	removeNodeAnnotationLinkFromBoth(NodeAnnotationLink link, boolean bothSides, Ice.Current current)
void	removeSession(Session target, Ice.Current current)
protected void	setAnnotationLinks(java.util.List annotationLinks, Ice.Current current)
void	setConn(RString conn, Ice.Current current)
void	setDown(RTime down, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setScale(RInt scale, Ice.Current current)
protected void	setSessions(java.util.List sessions, Ice.Current current)
void	setUp(RTime up, Ice.Current current)
void	setUuid(RString uuid, 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	sizeOfAnnotationLinks(Ice.Current current)
int	sizeOfSessions(Ice.Current current)
protected void	throwNullCollectionException(java.lang.String propertyName)
protected void	toggleCollectionsLoaded(boolean load)
void	unlinkAnnotation(Annotation 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	unloadAnnotationLinks(Ice.Current current)
void	unloadCollections(Ice.Current current) Each collection can also be unloaded, independently of the object itself.
void	unloadConn()
void	unloadDetails(Ice.Current current) As with collections, the objects under details can link to many other objects.
void	unloadDown()
void	unloadScale()
void	unloadSessions(Ice.Current current)
void	unloadUp()
void	unloadUuid()

Methods inherited from class omero.model.Node

___addAllNodeAnnotationLinkSet, ___addAllSessionSet, ___addNodeAnnotationLink, ___addNodeAnnotationLinkToBoth, ___addSession, ___clearAnnotationLinks, ___clearSessions, ___copyAnnotationLinks, ___copySessions, ___findNodeAnnotationLink, ___getAnnotationLinksCountPerOwner, ___getConn, ___getDown, ___getScale, ___getUp, ___getUuid, ___getVersion, ___linkAnnotation, ___linkedAnnotationList, ___reloadAnnotationLinks, ___reloadSessions, ___removeAllNodeAnnotationLinkSet, ___removeAllSessionSet, ___removeNodeAnnotationLink, ___removeNodeAnnotationLinkFromBoth, ___removeSession, ___setConn, ___setDown, ___setScale, ___setUp, ___setUuid, ___setVersion, ___sizeOfAnnotationLinks, ___sizeOfSessions, ___unlinkAnnotation, ___unloadAnnotationLinks, ___unloadSessions, __dispatch, __readImpl, __writeImpl, addAllNodeAnnotationLinkSet, addAllSessionSet, addNodeAnnotationLink, addNodeAnnotationLinkToBoth, addSession, clearAnnotationLinks, clearSessions, clone, copyAnnotationLinks, copySessions, findNodeAnnotationLink, getAnnotationLinksCountPerOwner, getConn, getDown, getScale, getUp, getUuid, getVersion, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, linkAnnotation, linkedAnnotationList, reloadAnnotationLinks, reloadSessions, removeAllNodeAnnotationLinkSet, removeAllSessionSet, removeNodeAnnotationLink, removeNodeAnnotationLinkFromBoth, removeSession, setConn, setDown, setScale, setUp, setUuid, setVersion, sizeOfAnnotationLinks, sizeOfSessions, unlinkAnnotation, unloadAnnotationLinks, unloadSessions

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

SESSIONS

public static final java.lang.String SESSIONS

See Also:

Constant Field Values

UUID

public static final java.lang.String UUID

See Also:

Constant Field Values

CONN

public static final java.lang.String CONN

See Also:

Constant Field Values

UP

public static final java.lang.String UP

See Also:

Constant Field Values

DOWN

public static final java.lang.String DOWN

See Also:

Constant Field Values

SCALE

public static final java.lang.String SCALE

See Also:

Constant Field Values

ANNOTATIONLINKS

public static final java.lang.String ANNOTATIONLINKS

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

Constructor Detail

NodeI

public NodeI()

NodeI

public NodeI(long id,
             boolean loaded)

NodeI

public NodeI(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 _NodeOperations

setVersion

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

Specified by:

setVersion in interface _NodeOperations

unloadSessions

public void unloadSessions(Ice.Current current)

Specified by:

unloadSessions in interface _NodeOperations

getSessions

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

Throws:

UnloadedEntityException

setSessions

protected void setSessions(java.util.List sessions,
                           Ice.Current current)
                    throws UnloadedEntityException

Throws:

UnloadedEntityException

isSessionsLoaded

public boolean isSessionsLoaded()

sizeOfSessions

public int sizeOfSessions(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

sizeOfSessions in interface _NodeOperations

Throws:

UnloadedEntityException

copySessions

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

Specified by:

copySessions in interface _NodeOperations

Throws:

UnloadedEntityException

iterateSessions

public java.util.Iterator iterateSessions()
                                   throws UnloadedEntityException

Throws:

UnloadedEntityException

addSession

public void addSession(Session target,
                       Ice.Current current)
                throws UnloadedEntityException

Specified by:

addSession in interface _NodeOperations

Throws:

UnloadedEntityException

addAllSessionSet

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

Specified by:

addAllSessionSet in interface _NodeOperations

Throws:

UnloadedEntityException

removeSession

public void removeSession(Session target,
                          Ice.Current current)
                   throws UnloadedEntityException

Specified by:

removeSession in interface _NodeOperations

Throws:

UnloadedEntityException

removeAllSessionSet

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

Specified by:

removeAllSessionSet in interface _NodeOperations

Throws:

UnloadedEntityException

clearSessions

public void clearSessions(Ice.Current current)
                   throws UnloadedEntityException

Specified by:

clearSessions in interface _NodeOperations

Throws:

UnloadedEntityException

reloadSessions

public void reloadSessions(Node toCopy,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:

reloadSessions in interface _NodeOperations

Throws:

UnloadedEntityException

unloadUuid

public void unloadUuid()

getUuid

public RString getUuid(Ice.Current current)
                throws UnloadedEntityException

Specified by:

getUuid in interface _NodeOperations

Throws:

UnloadedEntityException

setUuid

public void setUuid(RString uuid,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setUuid in interface _NodeOperations

Throws:

UnloadedEntityException

unloadConn

public void unloadConn()

getConn

public RString getConn(Ice.Current current)
                throws UnloadedEntityException

Specified by:

getConn in interface _NodeOperations

Throws:

UnloadedEntityException

setConn

public void setConn(RString conn,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setConn in interface _NodeOperations

Throws:

UnloadedEntityException

unloadUp

public void unloadUp()

getUp

public RTime getUp(Ice.Current current)
            throws UnloadedEntityException

Specified by:

getUp in interface _NodeOperations

Throws:

UnloadedEntityException

setUp

public void setUp(RTime up,
                  Ice.Current current)
           throws UnloadedEntityException

Specified by:

setUp in interface _NodeOperations

Throws:

UnloadedEntityException

unloadDown

public void unloadDown()

getDown

public RTime getDown(Ice.Current current)
              throws UnloadedEntityException

Specified by:

getDown in interface _NodeOperations

Throws:

UnloadedEntityException

setDown

public void setDown(RTime down,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setDown in interface _NodeOperations

Throws:

UnloadedEntityException

unloadScale

public void unloadScale()

getScale

public RInt getScale(Ice.Current current)
              throws UnloadedEntityException

Specified by:

getScale in interface _NodeOperations

Throws:

UnloadedEntityException

setScale

public void setScale(RInt scale,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:

setScale in interface _NodeOperations

Throws:

UnloadedEntityException

unloadAnnotationLinks

public void unloadAnnotationLinks(Ice.Current current)

Specified by:

unloadAnnotationLinks in interface _NodeOperations

getAnnotationLinks

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

Throws:

UnloadedEntityException

setAnnotationLinks

protected void setAnnotationLinks(java.util.List annotationLinks,
                                  Ice.Current current)
                           throws UnloadedEntityException

Throws:

UnloadedEntityException

isAnnotationLinksLoaded

public boolean isAnnotationLinksLoaded()

sizeOfAnnotationLinks

public int sizeOfAnnotationLinks(Ice.Current current)
                          throws UnloadedEntityException

Specified by:

sizeOfAnnotationLinks in interface _NodeOperations

Throws:

UnloadedEntityException

copyAnnotationLinks

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

Specified by:

copyAnnotationLinks in interface _NodeOperations

Throws:

UnloadedEntityException

iterateAnnotationLinks

public java.util.Iterator iterateAnnotationLinks()
                                          throws UnloadedEntityException

Throws:

UnloadedEntityException

addNodeAnnotationLink

public void addNodeAnnotationLink(NodeAnnotationLink target,
                                  Ice.Current current)
                           throws UnloadedEntityException

Specified by:

addNodeAnnotationLink in interface _NodeOperations

Throws:

UnloadedEntityException

addAllNodeAnnotationLinkSet

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

Specified by:

addAllNodeAnnotationLinkSet in interface _NodeOperations

Throws:

UnloadedEntityException

removeNodeAnnotationLink

public void removeNodeAnnotationLink(NodeAnnotationLink target,
                                     Ice.Current current)
                              throws UnloadedEntityException

Specified by:

removeNodeAnnotationLink in interface _NodeOperations

Throws:

UnloadedEntityException

removeAllNodeAnnotationLinkSet

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

Specified by:

removeAllNodeAnnotationLinkSet in interface _NodeOperations

Throws:

UnloadedEntityException

clearAnnotationLinks

public void clearAnnotationLinks(Ice.Current current)
                          throws UnloadedEntityException

Specified by:

clearAnnotationLinks in interface _NodeOperations

Throws:

UnloadedEntityException

reloadAnnotationLinks

public void reloadAnnotationLinks(Node toCopy,
                                  Ice.Current current)
                           throws UnloadedEntityException

Specified by:

reloadAnnotationLinks in interface _NodeOperations

Throws:

UnloadedEntityException

getAnnotationLinksCountPerOwner

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

Specified by:

getAnnotationLinksCountPerOwner in interface _NodeOperations

linkAnnotation

public NodeAnnotationLink linkAnnotation(Annotation addition,
                                         Ice.Current current)
                                  throws UnloadedEntityException

Specified by:

linkAnnotation in interface _NodeOperations

Throws:

UnloadedEntityException

addNodeAnnotationLinkToBoth

public void addNodeAnnotationLinkToBoth(NodeAnnotationLink link,
                                        boolean bothSides,
                                        Ice.Current current)
                                 throws UnloadedEntityException

Specified by:

addNodeAnnotationLinkToBoth in interface _NodeOperations

Throws:

UnloadedEntityException

findNodeAnnotationLink

public java.util.List<NodeAnnotationLink> findNodeAnnotationLink(Annotation removal,
                                                                 Ice.Current current)
                                                          throws UnloadedEntityException

Specified by:

findNodeAnnotationLink in interface _NodeOperations

Throws:

UnloadedEntityException

unlinkAnnotation

public void unlinkAnnotation(Annotation removal,
                             Ice.Current current)
                      throws UnloadedEntityException

Specified by:

unlinkAnnotation in interface _NodeOperations

Throws:

UnloadedEntityException

removeNodeAnnotationLinkFromBoth

public void removeNodeAnnotationLinkFromBoth(NodeAnnotationLink link,
                                             boolean bothSides,
                                             Ice.Current current)
                                      throws UnloadedEntityException,
                                             UnloadedCollectionException

Specified by:

removeNodeAnnotationLinkFromBoth in interface _NodeOperations

Throws:

UnloadedEntityException

UnloadedCollectionException

linkedAnnotationList

public java.util.List<Annotation> linkedAnnotationList(Ice.Current current)
                                                throws UnloadedEntityException

Specified by:

linkedAnnotationList in interface _NodeOperations

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

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

Throws:

java.lang.ClassCastException