PlaneSlicingContext (omero-model 5.5.0 API)

java.lang.Object
- ome.model.display.CodomainMapContext
- - ome.model.display.PlaneSlicingContext

All Implemented Interfaces:: java.io.Serializable, IMutable, IObject, Filterable

@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class PlaneSlicingContext
extends CodomainMapContext
implements java.io.Serializable, IObject, IMutable

See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class ome.model.display.CodomainMapContext
  CodomainMapContext.Details

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.Boolean`	`constant`
`static java.lang.String`	`CONSTANT`
`static java.lang.String`	`EVENT_FILTER`
`static java.util.Set<java.lang.String>`	`FIELDS`
`static java.lang.String`	`GROUP_FILTER`
`protected java.lang.Integer`	`lowerLimit`
`static java.lang.String`	`LOWERLIMIT`
`static java.lang.String`	`OWNER_FILTER`
`static java.lang.String`	`PERMS_FILTER`
`protected java.lang.Integer`	`planePrevious`
`static java.lang.String`	`PLANEPREVIOUS`
`protected java.lang.Integer`	`planeSelected`
`static java.lang.String`	`PLANESELECTED`
`protected java.lang.Integer`	`upperLimit`
`static java.lang.String`	`UPPERLIMIT`

Fields inherited from class ome.model.display.CodomainMapContext
_dynamicFields, _loaded, channelBinding, CHANNELBINDING, details, DETAILS, id, ID, version, VERSION

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PlaneSlicingContext()`
	`PlaneSlicingContext(java.lang.Integer _upperLimit, java.lang.Integer _lowerLimit, java.lang.Integer _planeSelected, java.lang.Integer _planePrevious, java.lang.Boolean _constant)`
`protected`	`PlaneSlicingContext(java.lang.Long id)`
	`PlaneSlicingContext(java.lang.Long id, boolean loaded)` Main constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptFilter(Filter __filter)`
`java.util.Set<java.lang.String>`	`fields()` returns a Set of field names that belong to this class
`java.lang.Boolean`	`getConstant()` Simple field ome.model.display.PlaneSlicingContext.constant (java.lang.Boolean)
`java.lang.Integer`	`getLowerLimit()` Simple field ome.model.display.PlaneSlicingContext.lowerLimit (java.lang.Integer)
`java.lang.Integer`	`getPlanePrevious()` Simple field ome.model.display.PlaneSlicingContext.planePrevious (java.lang.Integer)
`java.lang.Integer`	`getPlaneSelected()` Simple field ome.model.display.PlaneSlicingContext.planeSelected (java.lang.Integer)
`java.lang.Integer`	`getUpperLimit()` Simple field ome.model.display.PlaneSlicingContext.upperLimit (java.lang.Integer)
`boolean`	`isValid()` calls the class-specific validator for this instance and returns the value from `Validation.isValid()`
`PlaneSlicingContext`	`newInstance()`
`PlaneSlicingContext`	`proxy()`
`void`	`putAt(java.lang.String field, java.lang.Object value)` stores a value in this instance.
`java.lang.Object`	`retrieve(java.lang.String field)` retrieves a value from this instance.
`void`	`setConstant(java.lang.Boolean constant)`
`void`	`setLowerLimit(java.lang.Integer lowerLimit)`
`void`	`setPlanePrevious(java.lang.Integer planePrevious)`
`void`	`setPlaneSelected(java.lang.Integer planeSelected)`
`void`	`setUpperLimit(java.lang.Integer upperLimit)`
`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.
`Validation`	`validate()` calls the class-specific validator for this instance and returns the `Validation` object.

Methods inherited from class ome.model.display.CodomainMapContext
errorIfUnloaded, getChannelBinding, getDetails, getGraphHolder, getId, getVersion, isLoaded, setChannelBinding, setDetails, setId, setVersion

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

Methods inherited from interface ome.model.IMutable
getVersion, setVersion

Methods inherited from interface ome.model.IObject
getDetails, getGraphHolder, getId, isLoaded, setId

- Field Detail
  - OWNER_FILTER
```
public static final java.lang.String OWNER_FILTER
```
    See Also:
    
    Constant Field Values
  - GROUP_FILTER
```
public static final java.lang.String GROUP_FILTER
```
    See Also:
    
    Constant Field Values
  - EVENT_FILTER
```
public static final java.lang.String EVENT_FILTER
```
    See Also:
    
    Constant Field Values
  - PERMS_FILTER
```
public static final java.lang.String PERMS_FILTER
```
    See Also:
    
    Constant Field Values
  - upperLimit
```
protected java.lang.Integer upperLimit
```
  - lowerLimit
```
protected java.lang.Integer lowerLimit
```
  - planeSelected
```
protected java.lang.Integer planeSelected
```
  - planePrevious
```
protected java.lang.Integer planePrevious
```
  - constant
```
protected java.lang.Boolean constant
```
  - UPPERLIMIT
```
public static final java.lang.String UPPERLIMIT
```
    See Also:
    
    Constant Field Values
  - LOWERLIMIT
```
public static final java.lang.String LOWERLIMIT
```
    See Also:
    
    Constant Field Values
  - PLANESELECTED
