RenderingDef (OMERO (OME Remote Objects) Server)

java.lang.Object
- ome.model.display.RenderingDef

All Implemented Interfaces:

Serializable, IMutable, IObject, Filterable
```
@Entity
@Indexed(index="FullText")
@ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class RenderingDef
extends Object
implements Serializable, IObject, IMutable
```
These filter definitions are used by the security system to eliminate non-readable objects from queries. The regular user does not need to worry about them, as they will be injected directly into the SQL (not HQL)

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RenderingDef.Details

Nested Classes
Modifier and Type	Class and Description
`static class`	`RenderingDef.Details`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`_dynamicFields`
`protected boolean`	`_loaded`
`protected Double`	`compression`
`static String`	`COMPRESSION`
`protected Integer`	`defaultT`
`static String`	`DEFAULTT`
`protected Integer`	`defaultZ`
`static String`	`DEFAULTZ`
`protected Details`	`details`
`static String`	`DETAILS`
`static String`	`EVENT_FILTER`
`static String`	`EVENT_FILTER_SPATIALDOMAINENHANCEMENT`
`static String`	`EVENT_FILTER_WAVERENDERING`
`static Set<String>`	`FIELDS`
`static String`	`GROUP_FILTER`
`static String`	`GROUP_FILTER_SPATIALDOMAINENHANCEMENT`
`static String`	`GROUP_FILTER_WAVERENDERING`
`protected Long`	`id`
`static String`	`ID`
`protected RenderingModel`	`model`
`static String`	`MODEL`
`protected String`	`name`
`static String`	`NAME`
`static String`	`OWNER_FILTER`
`static String`	`OWNER_FILTER_SPATIALDOMAINENHANCEMENT`
`static String`	`OWNER_FILTER_WAVERENDERING`
`static String`	`PERMS_FILTER`
`static String`	`PERMS_FILTER_SPATIALDOMAINENHANCEMENT`
`static String`	`PERMS_FILTER_WAVERENDERING`
`protected Pixels`	`pixels`
`static String`	`PIXELS`
`protected QuantumDef`	`quantization`
`static String`	`QUANTIZATION`
`protected List<CodomainMapContext>`	`spatialDomainEnhancement`
`static String`	`SPATIALDOMAINENHANCEMENT`
`protected Integer`	`version`
`static String`	`VERSION`
`protected List<ChannelBinding>`	`waveRendering`
`static String`	`WAVERENDERING`

Constructor Summary

