@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class ChannelBinding extends java.lang.Object implements java.io.Serializable, IObject, IMutable
Modifier and Type | Class and Description |
---|---|
static class |
ChannelBinding.Details |
Modifier and Type | Field and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
_dynamicFields |
protected boolean |
_loaded |
protected java.lang.Boolean |
active |
static java.lang.String |
ACTIVE |
protected java.lang.Integer |
alpha |
static java.lang.String |
ALPHA |
protected java.lang.Integer |
blue |
static java.lang.String |
BLUE |
protected java.lang.Double |
coefficient |
static java.lang.String |
COEFFICIENT |
protected Details |
details |
static java.lang.String |
DETAILS |
static java.lang.String |
EVENT_FILTER |
static java.lang.String |
EVENT_FILTER_SPATIALDOMAINENHANCEMENT |
protected Family |
family |
static java.lang.String |
FAMILY |
static java.util.Set<java.lang.String> |
FIELDS |
protected java.lang.Integer |
green |
static java.lang.String |
GREEN |
static java.lang.String |
GROUP_FILTER |
static java.lang.String |
GROUP_FILTER_SPATIALDOMAINENHANCEMENT |
protected java.lang.Long |
id |
static java.lang.String |
ID |
protected java.lang.Double |
inputEnd |
static java.lang.String |
INPUTEND |
protected java.lang.Double |
inputStart |
static java.lang.String |
INPUTSTART |
protected java.lang.String |
lookupTable |
static java.lang.String |
LOOKUPTABLE |
protected java.lang.Boolean |
noiseReduction |
static java.lang.String |
NOISEREDUCTION |
static java.lang.String |
OWNER_FILTER |
static java.lang.String |
OWNER_FILTER_SPATIALDOMAINENHANCEMENT |
static java.lang.String |
PERMS_FILTER |
static java.lang.String |
PERMS_FILTER_SPATIALDOMAINENHANCEMENT |
protected java.lang.Integer |
red |
static java.lang.String |
RED |
protected RenderingDef |
renderingDef |
static java.lang.String |
RENDERINGDEF |
protected java.util.List<CodomainMapContext> |
spatialDomainEnhancement |
static java.lang.String |
SPATIALDOMAINENHANCEMENT |
protected java.lang.Integer |
version |
static java.lang.String |
VERSION |
Modifier | Constructor and Description |
---|---|
|
ChannelBinding() |
protected |
ChannelBinding(java.lang.Long id) |
|
ChannelBinding(java.lang.Long id,
boolean loaded)
Main constructor.
|
|
ChannelBinding(RenderingDef _renderingDef,
Family _family,
java.lang.Double _coefficient,
java.lang.Double _inputStart,
java.lang.Double _inputEnd,
java.lang.Boolean _active,
java.lang.Boolean _noiseReduction,
java.lang.Integer _red,
java.lang.Integer _green,
java.lang.Integer _blue,
java.lang.Integer _alpha) |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFilter(Filter __filter) |
void |
addCodomainMapContext(CodomainMapContext target)
use instead of setSpatialDomainEnhancement .
|
void |
addCodomainMapContextSet(java.util.Collection<CodomainMapContext> targets)
use like addCodomainMapContext.
|
void |
clearSpatialDomainEnhancement()
clears the set.
|
<E> java.util.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() |
java.util.Set<java.lang.String> |
fields()
returns a Set of field names that belong to this class
|
java.lang.Boolean |
getActive()
Simple field ome.model.display.ChannelBinding.active (java.lang.Boolean)
|
java.lang.Integer |
getAlpha()
Simple field ome.model.display.ChannelBinding.alpha (java.lang.Integer)
|
java.lang.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.
|
java.lang.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. |
java.lang.Integer |
getGreen()
Simple field ome.model.display.ChannelBinding.green (java.lang.Integer)
|
java.lang.Long |
getId()
The DB unique identifier for this object.
|
java.lang.Double |
getInputEnd()
Simple field ome.model.display.ChannelBinding.inputEnd (java.lang.Double)
|
java.lang.Double |
getInputStart()
Simple field ome.model.display.ChannelBinding.inputStart (java.lang.Double)
|
java.lang.String |
getLookupTable()
Simple field ome.model.display.ChannelBinding.lookupTable (java.lang.String)
|
java.lang.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.
|
java.lang.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 java.util.List<CodomainMapContext> |
getSpatialDomainEnhancement()
returns spatialDomainEnhancement .
|
java.lang.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() |
java.util.Iterator<CodomainMapContext> |
iterateSpatialDomainEnhancement()
should be used rather than accessing the spatialDomainEnhancement set directly.
|
ChannelBinding |
newInstance() |
ChannelBinding |
proxy() |
void |
putAt(java.lang.String field,
java.lang.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(java.util.Collection<CodomainMapContext> targets)
use like removeCodomainMapContext
|
java.lang.Object |
retrieve(java.lang.String field)
retrieves a value from this instance.
|
void |
setActive(java.lang.Boolean active) |
void |
setAlpha(java.lang.Integer alpha) |
void |
setBlue(java.lang.Integer blue) |
CodomainMapContext |
setCodomainMapContext(int index,
CodomainMapContext element)
Sets the ome.model.display.CodomainMapContext at the given index.
|
void |
setCoefficient(java.lang.Double coefficient) |
protected void |
setDetails(Details details) |
void |
setFamily(Family family) |
void |
setGreen(java.lang.Integer green) |
void |
setId(java.lang.Long id)
usually unneeded.
|
void |
setInputEnd(java.lang.Double inputEnd) |
void |
setInputStart(java.lang.Double inputStart) |
void |
setLookupTable(java.lang.String lookupTable) |
void |
setNoiseReduction(java.lang.Boolean noiseReduction) |
CodomainMapContext |
setPrimaryCodomainMapContext(CodomainMapContext element)
Swaps the first element of spatialDomainEnhancement with the first instance of the
given element.
|
void |
setRed(java.lang.Integer red) |
void |
setRenderingDef(RenderingDef renderingDef) |
protected void |
setSpatialDomainEnhancement(java.util.List<CodomainMapContext> spatialDomainEnhancement)
setter for spatialDomainEnhancement should be avoided.
|
void |
setVersion(java.lang.Integer version)
use with caution.
|
int |
sizeOfSpatialDomainEnhancement()
returns the size of spatialDomainEnhancement.
|
protected void |
throwNullCollectionException(java.lang.String propertyName) |
java.lang.String |
toString() |
void |
unload()
set the loaded field to false, and set all non-ID fields to null.
|
java.util.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 java.lang.String OWNER_FILTER
public static final java.lang.String GROUP_FILTER
public static final java.lang.String EVENT_FILTER
public static final java.lang.String PERMS_FILTER
public static final java.lang.String ID
protected java.lang.Long id
public static final java.lang.String VERSION
protected java.lang.Integer version
protected RenderingDef renderingDef
protected Family family
protected java.lang.Double coefficient
protected java.lang.Double inputStart
protected java.lang.Double inputEnd
protected java.lang.Boolean active
protected java.lang.Boolean noiseReduction
protected java.lang.Integer red
protected java.lang.Integer green
protected java.lang.Integer blue
protected java.lang.Integer alpha
protected java.lang.String lookupTable
protected java.util.List<CodomainMapContext> spatialDomainEnhancement
public static final java.lang.String OWNER_FILTER_SPATIALDOMAINENHANCEMENT
public static final java.lang.String GROUP_FILTER_SPATIALDOMAINENHANCEMENT
public static final java.lang.String EVENT_FILTER_SPATIALDOMAINENHANCEMENT
public static final java.lang.String PERMS_FILTER_SPATIALDOMAINENHANCEMENT
protected Details details
public static final java.lang.String RENDERINGDEF
public static final java.lang.String FAMILY
public static final java.lang.String COEFFICIENT
public static final java.lang.String INPUTSTART
public static final java.lang.String INPUTEND
public static final java.lang.String ACTIVE
public static final java.lang.String NOISEREDUCTION
public static final java.lang.String RED
public static final java.lang.String GREEN
public static final java.lang.String BLUE
public static final java.lang.String ALPHA
public static final java.lang.String LOOKUPTABLE
public static final java.lang.String SPATIALDOMAINENHANCEMENT
public static final java.lang.String DETAILS
public static final java.util.Set<java.lang.String> FIELDS
protected java.util.Map<java.lang.String,java.lang.Object> _dynamicFields
protected boolean _loaded
public ChannelBinding()
protected ChannelBinding(java.lang.Long id)
public ChannelBinding(java.lang.Long id, boolean loaded)
public ChannelBinding(RenderingDef _renderingDef, Family _family, java.lang.Double _coefficient, java.lang.Double _inputStart, java.lang.Double _inputEnd, java.lang.Boolean _active, java.lang.Boolean _noiseReduction, java.lang.Integer _red, java.lang.Integer _green, java.lang.Integer _blue, java.lang.Integer _alpha)
@DocumentId public java.lang.Long getId()
public void setId(java.lang.Long id)
IObject
public java.lang.Integer getVersion()
getVersion
in interface IMutable
public void setVersion(java.lang.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 java.lang.Double getCoefficient()
public void setCoefficient(java.lang.Double coefficient)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public java.lang.Double getInputStart()
public void setInputStart(java.lang.Double inputStart)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public java.lang.Double getInputEnd()
public void setInputEnd(java.lang.Double inputEnd)
public java.lang.Boolean getActive()
public void setActive(java.lang.Boolean active)
public java.lang.Boolean getNoiseReduction()
public void setNoiseReduction(java.lang.Boolean noiseReduction)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public java.lang.Integer getRed()
public void setRed(java.lang.Integer red)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public java.lang.Integer getGreen()
public void setGreen(java.lang.Integer green)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public java.lang.Integer getBlue()
public void setBlue(java.lang.Integer blue)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public java.lang.Integer getAlpha()
public void setAlpha(java.lang.Integer alpha)
@Field(index=TOKENIZED) @Field(index=TOKENIZED,analyzer=@Analyzer(impl=ConfiguredAnalyzer.class),name="combined_fields") public java.lang.String getLookupTable()
public void setLookupTable(java.lang.String lookupTable)
protected java.util.List<CodomainMapContext> getSpatialDomainEnhancement()
protected void setSpatialDomainEnhancement(java.util.List<CodomainMapContext> spatialDomainEnhancement)
public int sizeOfSpatialDomainEnhancement()
public java.util.Iterator<CodomainMapContext> iterateSpatialDomainEnhancement()
EmptyIterator
. To test for a null collection,
see of sizeOfSpatialDomainEnhancement()
is less than zero.public java.util.Collection<CodomainMapContext> unmodifiableSpatialDomainEnhancement()
public <E> java.util.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(java.util.Collection<CodomainMapContext> targets)
public void removeCodomainMapContext(CodomainMapContext target)
public void removeCodomainMapContextSet(java.util.Collection<CodomainMapContext> targets)
public void clearSpatialDomainEnhancement()
public CodomainMapContext getCodomainMapContext(int index) throws java.lang.IndexOutOfBoundsException
java.lang.IndexOutOfBoundsException
public CodomainMapContext setCodomainMapContext(int index, CodomainMapContext element) throws java.lang.IndexOutOfBoundsException
List.set(int, Object)
contract. To extend the list, use addCodomainMapContext(CodomainMapContext)
.java.lang.IndexOutOfBoundsException
List.set(int, Object)
public CodomainMapContext getPrimaryCodomainMapContext() throws java.lang.IndexOutOfBoundsException
IndexOutOfBoundsException
is throws. This method
will also throw an ApiUsageException
if the collection is
unloaded. See sizeOfSpatialDomainEnhancement()
for more information.java.lang.IndexOutOfBoundsException
public CodomainMapContext setPrimaryCodomainMapContext(CodomainMapContext element) throws java.lang.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.java.lang.IndexOutOfBoundsException
public Details getDetails()
Details
type.getDetails
in interface IObject
protected void setDetails(Details details)
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 java.lang.String toString()
toString
in class java.lang.Object
public java.util.Set<java.lang.String> fields()
IObject
public java.lang.Object retrieve(java.lang.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(java.lang.String field, java.lang.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(java.lang.String propertyName)