```
public static final java.lang.String PLANESELECTED
```
    See Also:
    
    Constant Field Values
  - PLANEPREVIOUS
```
public static final java.lang.String PLANEPREVIOUS
```
    See Also:
    
    Constant Field Values
  - CONSTANT
```
public static final java.lang.String CONSTANT
```
    See Also:
    
    Constant Field Values
  - FIELDS
```
public static final java.util.Set<java.lang.String> FIELDS
```
- Constructor Detail
  - PlaneSlicingContext
```
public PlaneSlicingContext()
```
  - PlaneSlicingContext
```
protected PlaneSlicingContext(java.lang.Long id)
```
  - PlaneSlicingContext
```
public PlaneSlicingContext(java.lang.Long id,
                           boolean loaded)
```
    Main constructor.
  - PlaneSlicingContext
```
public PlaneSlicingContext(java.lang.Integer _upperLimit,
                           java.lang.Integer _lowerLimit,
                           java.lang.Integer _planeSelected,
                           java.lang.Integer _planePrevious,
                           java.lang.Boolean _constant)
```
- Method Detail
  - getUpperLimit
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Integer getUpperLimit()
```
    Simple field ome.model.display.PlaneSlicingContext.upperLimit (java.lang.Integer)
  - setUpperLimit
```
public void setUpperLimit(java.lang.Integer upperLimit)
```
  - getLowerLimit
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Integer getLowerLimit()
```
    Simple field ome.model.display.PlaneSlicingContext.lowerLimit (java.lang.Integer)
  - setLowerLimit
```
public void setLowerLimit(java.lang.Integer lowerLimit)
```
  - getPlaneSelected
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Integer getPlaneSelected()
```
    Simple field ome.model.display.PlaneSlicingContext.planeSelected (java.lang.Integer)
  - setPlaneSelected
```
public void setPlaneSelected(java.lang.Integer planeSelected)
```
  - getPlanePrevious
```
@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Integer getPlanePrevious()
```
    Simple field ome.model.display.PlaneSlicingContext.planePrevious (java.lang.Integer)
  - setPlanePrevious
```
public void setPlanePrevious(java.lang.Integer planePrevious)
```
  - getConstant
```
public java.lang.Boolean getConstant()
```
    Simple field ome.model.display.PlaneSlicingContext.constant (java.lang.Boolean)
  - setConstant
```
public void setConstant(java.lang.Boolean constant)
```
  - 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
    
    Overrides:
    
    isValid in class CodomainMapContext
  - 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
    
    Overrides:
    
    validate in class CodomainMapContext
    
    Returns:
    
    Validation collecting parameter.
  - newInstance
```
public PlaneSlicingContext newInstance()
```
  - proxy
```
public PlaneSlicingContext proxy()
```
  - acceptFilter
```
public boolean acceptFilter(Filter __filter)
```
    Specified by:
    
    acceptFilter in interface Filterable
    
    Overrides:
    
    acceptFilter in class CodomainMapContext
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class CodomainMapContext
  - fields
```
public java.util.Set<java.lang.String> fields()
```
    Description copied from interface: IObject
    
    returns a Set of field names that belong to this class
    
    Specified by:
    
    fields in interface IObject
    
    Overrides:
    
    fields in class CodomainMapContext
  - retrieve
```
public java.lang.Object retrieve(java.lang.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
    
    Overrides:
    
    retrieve in class CodomainMapContext
  - putAt
```
public void putAt(java.lang.String field,
                  java.lang.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
    
    Overrides:
    
    putAt in class CodomainMapContext
    
    Parameters:
    
    field - Field name
    
    value - Any object to be stored.
  - 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
    
    Overrides:
    
    unload in class CodomainMapContext
  - throwNullCollectionException
```
protected void throwNullCollectionException(java.lang.String propertyName)
```
    Overrides:
    
    throwNullCollectionException in class CodomainMapContext

Class PlaneSlicingContext

Nested Class Summary

Nested classes/interfaces inherited from class ome.model.display.CodomainMapContext

Field Summary

Fields inherited from class ome.model.display.CodomainMapContext

Constructor Summary

Method Summary

Methods inherited from class ome.model.display.CodomainMapContext

Methods inherited from class java.lang.Object

Methods inherited from interface ome.model.IMutable

Methods inherited from interface ome.model.IObject

Field Detail

OWNER_FILTER

GROUP_FILTER

EVENT_FILTER

PERMS_FILTER

upperLimit

lowerLimit

planeSelected

planePrevious

constant

UPPERLIMIT

LOWERLIMIT

PLANESELECTED

PLANEPREVIOUS

CONSTANT

FIELDS

Constructor Detail

PlaneSlicingContext

PlaneSlicingContext

PlaneSlicingContext

PlaneSlicingContext

Method Detail

getUpperLimit

setUpperLimit

getLowerLimit

setLowerLimit

getPlaneSelected

setPlaneSelected

getPlanePrevious

setPlanePrevious

getConstant

setConstant

isValid

validate

newInstance

proxy

acceptFilter

toString

fields

retrieve

putAt

unload

throwNullCollectionException