Constructors
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)`

Method Summary

Methods
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`	`addCodomainMapContext(CodomainMapContext target)` use instead of setSpatialDomainEnhancement .
`void`	`addCodomainMapContextSet(Collection<CodomainMapContext> targets)` use like addCodomainMapContext.
`void`	`clearSpatialDomainEnhancement()` clears the set.
`void`	`clearWaveRendering()` 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.
`<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.
`CodomainMapContext`	`getCodomainMapContext(int index)` Gets the ome.model.display.CodomainMapContext 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.
`CodomainMapContext`	`getPrimaryCodomainMapContext()` Gets the first element of spatialDomainEnhancement which can be interpreted as the primary or default element in some situations.
`QuantumDef`	`getQuantization()` Many-to-one field ome.model.display.RenderingDef.quantization (ome.model.display.QuantumDef)
`protected List<CodomainMapContext>`	`getSpatialDomainEnhancement()` returns spatialDomainEnhancement .
`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<CodomainMapContext>`	`iterateSpatialDomainEnhancement()` should be used rather than accessing the spatialDomainEnhancement 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`	`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.
`ChannelBinding`	`setChannelBinding(int index, ChannelBinding element)` Sets the ome.model.display.ChannelBinding at the given index.
`CodomainMapContext`	`setCodomainMapContext(int index, CodomainMapContext element)` Sets the ome.model.display.CodomainMapContext 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.
`CodomainMapContext`	`setPrimaryCodomainMapContext(CodomainMapContext element)` Swaps the first element of spatialDomainEnhancement with the first instance of the given element.
`void`	`setQuantization(QuantumDef quantization)`
`protected void`	`setSpatialDomainEnhancement(List<CodomainMapContext> spatialDomainEnhancement)` setter for spatialDomainEnhancement should be avoided.
`void`	`setVersion(Integer version)` use with caution.
`protected void`	`setWaveRendering(List<ChannelBinding> waveRendering)` setter for waveRendering should be avoided.
`int`	`sizeOfSpatialDomainEnhancement()` returns the size of spatialDomainEnhancement.
`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<CodomainMapContext>`	`unmodifiableSpatialDomainEnhancement()` 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - OWNER_FILTER
```
public static final String OWNER_FILTER
```
    See Also:
    Constant Field Values
  - GROUP_FILTER
```
public static final String GROUP_FILTER
```
    See Also:
    Constant Field Values
  - EVENT_FILTER
```
public static final String EVENT_FILTER
```
    See Also:
    Constant Field Values
  - PERMS_FILTER
```
public static final String PERMS_FILTER
```
    See Also:
    Constant Field Values
  - ID
```
public static final String ID
```
    See Also:
    Constant Field Values
  - id
```
protected Long id
```
  - VERSION
```
public static final String VERSION
```
    See Also:
    Constant Field Values
  - version
```
protected Integer version
```
  - pixels
```
protected Pixels pixels
```
  - defaultZ
```
protected Integer defaultZ
```
  - defaultT
```
protected Integer defaultT
```
  - model
```
protected RenderingModel model
```
  - waveRendering
```
protected List<ChannelBinding> waveRendering
```
  - OWNER_FILTER_WAVERENDERING
```
public static final String OWNER_FILTER_WAVERENDERING
```
    See Also:
    Constant Field Values
  - GROUP_FILTER_WAVERENDERING
```
public static final String GROUP_FILTER_WAVERENDERING
```
    See Also:
    Constant Field Values
  - EVENT_FILTER_WAVERENDERING
```
public static final String EVENT_FILTER_WAVERENDERING
```
    See Also:
    Constant Field Values
  - PERMS_FILTER_WAVERENDERING
```
public static final String PERMS_FILTER_WAVERENDERING
```
    See Also:
    Constant Field Values
  - name
```
protected String name
```
  - compression
```
protected Double compression
```
  - quantization
```
protected QuantumDef quantization
```
  - spatialDomainEnhancement
```
protected List<CodomainMapContext> spatialDomainEnhancement
```
  - OWNER_FILTER_SPATIALDOMAINENHANCEMENT
```
public static final String OWNER_FILTER_SPATIALDOMAINENHANCEMENT
```
    See Also:
    Constant Field Values
  - GROUP_FILTER_SPATIALDOMAINENHANCEMENT
```
public static final String GROUP_FILTER_SPATIALDOMAINENHANCEMENT
```
    See Also:
    Constant Field Values
  - EVENT_FILTER_SPATIALDOMAINENHANCEMENT
```
public static final String EVENT_FILTER_SPATIALDOMAINENHANCEMENT
```
    See Also:
    Constant Field Values
  - PERMS_FILTER_SPATIALDOMAINENHANCEMENT
```
public static final String PERMS_FILTER_SPATIALDOMAINENHANCEMENT
```
    See Also:
    Constant Field Values
  - details
```
protected Details details
```
  - PIXELS
```
public static final String PIXELS
```
    See Also:
    Constant Field Values
  - DEFAULTZ
```
public static final String DEFAULTZ
```
    See Also:
    Constant Field Values
  - DEFAULTT
```
public static final String DEFAULTT
```
    See Also:
    Constant Field Values
  - MODEL
```
public static final String MODEL
```
    See Also:
    Constant Field Values
  - WAVERENDERING
```
public static final String WAVERENDERING
```
    See Also:
    Constant Field Values
  - NAME
```
public static final String NAME
```
    See Also:
    Constant Field Values
  - COMPRESSION
```
public static final String COMPRESSION
```
    See Also:
    Constant Field Values
  - QUANTIZATION
```
public static final String QUANTIZATION
```
    See Also:
    Constant Field Values
  - SPATIALDOMAINENHANCEMENT
```
public static final String SPATIALDOMAINENHANCEMENT
```
    See Also:
    Constant Field Values
  - DETAILS
```
public static final String DETAILS
```
    See Also:
    Constant Field Values
  - FIELDS
```
public static final Set<String> FIELDS
```
  - _dynamicFields
```
protected Map<String,Object> _dynamicFields
```
  - _loaded
```
protected boolean _loaded
```
- Constructor Detail
  - RenderingDef
```
public RenderingDef()
```
  - RenderingDef
```
protected RenderingDef(Long id)
```
  - RenderingDef
```
public RenderingDef(Long id,
            boolean loaded)
