@Entity @Indexed(index="FullText") @ClassBridge(name="details", impl=DetailsFieldBridge.class, index=UN_TOKENIZED, store=NO) public class RenderingDef extends Object implements Serializable, IObject, IMutable
Modifier and Type | Class and Description |
---|---|
static class |
RenderingDef.Details |
Modifier | Constructor and Description |
---|---|
|
RenderingDef() |
protected |
RenderingDef(Long id) |
|
RenderingDef(Long id,
boolean loaded)
Main constructor.
|
|
RenderingDef(Pixels _pixels,
Integer _defaultZ,
Integer _defaultT,
RenderingModel _model,
QuantumDef _quantization) |
Modifier and Type | Method and Description |
---|---|
boolean |
acceptFilter(Filter __filter) |
void |
addChannelBinding(ChannelBinding target)
use instead of setWaveRendering .
|
void |
addChannelBindingSet(Collection<ChannelBinding> targets)
use like addChannelBinding.
|
void |
addProjectionDef(ProjectionDef target)
use instead of setProjections .
|
void |
addProjectionDefSet(Collection<ProjectionDef> targets)
use like addProjectionDef.
|
void |
clearProjections()
clears the set.
|
void |
clearWaveRendering()
clears the set.
|
<E> List<E> |
collectProjections(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.display.ProjectionDef while
collecting the results.
|
<E> List<E> |
collectWaveRendering(CBlock<E> block)
takes a CBlock and calls the block once for each ome.model.display.ChannelBinding while
collecting the results.
|
protected void |
errorIfUnloaded() |
Set<String> |
fields()
returns a Set of field names that belong to this class
|
ChannelBinding |
getChannelBinding(int index)
Gets the ome.model.display.ChannelBinding at the given index.
|
Double |
getCompression()
Simple field ome.model.display.RenderingDef.compression (java.lang.Double)
|
Integer |
getDefaultT()
Simple field ome.model.display.RenderingDef.defaultT (java.lang.Integer)
|
Integer |
getDefaultZ()
Simple field ome.model.display.RenderingDef.defaultZ (java.lang.Integer)
|
Details |
getDetails()
The details of this object correspond to low-level system
information.
|
GraphHolder |
getGraphHolder()
retrieves the
GraphHolder for this entity. |
Long |
getId()
The DB unique identifier for this object.
|
RenderingModel |
getModel()
Many-to-one field ome.model.display.RenderingDef.model (ome.model.enums.RenderingModel)
|
String |
getName()
Simple field ome.model.display.RenderingDef.name (java.lang.String)
|
Pixels |
getPixels()
Many-to-one field ome.model.display.RenderingDef.pixels (ome.model.core.Pixels)
|
ChannelBinding |
getPrimaryChannelBinding()
Gets the first element of waveRendering which can be interpreted as the
primary or default element in some situations.
|
ProjectionDef |
getPrimaryProjectionDef()
Gets the first element of projections which can be interpreted as the
primary or default element in some situations.
|
ProjectionDef |
getProjectionDef(int index)
Gets the ome.model.display.ProjectionDef at the given index.
|
protected List<ProjectionDef> |
getProjections()
returns projections .
|
QuantumDef |
getQuantization()
Many-to-one field ome.model.display.RenderingDef.quantization (ome.model.display.QuantumDef)
|
Integer |
getVersion()
This version number is controlled by the database for optimisitic
locking.
|
protected List<ChannelBinding> |
getWaveRendering()
returns waveRendering .
|
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<ProjectionDef> |
iterateProjections()
should be used rather than accessing the projections set directly.
|
Iterator<ChannelBinding> |
iterateWaveRendering()
should be used rather than accessing the waveRendering set directly.
|
RenderingDef |
newInstance() |
RenderingDef |
proxy() |
void |
putAt(String field,
Object value)
stores a value in this instance.
|
void |
removeChannelBinding(ChannelBinding target)
removes a single element from this set and makes the inverse call on ome.model.display.ChannelBinding
|
void |
removeChannelBindingSet(Collection<ChannelBinding> targets)
use like removeChannelBinding
|
void |
removeProjectionDef(ProjectionDef target)
removes a single element from this set and makes the inverse call on ome.model.display.ProjectionDef
|
void |
removeProjectionDefSet(Collection<ProjectionDef> targets)
use like removeProjectionDef
|
Object |
retrieve(String field)
retrieves a value from this instance.
|
ChannelBinding |
setChannelBinding(int index,
ChannelBinding element)
Sets the ome.model.display.ChannelBinding at the given index.
|
void |
setCompression(Double compression) |
void |
setDefaultT(Integer defaultT) |
void |
setDefaultZ(Integer defaultZ) |
protected void |
setDetails(Details details)
Use the
Details.copy(ome.model.internal.Details)
or Details.shallowCopy(ome.model.internal.Details)
methods to set the RenderingDef.Details instance instead. |
void |
setId(Long id)
usually unneeded.
|
void |
setModel(RenderingModel model) |
void |
setName(String name) |
void |
setPixels(Pixels pixels) |
ChannelBinding |
setPrimaryChannelBinding(ChannelBinding element)
Swaps the first element of waveRendering with the first instance of the
given element.
|
ProjectionDef |
setPrimaryProjectionDef(ProjectionDef element)
Swaps the first element of projections with the first instance of the
given element.
|
ProjectionDef |
setProjectionDef(int index,
ProjectionDef element)
Sets the ome.model.display.ProjectionDef at the given index.
|
protected void |
setProjections(List<ProjectionDef> projections)
setter for projections should be avoided.
|
void |
setQuantization(QuantumDef quantization) |
void |
setVersion(Integer version)
use with caution.
|
protected void |
setWaveRendering(List<ChannelBinding> waveRendering)
setter for waveRendering should be avoided.
|
int |
sizeOfProjections()
returns the size of projections.
|
int |
sizeOfWaveRendering()
returns the size of waveRendering.
|
protected void |
throwNullCollectionException(String propertyName) |
String |
toString() |
void |
unload()
set the loaded field to false, and set all non-ID fields to null.
|
Collection<ProjectionDef> |
unmodifiableProjections()
Returns an unmodifiable collection-view
|
Collection<ChannelBinding> |
unmodifiableWaveRendering()
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 Pixels pixels
protected Integer defaultZ
protected Integer defaultT
protected RenderingModel model
protected List<ChannelBinding> waveRendering
public static final String OWNER_FILTER_WAVERENDERING
public static final String GROUP_FILTER_WAVERENDERING
public static final String EVENT_FILTER_WAVERENDERING
public static final String PERMS_FILTER_WAVERENDERING
protected String name
protected Double compression
protected QuantumDef quantization
protected List<ProjectionDef> projections
public static final String OWNER_FILTER_PROJECTIONS
public static final String GROUP_FILTER_PROJECTIONS
public static final String EVENT_FILTER_PROJECTIONS
public static final String PERMS_FILTER_PROJECTIONS
protected Details details
public static final String PIXELS
public static final String DEFAULTZ
public static final String DEFAULTT
public static final String MODEL
public static final String WAVERENDERING
public static final String NAME
public static final String COMPRESSION
public static final String QUANTIZATION
public static final String PROJECTIONS
public static final String DETAILS
protected boolean _loaded
public RenderingDef()
protected RenderingDef(Long id)
public RenderingDef(Long id, boolean loaded)
public RenderingDef(Pixels _pixels, Integer _defaultZ, Integer _defaultT, RenderingModel _model, QuantumDef _quantization)
@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 Pixels getPixels()
public void setPixels(Pixels pixels)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Integer getDefaultZ()
public void setDefaultZ(Integer defaultZ)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Integer getDefaultT()
public void setDefaultT(Integer defaultT)
public RenderingModel getModel()
public void setModel(RenderingModel model)
protected List<ChannelBinding> getWaveRendering()
protected void setWaveRendering(List<ChannelBinding> waveRendering)
public int sizeOfWaveRendering()
public Iterator<ChannelBinding> iterateWaveRendering()
EmptyIterator
. To test for a null collection,
see of sizeOfWaveRendering()
is less than zero.public Collection<ChannelBinding> unmodifiableWaveRendering()
public <E> List<E> collectWaveRendering(CBlock<E> block)
block == null
, then the
iterator values themselves are collected. This method uses
iterateWaveRendering()
internally and so will return a value
even if the underlying collection is null.public void addChannelBinding(ChannelBinding target)
public void addChannelBindingSet(Collection<ChannelBinding> targets)
public void removeChannelBinding(ChannelBinding target)
public void removeChannelBindingSet(Collection<ChannelBinding> targets)
public void clearWaveRendering()
public ChannelBinding getChannelBinding(int index) throws IndexOutOfBoundsException
IndexOutOfBoundsException
public ChannelBinding setChannelBinding(int index, ChannelBinding element) throws IndexOutOfBoundsException
List.set(int, Object)
contract. To extend the list, use addChannelBinding(ChannelBinding)
.IndexOutOfBoundsException
List.set(int, Object)
public ChannelBinding getPrimaryChannelBinding() throws IndexOutOfBoundsException
IndexOutOfBoundsException
is throws. This method
will also throw an ApiUsageException
if the collection is
unloaded. See sizeOfWaveRendering()
for more information.IndexOutOfBoundsException
public ChannelBinding setPrimaryChannelBinding(ChannelBinding element) throws IndexOutOfBoundsException
IndexOutOfBoundsException
will be thrown. Returns the swapped
element. This method
will also throw an ApiUsageException
if the collection is
unloaded. See sizeOfWaveRendering()
for more information.IndexOutOfBoundsException
@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields") public String getName()
public void setName(String name)
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields") public Double getCompression()
public void setCompression(Double compression)
public QuantumDef getQuantization()
public void setQuantization(QuantumDef quantization)
protected List<ProjectionDef> getProjections()
protected void setProjections(List<ProjectionDef> projections)
public int sizeOfProjections()
public Iterator<ProjectionDef> iterateProjections()
EmptyIterator
. To test for a null collection,
see of sizeOfProjections()
is less than zero.public Collection<ProjectionDef> unmodifiableProjections()
public <E> List<E> collectProjections(CBlock<E> block)
block == null
, then the
iterator values themselves are collected. This method uses
iterateProjections()
internally and so will return a value
even if the underlying collection is null.public void addProjectionDef(ProjectionDef target)
public void addProjectionDefSet(Collection<ProjectionDef> targets)
public void removeProjectionDef(ProjectionDef target)
public void removeProjectionDefSet(Collection<ProjectionDef> targets)
public void clearProjections()
public ProjectionDef getProjectionDef(int index) throws IndexOutOfBoundsException
IndexOutOfBoundsException
public ProjectionDef setProjectionDef(int index, ProjectionDef element) throws IndexOutOfBoundsException
List.set(int, Object)
contract. To extend the list, use addProjectionDef(ProjectionDef)
.IndexOutOfBoundsException
List.set(int, Object)
public ProjectionDef getPrimaryProjectionDef() throws IndexOutOfBoundsException
IndexOutOfBoundsException
is throws. This method
will also throw an ApiUsageException
if the collection is
unloaded. See sizeOfProjections()
for more information.IndexOutOfBoundsException
public ProjectionDef setPrimaryProjectionDef(ProjectionDef element) throws IndexOutOfBoundsException
IndexOutOfBoundsException
will be thrown. Returns the swapped
element. This method
will also throw an ApiUsageException
if the collection is
unloaded. See sizeOfProjections()
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 RenderingDef.Details
instance instead.public boolean isValid()
IObject
Validation.isValid()
public Validation validate()
IObject
Validation
object.public RenderingDef newInstance()
public RenderingDef 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.4.0-ice35-b74
Copyright © 2017 The University of Dundee & Open Microscopy Environment. All Rights Reserved.