@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class ChannelBinding extends Object implements Serializable, IObject, IMutable
Modifier and Type | Class and Description |
---|---|
static class |
ChannelBinding.Details |
Modifier | Constructor and Description |
---|---|
|
ChannelBinding() |
protected |
ChannelBinding(Long id) |
|
ChannelBinding(Long id,
boolean loaded)
Main constructor.
|
|
ChannelBinding(RenderingDef _renderingDef,
Family _family,
Double _coefficient,
Double _inputStart,
Double _inputEnd,
Boolean _active,
Boolean _noiseReduction,
Integer _red,
Integer _green,
Integer _blue,
Integer _alpha) |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFilter(Filter __filter) |
void |
addCodomainMapContext(CodomainMapContext target)
use instead of setSpatialDomainEnhancement .
|
void |
addCodomainMapContextSet(Collection<CodomainMapContext> targets)
use like addCodomainMapContext.
|
void |
clearSpatialDomainEnhancement()
clears the set.
|
<E> List<E> |
collectSpatialDomainEnhancement(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.display.CodomainMapContext while
collecting the results.
|
protected void |
errorIfUnloaded() |
Set<String> |
fields()
returns a Set of field names that belong to this class
|
Boolean |
getActive()
Simple field ome.model.display.ChannelBinding.active (java.lang.Boolean)
|
Integer |
getAlpha()
Simple field ome.model.display.ChannelBinding.alpha (java.lang.Integer)
|
Integer |
getBlue()
Simple field ome.model.display.ChannelBinding.blue (java.lang.Integer)
|
CodomainMapContext |
getCodomainMapContext(int index)
Gets the ome.model.display.CodomainMapContext at the given index.
|
Double |
getCoefficient()
Simple field ome.model.display.ChannelBinding.coefficient (java.lang.Double)
|
Details |
getDetails()
The details of this object correspond to low-level system
information.
|
Family |
getFamily()
Many-to-one field ome.model.display.ChannelBinding.family (ome.model.enums.Family)
|
GraphHolder |
getGraphHolder()
retrieves the
GraphHolder for this entity. |
Integer |
getGreen()
Simple field ome.model.display.ChannelBinding.green (java.lang.Integer)
|
Long |
getId()
The DB unique identifier for this object.
|
Double |
getInputEnd()
Simple field ome.model.display.ChannelBinding.inputEnd (java.lang.Double)
|
Double |
getInputStart()
Simple field ome.model.display.ChannelBinding.inputStart (java.lang.Double)
|
String |
getLookupTable()
Simple field ome.model.display.ChannelBinding.lookupTable (java.lang.String)
|
Boolean |
getNoiseReduction()
Simple field ome.model.display.ChannelBinding.noiseReduction (java.lang.Boolean)
|
CodomainMapContext |
getPrimaryCodomainMapContext()
Gets the first element of spatialDomainEnhancement which can be interpreted as the
primary or default element in some situations.
|
Integer |
getRed()
Simple field ome.model.display.ChannelBinding.red (java.lang.Integer)
|
RenderingDef |
getRenderingDef()
Many-to-one field ome.model.display.ChannelBinding.renderingDef (ome.model.display.RenderingDef)
|
protected List<CodomainMapContext> |
getSpatialDomainEnhancement()
returns spatialDomainEnhancement .
|
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<CodomainMapContext> |
iterateSpatialDomainEnhancement()
should be used rather than accessing the spatialDomainEnhancement set directly.
|
ChannelBinding |
newInstance() |
ChannelBinding |
proxy() |
void |
putAt(String field,
Object value)
stores a value in this instance.
|
void |
removeCodomainMapContext(CodomainMapContext target)
removes a single element from this set and makes the inverse call on ome.model.display.CodomainMapContext
|
void |
removeCodomainMapContextSet(Collection<CodomainMapContext> targets)
use like removeCodomainMapContext
|
Object |
retrieve(String field)
retrieves a value from this instance.
|
void |
setActive(Boolean active) |
void |
setAlpha(Integer alpha) |
void |
setBlue(Integer blue) |
CodomainMapContext |
setCodomainMapContext(int index,
CodomainMapContext element)
Sets the ome.model.display.CodomainMapContext at the given index.
|
void |
setCoefficient(Double coefficient) |
protected void |
setDetails(Details details)
Use the
Details.copy(ome.model.internal.Details)
or Details.shallowCopy(ome.model.internal.Details)
methods to set the ChannelBinding.Details instance instead. |
void |
setFamily(Family family) |
void |
setGreen(Integer green) |
void |
setId(Long id)
usually unneeded.
|
void |
setInputEnd(Double inputEnd) |
void |
setInputStart(Double inputStart) |
void |
setLookupTable(String lookupTable) |
void |
setNoiseReduction(Boolean noiseReduction) |
CodomainMapContext |
setPrimaryCodomainMapContext(CodomainMapContext element)
Swaps the first element of spatialDomainEnhancement with the first instance of the
given element.
|
void |
setRed(Integer red) |
void |
setRenderingDef(RenderingDef renderingDef) |
protected void |
setSpatialDomainEnhancement(List<CodomainMapContext> spatialDomainEnhancement)
setter for spatialDomainEnhancement should be avoided.
|
void |
setVersion(Integer version)
use with caution.
|
int |
sizeOfSpatialDomainEnhancement()
returns the size of spatialDomainEnhancement.
|
protected void |
throwNullCollectionException(String propertyName) |
String |
toString() |
void |
unload()
set the loaded field to false, and set all non-ID fields to null.
|
Collection<CodomainMapContext> |
unmodifiableSpatialDomainEnhancement()
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 RenderingDef renderingDef
protected Family family
protected Double coefficient
protected Double inputStart
protected Double inputEnd
protected Boolean active
protected Boolean noiseReduction
protected Integer red
protected Integer green
protected Integer blue
protected Integer alpha
protected String lookupTable
protected List<CodomainMapContext> spatialDomainEnhancement
public static final String OWNER_FILTER_SPATIALDOMAINENHANCEMENT
public static final String GROUP_FILTER_SPATIALDOMAINENHANCEMENT
public static final String EVENT_FILTER_SPATIALDOMAINENHANCEMENT
public static final String PERMS_FILTER_SPATIALDOMAINENHANCEMENT
protected Details details
public static final String RENDERINGDEF
public static final String FAMILY
public static final String COEFFICIENT
public static final String INPUTSTART
public static final String INPUTEND
public static final String ACTIVE
public static final String NOISEREDUCTION
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 SPATIALDOMAINENHANCEMENT
public static final String DETAILS
protected boolean _loaded
public ChannelBinding()
protected ChannelBinding(Long id)
public ChannelBinding(Long id, boolean loaded)
@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 RenderingDef getRenderingDef()
public void setRenderingDef(RenderingDef renderingDef)
public Family getFamily()
public void setFamily(Family family)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Double getCoefficient()
public void setCoefficient(Double coefficient)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Double getInputStart()
public void setInputStart(Double inputStart)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Double getInputEnd()
public void setInputEnd(Double inputEnd)
public Boolean getActive()
public void setActive(Boolean active)
public Boolean getNoiseReduction()
public void setNoiseReduction(Boolean noiseReduction)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Integer getRed()
public void setRed(Integer red)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Integer getGreen()
public void setGreen(Integer green)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Integer getBlue()
public void setBlue(Integer blue)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Integer getAlpha()
public void setAlpha(Integer alpha)
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getLookupTable()
public void setLookupTable(String lookupTable)
protected List<CodomainMapContext> getSpatialDomainEnhancement()
protected void setSpatialDomainEnhancement(List<CodomainMapContext> spatialDomainEnhancement)
public int sizeOfSpatialDomainEnhancement()
public Iterator<CodomainMapContext> iterateSpatialDomainEnhancement()
EmptyIterator
. To test for a null collection,
see of sizeOfSpatialDomainEnhancement()
is less than zero.public Collection<CodomainMapContext> unmodifiableSpatialDomainEnhancement()
public <E> List<E> collectSpatialDomainEnhancement(CBlock<E> block)
block == null
, then the
iterator values themselves are collected. This method uses
iterateSpatialDomainEnhancement()
internally and so will return a value
even if the underlying collection is null.public void addCodomainMapContext(CodomainMapContext target)
public void addCodomainMapContextSet(Collection<CodomainMapContext> targets)
public void removeCodomainMapContext(CodomainMapContext target)
public void removeCodomainMapContextSet(Collection<CodomainMapContext> targets)
public void clearSpatialDomainEnhancement()
public CodomainMapContext getCodomainMapContext(int index) throws IndexOutOfBoundsException
IndexOutOfBoundsException
public CodomainMapContext setCodomainMapContext(int index, CodomainMapContext element) throws IndexOutOfBoundsException
List.set(int, Object)
contract. To extend the list, use addCodomainMapContext(CodomainMapContext)
.IndexOutOfBoundsException
List.set(int, Object)
public CodomainMapContext getPrimaryCodomainMapContext() throws IndexOutOfBoundsException
IndexOutOfBoundsException
is throws. This method
will also throw an ApiUsageException
if the collection is
unloaded. See sizeOfSpatialDomainEnhancement()
for more information.IndexOutOfBoundsException
public CodomainMapContext setPrimaryCodomainMapContext(CodomainMapContext element) throws IndexOutOfBoundsException
IndexOutOfBoundsException
will be thrown. Returns the swapped
element. This method
will also throw an ApiUsageException
if the collection is
unloaded. See sizeOfSpatialDomainEnhancement()
for more information.IndexOutOfBoundsException
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 ChannelBinding.Details
instance instead.public boolean isValid()
IObject
Validation.isValid()
public Validation validate()
IObject
Validation
object.public ChannelBinding newInstance()
public ChannelBinding 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.3.5-ice35-b73
Copyright © 2017 The University of Dundee & Open Microscopy Environment. All Rights Reserved.