```
    Main constructor.
  - RenderingDef
```
public RenderingDef(Pixels _pixels,
            Integer _defaultZ,
            Integer _defaultT,
            RenderingModel _model,
            QuantumDef _quantization)
```
- Method Detail
  - getId
```
@DocumentId
public Long getId()
```
    The DB unique identifier for this object. You are not responsible for setting the id; however, it can be useful for creating "unloaded" versions of your objects. Each top-level entity contains an id field of type long. For all objects returned from the server, this value will be non-null, which doesn't necessarily hold for the other fields.
    
    Specified by:
    
    getId in interface IObject
    
    Returns:
    Long primary key. May be null.
  - setId
```
public void setId(Long id)
```
    Description copied from interface: IObject
    
    usually unneeded. Ids are managed by the backend.
    
    Specified by:
    
    setId in interface IObject
    
    Parameters:
    id - Long value for this id.
  - getVersion
```
public Integer getVersion()
```
    This version number is controlled by the database for optimisitic locking.
    
    Specified by:
    
    getVersion in interface IMutable
  - setVersion
```
public void setVersion(Integer version)
```
    Description copied from interface: IMutable
    
    use with caution. In general, the version should only be altered by the backend. In the best case, an exception will be thrown for a version not equal to the current DB value. In the worst (though rare) case, the new version could match the database, and override optimistic lock checks that are supposed to prevent data loss.
    
    Specified by:
    
    setVersion in interface IMutable
    
    Parameters:
    version - Value for this objects version.
  - getPixels
```
public Pixels getPixels()
```
    Many-to-one field ome.model.display.RenderingDef.pixels (ome.model.core.Pixels)
  - setPixels
```
public void setPixels(Pixels pixels)
```
  - getDefaultZ
```
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")})
public Integer getDefaultZ()
```
    Simple field ome.model.display.RenderingDef.defaultZ (java.lang.Integer)
  - setDefaultZ
```
public void setDefaultZ(Integer defaultZ)
```
  - getDefaultT
```
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")})
public Integer getDefaultT()
```
    Simple field ome.model.display.RenderingDef.defaultT (java.lang.Integer)
  - setDefaultT
```
public void setDefaultT(Integer defaultT)
```
  - getModel
```
public RenderingModel getModel()
```
    Many-to-one field ome.model.display.RenderingDef.model (ome.model.enums.RenderingModel)
  - setModel
```
public void setModel(RenderingModel model)
```
  - getWaveRendering
```
protected List<ChannelBinding> getWaveRendering()
```
    returns waveRendering . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many List ome.model.display.RenderingDef.waveRendering (ome.model.display.ChannelBinding) Values are indexed by the column "index" on ome.model.display.ChannelBinding
  - setWaveRendering
```
protected void setWaveRendering(List<ChannelBinding> waveRendering)
```
    setter for waveRendering should be avoided. Does not fulfill normal semantics.
  - sizeOfWaveRendering
```
public int sizeOfWaveRendering()
```
    returns the size of waveRendering. If less than zero, the Set was null.
  - iterateWaveRendering
```
public Iterator<ChannelBinding> iterateWaveRendering()
```
    should be used rather than accessing the waveRendering set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfWaveRendering() is less than zero.
  - unmodifiableWaveRendering
```
public Collection<ChannelBinding> unmodifiableWaveRendering()
```
    Returns an unmodifiable collection-view
  - collectWaveRendering
```
public <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. If 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.
  - addChannelBinding
