omero.model

Class XmlAnnotationI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.Annotation

omero.model.TextAnnotation

omero.model.XmlAnnotation

omero.model.XmlAnnotationI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _AnnotationOperations, _AnnotationOperationsNC, _IObjectOperations, _IObjectOperationsNC, _TextAnnotationOperations, _TextAnnotationOperationsNC, _XmlAnnotationOperations, _XmlAnnotationOperationsNC

public class XmlAnnotationI
extends XmlAnnotation
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	DESCRIPTION
static java.lang.String	DETAILS
static java.lang.String	NAME
static java.lang.String	NS
static java.lang.String	TEXTVALUE

Fields inherited from class omero.model.XmlAnnotation

__ids, serialVersionUID

Fields inherited from class omero.model.TextAnnotation

textValue

Fields inherited from class omero.model.Annotation

annotationLinksCountPerOwner, annotationLinksLoaded, annotationLinksSeq, description, name, ns, 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
XmlAnnotationI()
XmlAnnotationI(long id, boolean loaded)
XmlAnnotationI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method and Description
void	addAllAnnotationAnnotationLinkSet(java.util.List<AnnotationAnnotationLink> targets, Ice.Current current)
void	addAnnotationAnnotationLink(AnnotationAnnotationLink target, Ice.Current current)
void	addAnnotationAnnotationLinkToBoth(AnnotationAnnotationLink link, boolean bothSides, Ice.Current current)
static java.util.List<XmlAnnotationI>	cast(java.util.List list) Casts (without warning) the given list to a list of the current type.
void	clearAnnotationLinks(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.
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<AnnotationAnnotationLink>	findAnnotationAnnotationLink(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	getDescription(Ice.Current current)
Details	getDetails(Ice.Current current)
RLong	getId(Ice.Current current)
RString	getName(Ice.Current current)
RString	getNs(Ice.Current current)
RString	getTextValue(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.
java.util.Iterator	iterateAnnotationLinks()
AnnotationAnnotationLink	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(Annotation toCopy, Ice.Current current)
void	removeAllAnnotationAnnotationLinkSet(java.util.List<AnnotationAnnotationLink> targets, Ice.Current current)
void	removeAnnotationAnnotationLink(AnnotationAnnotationLink target, Ice.Current current)
void	removeAnnotationAnnotationLinkFromBoth(AnnotationAnnotationLink link, boolean bothSides, Ice.Current current)
protected void	setAnnotationLinks(java.util.List annotationLinks, Ice.Current current)
void	setDescription(RString description, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setName(RString name, Ice.Current current)
void	setNs(RString ns, Ice.Current current)
void	setTextValue(RString textValue, 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)
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	unloadDescription()
void	unloadDetails(Ice.Current current) As with collections, the objects under details can link to many other objects.
void	unloadName()
void	unloadNs()
void	unloadTextValue()

Methods inherited from class omero.model.XmlAnnotation

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

Methods inherited from class omero.model.TextAnnotation

___getTextValue, ___setTextValue, getTextValue, setTextValue

Methods inherited from class omero.model.Annotation

___addAllAnnotationAnnotationLinkSet, ___addAnnotationAnnotationLink, ___addAnnotationAnnotationLinkToBoth, ___clearAnnotationLinks, ___copyAnnotationLinks, ___findAnnotationAnnotationLink, ___getAnnotationLinksCountPerOwner, ___getDescription, ___getName, ___getNs, ___getVersion, ___linkAnnotation, ___linkedAnnotationList, ___reloadAnnotationLinks, ___removeAllAnnotationAnnotationLinkSet, ___removeAnnotationAnnotationLink, ___removeAnnotationAnnotationLinkFromBoth, ___setDescription, ___setName, ___setNs, ___setVersion, ___sizeOfAnnotationLinks, ___unlinkAnnotation, ___unloadAnnotationLinks, addAllAnnotationAnnotationLinkSet, addAnnotationAnnotationLink, addAnnotationAnnotationLinkToBoth, clearAnnotationLinks, copyAnnotationLinks, findAnnotationAnnotationLink, getAnnotationLinksCountPerOwner, getDescription, getName, getNs, getVersion, linkAnnotation, linkedAnnotationList, reloadAnnotationLinks, removeAllAnnotationAnnotationLinkSet, removeAnnotationAnnotationLink, removeAnnotationAnnotationLinkFromBoth, setDescription, setName, setNs, setVersion, sizeOfAnnotationLinks, unlinkAnnotation, unloadAnnotationLinks

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

getTextValue, setTextValue

Methods inherited from interface omero.model._AnnotationOperationsNC

addAllAnnotationAnnotationLinkSet, addAnnotationAnnotationLink, addAnnotationAnnotationLinkToBoth, clearAnnotationLinks, copyAnnotationLinks, findAnnotationAnnotationLink, getAnnotationLinksCountPerOwner, getDescription, getName, getNs, getVersion, linkAnnotation, linkedAnnotationList, reloadAnnotationLinks, removeAllAnnotationAnnotationLinkSet, removeAnnotationAnnotationLink, removeAnnotationAnnotationLinkFromBoth, setDescription, setName, setNs, setVersion, sizeOfAnnotationLinks, unlinkAnnotation, unloadAnnotationLinks

Methods inherited from interface omero.model._IObjectOperationsNC

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

Field Detail

TEXTVALUE

public static final java.lang.String TEXTVALUE

See Also:

Constant Field Values

NS

public static final java.lang.String NS

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

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

XmlAnnotationI

public XmlAnnotationI()

XmlAnnotationI

public XmlAnnotationI(long id,
                      boolean loaded)

XmlAnnotationI

public XmlAnnotationI(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 _AnnotationOperations

setVersion

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

Specified by:

setVersion in interface _AnnotationOperations

unloadTextValue

public void unloadTextValue()

getTextValue

public RString getTextValue(Ice.Current current)
                     throws UnloadedEntityException

Specified by:

getTextValue in interface _TextAnnotationOperations

Throws:

UnloadedEntityException

setTextValue

public void setTextValue(RString textValue,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setTextValue in interface _TextAnnotationOperations

Throws:

UnloadedEntityException

unloadNs

public void unloadNs()

getNs

public RString getNs(Ice.Current current)
              throws UnloadedEntityException

Specified by:

getNs in interface _AnnotationOperations

Throws:

UnloadedEntityException

setNs

public void setNs(RString ns,
                  Ice.Current current)
           throws UnloadedEntityException

Specified by:

setNs in interface _AnnotationOperations

Throws:

UnloadedEntityException

unloadName

public void unloadName()

getName

public RString getName(Ice.Current current)
                throws UnloadedEntityException

Specified by:

getName in interface _AnnotationOperations

Throws:

UnloadedEntityException

setName

public void setName(RString name,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setName in interface _AnnotationOperations

Throws:

UnloadedEntityException

unloadDescription

public void unloadDescription()

getDescription

public RString getDescription(Ice.Current current)
                       throws UnloadedEntityException

Specified by:

getDescription in interface _AnnotationOperations

Throws:

UnloadedEntityException

setDescription

public void setDescription(RString description,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:

setDescription in interface _AnnotationOperations

Throws:

UnloadedEntityException

unloadAnnotationLinks

public void unloadAnnotationLinks(Ice.Current current)

Specified by:

unloadAnnotationLinks in interface _AnnotationOperations

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 _AnnotationOperations

Throws:

UnloadedEntityException

copyAnnotationLinks

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

Specified by:

copyAnnotationLinks in interface _AnnotationOperations

Throws:

UnloadedEntityException

iterateAnnotationLinks

public java.util.Iterator iterateAnnotationLinks()
                                          throws UnloadedEntityException

Throws:

UnloadedEntityException

addAnnotationAnnotationLink

public void addAnnotationAnnotationLink(AnnotationAnnotationLink target,
                                        Ice.Current current)
                                 throws UnloadedEntityException

Specified by:

addAnnotationAnnotationLink in interface _AnnotationOperations

Throws:

UnloadedEntityException

addAllAnnotationAnnotationLinkSet

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

Specified by:

addAllAnnotationAnnotationLinkSet in interface _AnnotationOperations

Throws:

UnloadedEntityException

removeAnnotationAnnotationLink

public void removeAnnotationAnnotationLink(AnnotationAnnotationLink target,
                                           Ice.Current current)
                                    throws UnloadedEntityException

Specified by:

removeAnnotationAnnotationLink in interface _AnnotationOperations

Throws:

UnloadedEntityException

removeAllAnnotationAnnotationLinkSet

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

Specified by:

removeAllAnnotationAnnotationLinkSet in interface _AnnotationOperations

Throws:

UnloadedEntityException

clearAnnotationLinks

public void clearAnnotationLinks(Ice.Current current)
                          throws UnloadedEntityException

Specified by:

clearAnnotationLinks in interface _AnnotationOperations

Throws:

UnloadedEntityException

reloadAnnotationLinks

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

Specified by:

reloadAnnotationLinks in interface _AnnotationOperations

Throws:

UnloadedEntityException

getAnnotationLinksCountPerOwner

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

Specified by:

getAnnotationLinksCountPerOwner in interface _AnnotationOperations

linkAnnotation

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

Specified by:

linkAnnotation in interface _AnnotationOperations

Throws:

UnloadedEntityException

addAnnotationAnnotationLinkToBoth

public void addAnnotationAnnotationLinkToBoth(AnnotationAnnotationLink link,
                                              boolean bothSides,
                                              Ice.Current current)
                                       throws UnloadedEntityException

Specified by:

addAnnotationAnnotationLinkToBoth in interface _AnnotationOperations

Throws:

UnloadedEntityException

findAnnotationAnnotationLink

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

Specified by:

findAnnotationAnnotationLink in interface _AnnotationOperations

Throws:

UnloadedEntityException

unlinkAnnotation

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

Specified by:

unlinkAnnotation in interface _AnnotationOperations

Throws:

UnloadedEntityException

removeAnnotationAnnotationLinkFromBoth

public void removeAnnotationAnnotationLinkFromBoth(AnnotationAnnotationLink link,
                                                   boolean bothSides,
                                                   Ice.Current current)
                                            throws UnloadedEntityException,
                                                   UnloadedCollectionException

Specified by:

removeAnnotationAnnotationLinkFromBoth in interface _AnnotationOperations

Throws:

UnloadedEntityException

UnloadedCollectionException

linkedAnnotationList

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

Specified by:

linkedAnnotationList in interface _AnnotationOperations

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

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

Throws:

java.lang.ClassCastException