@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class Channel extends Object implements Serializable, IObject, IMutable, IAnnotated
Modifier and Type | Class and Description |
---|---|
static class |
Channel.Details |
Modifier | Constructor and Description |
---|---|
|
Channel() |
|
Channel(LogicalChannel _logicalChannel,
Pixels _pixels) |
protected |
Channel(Long id) |
|
Channel(Long id,
boolean loaded)
Main constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFilter(Filter __filter) |
void |
addChannelAnnotationLink(ChannelAnnotationLink target)
use instead of setAnnotationLinks .
|
void |
addChannelAnnotationLink(ChannelAnnotationLink link,
boolean bothSides)
Adds a ome.model.annotations.ChannelAnnotationLink to annotationLinks, allowing for recursion -- whether
or not addChannelAnnotationLink will be called on the addition if it is loaded
|
void |
addChannelAnnotationLinkSet(Collection<ChannelAnnotationLink> targets)
use like addChannelAnnotationLink.
|
void |
clearAnnotationLinks()
clears the set.
|
<E> List<E> |
collectAnnotationLinks(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.annotations.ChannelAnnotationLink while
collecting the results.
|
<E> List<E> |
eachLinkedAnnotation(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.annotations.Annotation while
collecting the results.
|
protected void |
errorIfUnloaded() |
Set<String> |
fields()
returns a Set of field names that belong to this class
|
Set<ChannelAnnotationLink> |
findChannelAnnotationLink(Annotation target)
find all ome.model.annotations.ChannelAnnotationLink which have the argument as their child.
|
Integer |
getAlpha()
Simple field ome.model.core.Channel.alpha (java.lang.Integer)
|
protected Set<ChannelAnnotationLink> |
getAnnotationLinks()
returns annotationLinks .
|
Map<Long,Long> |
getAnnotationLinksCountPerOwner()
If fetched, returns the count(*) of ome.model.annotations.ChannelAnnotationLink that a user has.
|
Integer |
getBlue()
Simple field ome.model.core.Channel.blue (java.lang.Integer)
|
Details |
getDetails()
The details of this object correspond to low-level system
information.
|
GraphHolder |
getGraphHolder()
retrieves the
GraphHolder for this entity. |
Integer |
getGreen()
Simple field ome.model.core.Channel.green (java.lang.Integer)
|
Long |
getId()
The DB unique identifier for this object.
|
LogicalChannel |
getLogicalChannel()
Many-to-one field ome.model.core.Channel.logicalChannel (ome.model.core.LogicalChannel)
|
String |
getLookupTable()
Simple field ome.model.core.Channel.lookupTable (java.lang.String)
|
Pixels |
getPixels()
Many-to-one field ome.model.core.Channel.pixels (ome.model.core.Pixels)
|
Integer |
getRed()
Simple field ome.model.core.Channel.red (java.lang.Integer)
|
StatsInfo |
getStatsInfo()
Many-to-one field ome.model.core.Channel.statsInfo (ome.model.stats.StatsInfo)
|
Integer |
getVersion()
This version number is controlled by the database for optimisitic
locking.
|
boolean |
isLoaded()
transient field (not stored in the DB) which specifies whether this
object has been loaded from the DB or is only a wrapper around the ID.
|
boolean |
isValid()
calls the class-specific validator for this instance and returns the
value from
Validation.isValid() |
Iterator<ChannelAnnotationLink> |
iterateAnnotationLinks()
should be used rather than accessing the annotationLinks set directly.
|
ChannelAnnotationLink |
linkAnnotation(Annotation addition)
Adds a ome.model.annotations.ChannelAnnotationLink to annotationLinks .
|
Iterator<Annotation> |
linkedAnnotationIterator()
provides an iterator over the parent values of the annotationLinks.
|
List<Annotation> |
linkedAnnotationList()
produces a
List -copy of the underlying collection. |
Channel |
newInstance() |
Channel |
proxy() |
void |
putAt(String field,
Object value)
stores a value in this instance.
|
void |
removeChannelAnnotationLink(ChannelAnnotationLink target)
removes a single element from this set and makes the inverse call on ome.model.annotations.ChannelAnnotationLink
|
void |
removeChannelAnnotationLink(ChannelAnnotationLink link,
boolean bothSides)
removes the given ChannelAnnotationLink from annotationLinks, allowing for recursion -- whether
or not the removal will call unlinkChannel again if loaded.
|
void |
removeChannelAnnotationLinkSet(Collection<ChannelAnnotationLink> targets)
use like removeChannelAnnotationLink
|
Object |
retrieve(String field)
retrieves a value from this instance.
|
void |
setAlpha(Integer alpha) |
protected void |
setAnnotationLinks(Set<ChannelAnnotationLink> annotationLinks)
setter for annotationLinks should be avoided.
|
protected void |
setAnnotationLinksCountPerOwner(Map<Long,Long> map) |
void |
setBlue(Integer blue) |
protected void |
setDetails(Details details)
Use the
Details.copy(ome.model.internal.Details)
or Details.shallowCopy(ome.model.internal.Details)
methods to set the Channel.Details instance instead. |
void |
setGreen(Integer green) |
void |
setId(Long id)
usually unneeded.
|
void |
setLogicalChannel(LogicalChannel logicalChannel) |
void |
setLookupTable(String lookupTable) |
void |
setPixels(Pixels pixels) |
void |
setRed(Integer red) |
void |
setStatsInfo(StatsInfo statsInfo) |
void |
setVersion(Integer version)
use with caution.
|
int |
sizeOfAnnotationLinks()
returns the size of annotationLinks.
|
protected void |
throwNullCollectionException(String propertyName) |
String |
toString() |
void |
unlinkAnnotation(Annotation removal)
unlinks all ome.model.annotations.Annotation instances from this instance.
|
void |
unload()
set the loaded field to false, and set all non-ID fields to null.
|
Collection<ChannelAnnotationLink> |
unmodifiableAnnotationLinks()
Returns an unmodifiable collection-view
|
Validation |
validate()
calls the class-specific validator for this instance and returns the
Validation object. |
public static final String OWNER_FILTER
public static final String GROUP_FILTER
public static final String EVENT_FILTER
public static final String PERMS_FILTER
public static final String ID
protected Long id
public static final String VERSION
protected Integer version
protected StatsInfo statsInfo
protected Integer red
protected Integer green
protected Integer blue
protected Integer alpha
protected String lookupTable
protected LogicalChannel logicalChannel
protected Pixels pixels
protected Set<ChannelAnnotationLink> annotationLinks
public static final String OWNER_FILTER_ANNOTATIONLINKS
public static final String GROUP_FILTER_ANNOTATIONLINKS
public static final String EVENT_FILTER_ANNOTATIONLINKS
public static final String PERMS_FILTER_ANNOTATIONLINKS
protected Details details
public static final String STATSINFO
public static final String RED
public static final String GREEN
public static final String BLUE
public static final String ALPHA
public static final String LOOKUPTABLE
public static final String LOGICALCHANNEL
public static final String PIXELS
public static final String ANNOTATIONLINKSCOUNTPEROWNER
public static final String ANNOTATIONLINKS
public static final String DETAILS
protected boolean _loaded
public Channel()
protected Channel(Long id)
public Channel(Long id, boolean loaded)
public Channel(LogicalChannel _logicalChannel, Pixels _pixels)
@DocumentId public Long getId()
public void setId(Long id)
IObject
public Integer getVersion()
getVersion
in interface IMutable
public void setVersion(Integer version)
IMutable
setVersion
in interface IMutable
version
- Value for this objects version.public StatsInfo getStatsInfo()
public void setStatsInfo(StatsInfo statsInfo)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")}) public Integer getRed()
public void setRed(Integer red)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")}) public Integer getGreen()
public void setGreen(Integer green)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")}) public Integer getBlue()
public void setBlue(Integer blue)
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")}) public Integer getAlpha()
public void setAlpha(Integer alpha)
@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")}) public String getLookupTable()
public void setLookupTable(String lookupTable)
public LogicalChannel getLogicalChannel()
public void setLogicalChannel(LogicalChannel logicalChannel)
public Pixels getPixels()
public void setPixels(Pixels pixels)
protected Set<ChannelAnnotationLink> getAnnotationLinks()
protected void setAnnotationLinks(Set<ChannelAnnotationLink> annotationLinks)
public int sizeOfAnnotationLinks()
sizeOfAnnotationLinks
in interface IAnnotated
public Iterator<ChannelAnnotationLink> iterateAnnotationLinks()
EmptyIterator
. To test for a null collection,
see of sizeOfAnnotationLinks()
is less than zero.iterateAnnotationLinks
in interface IAnnotated
public Collection<ChannelAnnotationLink> unmodifiableAnnotationLinks()
unmodifiableAnnotationLinks
in interface IAnnotated
public <E> List<E> collectAnnotationLinks(CBlock<E> block)
block == null
, then the
iterator values themselves are collected. This method uses
iterateAnnotationLinks()
internally and so will return a value
even if the underlying collection is null.collectAnnotationLinks
in interface IAnnotated
public void addChannelAnnotationLink(ChannelAnnotationLink target)
public void addChannelAnnotationLinkSet(Collection<ChannelAnnotationLink> targets)
public void removeChannelAnnotationLink(ChannelAnnotationLink target)
public void removeChannelAnnotationLinkSet(Collection<ChannelAnnotationLink> targets)
public ChannelAnnotationLink linkAnnotation(Annotation addition)
linkAnnotation
in interface IAnnotated
public void addChannelAnnotationLink(ChannelAnnotationLink link, boolean bothSides)
public Iterator<Annotation> linkedAnnotationIterator()
ConcurrentModificationException
.
Use linkedAnnotationList()
instead.linkedAnnotationIterator
in interface IAnnotated
public Set<ChannelAnnotationLink> findChannelAnnotationLink(Annotation target)
public List<Annotation> linkedAnnotationList()
List
-copy of the underlying collection. Unlike,
linkedAnnotationIterator()
, while using the returned List
,
modifications can be made to the underlying collection without throwing
ConcurrentModificationException
.linkedAnnotationList
in interface IAnnotated
public <E> List<E> eachLinkedAnnotation(CBlock<E> block)
block == null
, then the
iterator values themselves are collected.eachLinkedAnnotation
in interface IAnnotated
public void unlinkAnnotation(Annotation removal)
unlinkAnnotation
in interface IAnnotated
public void removeChannelAnnotationLink(ChannelAnnotationLink link, boolean bothSides)
public void clearAnnotationLinks()
clearAnnotationLinks
in interface IAnnotated
public Map<Long,Long> getAnnotationLinksCountPerOwner()
public Details getDetails()
Details
type.getDetails
in interface IObject
protected void setDetails(Details details)
Details.copy(ome.model.internal.Details)
or Details.shallowCopy(ome.model.internal.Details)
methods to set the Channel.Details
instance instead.public boolean isValid()
IObject
Validation.isValid()
public Validation validate()
IObject
Validation
object.public Channel newInstance()
public Channel proxy()
public boolean acceptFilter(Filter __filter)
acceptFilter
in interface Filterable
public Set<String> fields()
IObject
public Object retrieve(String field)
IObject
field
which match a field of this instance will be delegated to the accessors.
Otherwise, values will be retrieved from a lazy-loaded map filled by
calls to IObject.putAt(String, Object)
public void putAt(String field, Object value)
IObject
field
which
match a field of this instance will be delegated to the accessors.
Otherwise, values will be stored in a lazy-loaded map.public boolean isLoaded()
IObject
protected void errorIfUnloaded()
public void unload()
IObject
public final GraphHolder getGraphHolder()
IObject
GraphHolder
for this entity. If the GraphHolder has
not been actively set, a new one will be instatiated.getGraphHolder
in interface IObject
protected void throwNullCollectionException(String propertyName)
Version: 5.1.4-ice35-b55
Copyright © 2015 The University of Dundee & Open Microscopy Environment. All Rights Reserved.