```
public void addChannelBinding(ChannelBinding target)
```
    use instead of setWaveRendering . Makes the necessary call on ome.model.display.ChannelBinding as well.
  - addChannelBindingSet
```
public void addChannelBindingSet(Collection<ChannelBinding> targets)
```
    use like addChannelBinding.
  - removeChannelBinding
```
public void removeChannelBinding(ChannelBinding target)
```
    removes a single element from this set and makes the inverse call on ome.model.display.ChannelBinding
  - removeChannelBindingSet
```
public void removeChannelBindingSet(Collection<ChannelBinding> targets)
```
    use like removeChannelBinding
  - clearWaveRendering
```
public void clearWaveRendering()
```
    clears the set.
  - getChannelBinding
```
public ChannelBinding getChannelBinding(int index)
                                 throws IndexOutOfBoundsException
```
    Gets the ome.model.display.ChannelBinding at the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - setChannelBinding
```
public ChannelBinding setChannelBinding(int index,
                               ChannelBinding element)
                                 throws IndexOutOfBoundsException
```
    Sets the ome.model.display.ChannelBinding at the given index. Adheres to the List.set(int, Object) contract. To extend the list, use addChannelBinding(ChannelBinding).
    
    Throws:
    
    IndexOutOfBoundsException
    See Also:
    List.set(int, Object)
  - getPrimaryChannelBinding
```
public ChannelBinding getPrimaryChannelBinding()
                                        throws IndexOutOfBoundsException
```
    Gets the first element of waveRendering which can be interpreted as the primary or default element in some situations. If there is not first element, an IndexOutOfBoundsException is throws. This method will also throw an ApiUsageException if the collection is unloaded. See sizeOfWaveRendering() for more information.
    
    Throws:
    
    IndexOutOfBoundsException
  - setPrimaryChannelBinding
```
public ChannelBinding setPrimaryChannelBinding(ChannelBinding element)
                                        throws IndexOutOfBoundsException
```
    Swaps the first element of waveRendering with the first instance of the given element. If the given element is not in the list, an 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.
    
    Throws:
    
    IndexOutOfBoundsException
  - getName
```
@Fields(value={@Field(index=TOKENIZED),@Field(index=TOKENIZED,name="combined_fields")})
public String getName()
```
    Simple field ome.model.display.RenderingDef.name (java.lang.String)
  - setName
```
public void setName(String name)
```
  - getCompression
```
@Fields(value={@Field(index=UN_TOKENIZED),@Field(index=UN_TOKENIZED,name="combined_fields")})
public Double getCompression()
```
    Simple field ome.model.display.RenderingDef.compression (java.lang.Double)
  - setCompression
```
public void setCompression(Double compression)
```
  - getQuantization
```
public QuantumDef getQuantization()
```
    Many-to-one field ome.model.display.RenderingDef.quantization (ome.model.display.QuantumDef)
  - setQuantization
```
public void setQuantization(QuantumDef quantization)
```
  - getSpatialDomainEnhancement
```
protected List<CodomainMapContext> getSpatialDomainEnhancement()
```
    returns spatialDomainEnhancement . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many List ome.model.display.RenderingDef.spatialDomainEnhancement (ome.model.display.CodomainMapContext) Values are indexed by the column "index" on ome.model.display.CodomainMapContext
  - setSpatialDomainEnhancement
```
protected void setSpatialDomainEnhancement(List<CodomainMapContext> spatialDomainEnhancement)
```
    setter for spatialDomainEnhancement should be avoided. Does not fulfill normal semantics.
  - sizeOfSpatialDomainEnhancement
