Package omero.model

Class ChannelI

java.lang.Object

Ice.ObjectImpl

omero.model.IObject

omero.model.Channel

omero.model.ChannelI

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable, ome.model.ModelBased, _ChannelOperations, _ChannelOperationsNC, _IObjectOperations, _IObjectOperationsNC

public class ChannelI
extends Channel
implements ome.model.ModelBased

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALPHA
static java.lang.String	ANNOTATIONLINKS
static java.lang.String	BLUE
static java.lang.String	DETAILS
static java.lang.String	GREEN
static java.lang.String	LOGICALCHANNEL
static java.lang.String	LOOKUPTABLE
static java.lang.String	PIXELS
static java.lang.String	RED
static java.lang.String	STATSINFO

Fields inherited from class omero.model.Channel

__ids, alpha, annotationLinksCountPerOwner, annotationLinksLoaded, annotationLinksSeq, blue, green, logicalChannel, lookupTable, pixels, red, serialVersionUID, statsInfo, version

Fields inherited from class omero.model.IObject

details, id, loaded

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor	Description
ChannelI()
ChannelI(long id, boolean loaded)
ChannelI(RLong id, boolean loaded)

Method Summary

Modifier and Type	Method	Description
void	addAllChannelAnnotationLinkSet(java.util.List<ChannelAnnotationLink> targets, Ice.Current current)
void	addChannelAnnotationLink(ChannelAnnotationLink target, Ice.Current current)
void	addChannelAnnotationLinkToBoth(ChannelAnnotationLink link, boolean bothSides, Ice.Current current)
static java.util.List<ChannelI>	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<ChannelAnnotationLink>	findChannelAnnotationLink(Annotation removal, Ice.Current current)
RInt	getAlpha(Ice.Current current)
protected java.util.List	getAnnotationLinks(Ice.Current current)
java.util.Map<java.lang.Long,java.lang.Long>	getAnnotationLinksCountPerOwner(Ice.Current current)
RInt	getBlue(Ice.Current current)
Details	getDetails(Ice.Current current)
RInt	getGreen(Ice.Current current)
RLong	getId(Ice.Current current)
LogicalChannel	getLogicalChannel(Ice.Current current)
RString	getLookupTable(Ice.Current current)
Pixels	getPixels(Ice.Current current)
RInt	getRed(Ice.Current current)
StatsInfo	getStatsInfo(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()
ChannelAnnotationLink	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(Channel toCopy, Ice.Current current)
void	removeAllChannelAnnotationLinkSet(java.util.List<ChannelAnnotationLink> targets, Ice.Current current)
void	removeChannelAnnotationLink(ChannelAnnotationLink target, Ice.Current current)
void	removeChannelAnnotationLinkFromBoth(ChannelAnnotationLink link, boolean bothSides, Ice.Current current)
void	setAlpha(RInt alpha, Ice.Current current)
protected void	setAnnotationLinks(java.util.List annotationLinks, Ice.Current current)
void	setBlue(RInt blue, Ice.Current current)
void	setGreen(RInt green, Ice.Current current)
void	setId(RLong id, Ice.Current current)
void	setLogicalChannel(LogicalChannel logicalChannel, Ice.Current current)
void	setLookupTable(RString lookupTable, Ice.Current current)
void	setPixels(Pixels pixels, Ice.Current current)
void	setRed(RInt red, Ice.Current current)
void	setStatsInfo(StatsInfo statsInfo, 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	unloadAlpha()
void	unloadAnnotationLinks(Ice.Current current)
void	unloadBlue()
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	unloadGreen()
void	unloadLogicalChannel()
void	unloadLookupTable()
void	unloadPixels()
void	unloadRed()
void	unloadStatsInfo()

Methods inherited from class omero.model.Channel

___addAllChannelAnnotationLinkSet, ___addChannelAnnotationLink, ___addChannelAnnotationLinkToBoth, ___clearAnnotationLinks, ___copyAnnotationLinks, ___findChannelAnnotationLink, ___getAlpha, ___getAnnotationLinksCountPerOwner, ___getBlue, ___getGreen, ___getLogicalChannel, ___getLookupTable, ___getPixels, ___getRed, ___getStatsInfo, ___getVersion, ___linkAnnotation, ___linkedAnnotationList, ___reloadAnnotationLinks, ___removeAllChannelAnnotationLinkSet, ___removeChannelAnnotationLink, ___removeChannelAnnotationLinkFromBoth, ___setAlpha, ___setBlue, ___setGreen, ___setLogicalChannel, ___setLookupTable, ___setPixels, ___setRed, ___setStatsInfo, ___setVersion, ___sizeOfAnnotationLinks, ___unlinkAnnotation, ___unloadAnnotationLinks, __dispatch, __readImpl, __writeImpl, addAllChannelAnnotationLinkSet, addChannelAnnotationLink, addChannelAnnotationLinkToBoth, clearAnnotationLinks, clone, copyAnnotationLinks, findChannelAnnotationLink, getAlpha, getAnnotationLinksCountPerOwner, getBlue, getGreen, getLogicalChannel, getLookupTable, getPixels, getRed, getStatsInfo, getVersion, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId, linkAnnotation, linkedAnnotationList, reloadAnnotationLinks, removeAllChannelAnnotationLinkSet, removeChannelAnnotationLink, removeChannelAnnotationLinkFromBoth, setAlpha, setBlue, setGreen, setLogicalChannel, setLookupTable, setPixels, setRed, setStatsInfo, 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._IObjectOperationsNC

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

Field Detail

STATSINFO

public static final java.lang.String STATSINFO

See Also:

Constant Field Values

RED

public static final java.lang.String RED

See Also:

Constant Field Values

GREEN

public static final java.lang.String GREEN

See Also:

Constant Field Values

BLUE

public static final java.lang.String BLUE

See Also:

Constant Field Values

ALPHA

public static final java.lang.String ALPHA

See Also:

Constant Field Values

LOOKUPTABLE

public static final java.lang.String LOOKUPTABLE

See Also:

Constant Field Values

LOGICALCHANNEL

public static final java.lang.String LOGICALCHANNEL

See Also:

Constant Field Values

PIXELS

public static final java.lang.String PIXELS

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

ChannelI

public ChannelI()

ChannelI

public ChannelI(long id,
                boolean loaded)

ChannelI

public ChannelI(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 _ChannelOperations

setVersion

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

Specified by:

setVersion in interface _ChannelOperations

unloadStatsInfo

public void unloadStatsInfo()

getStatsInfo

public StatsInfo getStatsInfo(Ice.Current current)
                       throws UnloadedEntityException

Specified by:

getStatsInfo in interface _ChannelOperations

Throws:

UnloadedEntityException

setStatsInfo

public void setStatsInfo(StatsInfo statsInfo,
                         Ice.Current current)
                  throws UnloadedEntityException

Specified by:

setStatsInfo in interface _ChannelOperations

Throws:

UnloadedEntityException

unloadRed

public void unloadRed()

getRed

public RInt getRed(Ice.Current current)
            throws UnloadedEntityException

Specified by:

getRed in interface _ChannelOperations

Throws:

UnloadedEntityException

setRed

public void setRed(RInt red,
                   Ice.Current current)
            throws UnloadedEntityException

Specified by:

setRed in interface _ChannelOperations

Throws:

UnloadedEntityException

unloadGreen

public void unloadGreen()

getGreen

public RInt getGreen(Ice.Current current)
              throws UnloadedEntityException

Specified by:

getGreen in interface _ChannelOperations

Throws:

UnloadedEntityException

setGreen

public void setGreen(RInt green,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:

setGreen in interface _ChannelOperations

Throws:

UnloadedEntityException

unloadBlue

public void unloadBlue()

getBlue

public RInt getBlue(Ice.Current current)
             throws UnloadedEntityException

Specified by:

getBlue in interface _ChannelOperations

Throws:

UnloadedEntityException

setBlue

public void setBlue(RInt blue,
                    Ice.Current current)
             throws UnloadedEntityException

Specified by:

setBlue in interface _ChannelOperations

Throws:

UnloadedEntityException

unloadAlpha

public void unloadAlpha()

getAlpha

public RInt getAlpha(Ice.Current current)
              throws UnloadedEntityException

Specified by:

getAlpha in interface _ChannelOperations

Throws:

UnloadedEntityException

setAlpha

public void setAlpha(RInt alpha,
                     Ice.Current current)
              throws UnloadedEntityException

Specified by:

setAlpha in interface _ChannelOperations

Throws:

UnloadedEntityException

unloadLookupTable

public void unloadLookupTable()

getLookupTable

public RString getLookupTable(Ice.Current current)
                       throws UnloadedEntityException

Specified by:

getLookupTable in interface _ChannelOperations

Throws:

UnloadedEntityException

setLookupTable

public void setLookupTable(RString lookupTable,
                           Ice.Current current)
                    throws UnloadedEntityException

Specified by:

setLookupTable in interface _ChannelOperations

Throws:

UnloadedEntityException

unloadLogicalChannel

public void unloadLogicalChannel()

getLogicalChannel

public LogicalChannel getLogicalChannel(Ice.Current current)
                                 throws UnloadedEntityException

Specified by:

getLogicalChannel in interface _ChannelOperations

Throws:

UnloadedEntityException

setLogicalChannel

public void setLogicalChannel(LogicalChannel logicalChannel,
                              Ice.Current current)
                       throws UnloadedEntityException

Specified by:

setLogicalChannel in interface _ChannelOperations

Throws:

UnloadedEntityException

unloadPixels

public void unloadPixels()

getPixels

public Pixels getPixels(Ice.Current current)
                 throws UnloadedEntityException

Specified by:

getPixels in interface _ChannelOperations

Throws:

UnloadedEntityException

setPixels

public void setPixels(Pixels pixels,
                      Ice.Current current)
               throws UnloadedEntityException

Specified by:

setPixels in interface _ChannelOperations

Throws:

UnloadedEntityException

unloadAnnotationLinks

public void unloadAnnotationLinks(Ice.Current current)

Specified by:

unloadAnnotationLinks in interface _ChannelOperations

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 _ChannelOperations

Throws:

UnloadedEntityException

copyAnnotationLinks

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

Specified by:

copyAnnotationLinks in interface _ChannelOperations

Throws:

UnloadedEntityException

iterateAnnotationLinks

public java.util.Iterator iterateAnnotationLinks()
                                          throws UnloadedEntityException

Throws:

UnloadedEntityException

addChannelAnnotationLink

public void addChannelAnnotationLink(ChannelAnnotationLink target,
                                     Ice.Current current)
                              throws UnloadedEntityException

Specified by:

addChannelAnnotationLink in interface _ChannelOperations

Throws:

UnloadedEntityException

addAllChannelAnnotationLinkSet

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

Specified by:

addAllChannelAnnotationLinkSet in interface _ChannelOperations

Throws:

UnloadedEntityException

removeChannelAnnotationLink

public void removeChannelAnnotationLink(ChannelAnnotationLink target,
                                        Ice.Current current)
                                 throws UnloadedEntityException

Specified by:

removeChannelAnnotationLink in interface _ChannelOperations

Throws:

UnloadedEntityException

removeAllChannelAnnotationLinkSet

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

Specified by:

removeAllChannelAnnotationLinkSet in interface _ChannelOperations

Throws:

UnloadedEntityException

clearAnnotationLinks

public void clearAnnotationLinks(Ice.Current current)
                          throws UnloadedEntityException

Specified by:

clearAnnotationLinks in interface _ChannelOperations

Throws:

UnloadedEntityException

reloadAnnotationLinks

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

Specified by:

reloadAnnotationLinks in interface _ChannelOperations

Throws:

UnloadedEntityException

getAnnotationLinksCountPerOwner

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

Specified by:

getAnnotationLinksCountPerOwner in interface _ChannelOperations

linkAnnotation

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

Specified by:

linkAnnotation in interface _ChannelOperations

Throws:

UnloadedEntityException

addChannelAnnotationLinkToBoth

public void addChannelAnnotationLinkToBoth(ChannelAnnotationLink link,
                                           boolean bothSides,
                                           Ice.Current current)
                                    throws UnloadedEntityException

Specified by:

addChannelAnnotationLinkToBoth in interface _ChannelOperations

Throws:

UnloadedEntityException

findChannelAnnotationLink

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

Specified by:

findChannelAnnotationLink in interface _ChannelOperations

Throws:

UnloadedEntityException

unlinkAnnotation

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

Specified by:

unlinkAnnotation in interface _ChannelOperations

Throws:

UnloadedEntityException

removeChannelAnnotationLinkFromBoth

public void removeChannelAnnotationLinkFromBoth(ChannelAnnotationLink link,
                                                boolean bothSides,
                                                Ice.Current current)
                                         throws UnloadedEntityException,
                                                UnloadedCollectionException

Specified by:

removeChannelAnnotationLinkFromBoth in interface _ChannelOperations

Throws:

UnloadedEntityException

UnloadedCollectionException

linkedAnnotationList

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

Specified by:

linkedAnnotationList in interface _ChannelOperations

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

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

Throws:

java.lang.ClassCastException