```
public int sizeOfSpatialDomainEnhancement()
```
    returns the size of spatialDomainEnhancement. If less than zero, the Set was null.
  - iterateSpatialDomainEnhancement
```
public Iterator<CodomainMapContext> iterateSpatialDomainEnhancement()
```
    should be used rather than accessing the spatialDomainEnhancement set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfSpatialDomainEnhancement() is less than zero.
  - unmodifiableSpatialDomainEnhancement
```
public Collection<CodomainMapContext> unmodifiableSpatialDomainEnhancement()
```
    Returns an unmodifiable collection-view
  - collectSpatialDomainEnhancement
```
public <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. If 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.
  - addCodomainMapContext
```
public void addCodomainMapContext(CodomainMapContext target)
```
    use instead of setSpatialDomainEnhancement . Makes the necessary call on ome.model.display.CodomainMapContext as well.
  - addCodomainMapContextSet
```
public void addCodomainMapContextSet(Collection<CodomainMapContext> targets)
```
    use like addCodomainMapContext.
  - removeCodomainMapContext
```
public void removeCodomainMapContext(CodomainMapContext target)
```
    removes a single element from this set and makes the inverse call on ome.model.display.CodomainMapContext
  - removeCodomainMapContextSet
```
public void removeCodomainMapContextSet(Collection<CodomainMapContext> targets)
```
    use like removeCodomainMapContext
  - clearSpatialDomainEnhancement
```
public void clearSpatialDomainEnhancement()
```
    clears the set.
  - getCodomainMapContext
```
public CodomainMapContext getCodomainMapContext(int index)
                                         throws IndexOutOfBoundsException
```
    Gets the ome.model.display.CodomainMapContext at the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - setCodomainMapContext
```
public CodomainMapContext setCodomainMapContext(int index,
                                       CodomainMapContext element)
                                         throws IndexOutOfBoundsException
```
    Sets the ome.model.display.CodomainMapContext at the given index. Adheres to the List.set(int, Object) contract. To extend the list, use addCodomainMapContext(CodomainMapContext).
    
    Throws:
    
    IndexOutOfBoundsException
    See Also:
    List.set(int, Object)
  - getPrimaryCodomainMapContext
```
public CodomainMapContext getPrimaryCodomainMapContext()
                                                throws IndexOutOfBoundsException
```
    Gets the first element of spatialDomainEnhancement which can be interpreted as the primary or default element in some situations. If there is not first element, an IndexOutOfBoundsException is throws. This method will also throw an ApiUsageException if the collection is unloaded. See sizeOfSpatialDomainEnhancement() for more information.
    
    Throws:
    
    IndexOutOfBoundsException
  - setPrimaryCodomainMapContext
```
public CodomainMapContext setPrimaryCodomainMapContext(CodomainMapContext element)
                                                throws IndexOutOfBoundsException
```
    Swaps the first element of spatialDomainEnhancement with the first instance of the given element. If the given element is not in the list, an 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.
    
    Throws:
    
    IndexOutOfBoundsException
  - getDetails
```
public Details getDetails()
```
    The details of this object correspond to low-level system information. Owner, permissions, Details is always guaranteed to be non-null, unless the user actively nulls it. Every entity also contains a Detail reference, which doesn't refer to a separate table but rather to a collection of fields collected into a Hibernate "component" which is embedded in the object. HQL queries which refer to the Details component cannot directly fetch the entity like this: select o from Object join fetch o.details but rather each field of the Details instance must be explicitly joined: select o from Object join fetch o.details.owner It should also be noted that not all types have all the fields which are present on Details. For example, select e from Experimenter e join fetch e.details.owner will fail. Experimenter has no owner, for obvious reasons. Note: subclasses of this class will return a subclasse of the Details type.
    
    Specified by:
    
    getDetails in interface IObject
  - setDetails
```
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.
  - isValid
```
public boolean isValid()
```
    Description copied from interface: IObject
    
    calls the class-specific validator for this instance and returns the value from Validation.isValid()
    
    Specified by:
    
    isValid in interface IObject
  - validate
```
public Validation validate()
```
    Description copied from interface: IObject
    
    calls the class-specific validator for this instance and returns the Validation object.
    
    Specified by:
    
    validate in interface IObject
    
    Returns:
    Validation collecting parameter.
  - newInstance
```
public RenderingDef newInstance()
```
  - proxy
```
public RenderingDef proxy()
```
  - acceptFilter
```
public boolean acceptFilter(Filter __filter)
```
    Specified by:
    
    acceptFilter in interface Filterable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fields
```
public Set<String> fields()
```
    Description copied from interface: IObject
    
    returns a Set of field names that belong to this class
    
    Specified by:
    
    fields in interface IObject
  - retrieve
```
public Object retrieve(String field)
```
    Description copied from interface: IObject
    
    retrieves a value from this instance. Values for 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)
    
    Specified by:
    
    retrieve in interface IObject
  - putAt
```
public void putAt(String field,
         Object value)
```
    Description copied from interface: IObject
    
    stores a value in this instance. Values for field which match a field of this instance will be delegated to the accessors. Otherwise, values will be stored in a lazy-loaded map.
    
    Specified by:
    
    putAt in interface IObject
    
    Parameters:
    field - Field name
    value - Any object to be stored.
  - isLoaded
```
public boolean isLoaded()
```
    Description copied from interface: IObject
    
    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.
    
    Specified by:
    
    isLoaded in interface IObject
  - errorIfUnloaded
```
protected void errorIfUnloaded()
```
  - unload
```
public void unload()
```
    Description copied from interface: IObject
    
    set the loaded field to false, and set all non-ID fields to null. Subsequent calls to all accessors other than getId/setId will throw an ApiUsageException
    
    Specified by:
    
    unload in interface IObject
  - getGraphHolder
```
public final GraphHolder getGraphHolder()
```
    Description copied from interface: IObject
    
    retrieves the GraphHolder for this entity. If the GraphHolder has not been actively set, a new one will be instatiated.
    
    Specified by:
    
    getGraphHolder in interface IObject
    
    Returns:
    Non-null GraphHolder
  - throwNullCollectionException
```
protected void throwNullCollectionException(String propertyName)
```

Class RenderingDef

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OWNER_FILTER

GROUP_FILTER

EVENT_FILTER

PERMS_FILTER

ID

id

VERSION

version

pixels

defaultZ

defaultT

model

waveRendering

OWNER_FILTER_WAVERENDERING

GROUP_FILTER_WAVERENDERING

EVENT_FILTER_WAVERENDERING

PERMS_FILTER_WAVERENDERING

name

compression

quantization

spatialDomainEnhancement

OWNER_FILTER_SPATIALDOMAINENHANCEMENT

GROUP_FILTER_SPATIALDOMAINENHANCEMENT

EVENT_FILTER_SPATIALDOMAINENHANCEMENT

PERMS_FILTER_SPATIALDOMAINENHANCEMENT

details

PIXELS

DEFAULTZ

DEFAULTT

MODEL

WAVERENDERING

NAME

COMPRESSION

QUANTIZATION

SPATIALDOMAINENHANCEMENT

DETAILS

FIELDS

_dynamicFields

_loaded

Constructor Detail

RenderingDef

RenderingDef

RenderingDef

RenderingDef

Method Detail

getId

setId

getVersion

setVersion

getPixels

setPixels

getDefaultZ

setDefaultZ

getDefaultT

setDefaultT

getModel

setModel

getWaveRendering

setWaveRendering

sizeOfWaveRendering

iterateWaveRendering

unmodifiableWaveRendering

collectWaveRendering

addChannelBinding

addChannelBindingSet

removeChannelBinding

removeChannelBindingSet

clearWaveRendering

getChannelBinding

setChannelBinding

getPrimaryChannelBinding

setPrimaryChannelBinding

getName