ome.model.display

Class ProjectionDef

java.lang.Object

ome.model.display.ProjectionDef

All Implemented Interfaces:

Serializable, IMutable, IObject, Filterable

@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class ProjectionDef
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	ProjectionDef.Details

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	_dynamicFields
protected boolean	_loaded
protected Boolean	active
static String	ACTIVE
protected ProjectionAxis	axis
static String	AXIS
protected Details	details
static String	DETAILS
protected Integer	endPlane
static String	ENDPLANE
static String	EVENT_FILTER
static Set<String>	FIELDS
static String	GROUP_FILTER
protected Long	id
static String	ID
static String	OWNER_FILTER
static String	PERMS_FILTER
protected RenderingDef	renderingDef
static String	RENDERINGDEF
protected Integer	startPlane
static String	STARTPLANE
protected Integer	stepping
static String	STEPPING
protected ProjectionType	type
static String	TYPE
protected Integer	version
static String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	ProjectionDef()
protected	ProjectionDef(Long id)
	ProjectionDef(Long id, boolean loaded) Main constructor.
	ProjectionDef(RenderingDef _renderingDef, ProjectionAxis _axis, ProjectionType _type, Boolean _active)

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
protected void	errorIfUnloaded()
Set<String>	fields() returns a Set of field names that belong to this class
Boolean	getActive() Simple field ome.model.display.ProjectionDef.active (java.lang.Boolean)
ProjectionAxis	getAxis() Many-to-one field ome.model.display.ProjectionDef.axis (ome.model.enums.ProjectionAxis)
Details	getDetails() The details of this object correspond to low-level system information.
Integer	getEndPlane() Simple field ome.model.display.ProjectionDef.endPlane (java.lang.Integer)
GraphHolder	getGraphHolder() retrieves the GraphHolder for this entity.
Long	getId() The DB unique identifier for this object.
RenderingDef	getRenderingDef() Many-to-one field ome.model.display.ProjectionDef.renderingDef (ome.model.display.RenderingDef)
Integer	getStartPlane() Simple field ome.model.display.ProjectionDef.startPlane (java.lang.Integer)
Integer	getStepping() Simple field ome.model.display.ProjectionDef.stepping (java.lang.Integer)
ProjectionType	getType() Many-to-one field ome.model.display.ProjectionDef.type (ome.model.enums.ProjectionType)
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()
ProjectionDef	newInstance()
ProjectionDef	proxy()
void	putAt(String field, Object value) stores a value in this instance.
Object	retrieve(String field) retrieves a value from this instance.
void	setActive(Boolean active)
void	setAxis(ProjectionAxis axis)
protected void	setDetails(Details details) Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the ProjectionDef.Details instance instead.
void	setEndPlane(Integer endPlane)
void	setId(Long id) usually unneeded.
void	setRenderingDef(RenderingDef renderingDef)
void	setStartPlane(Integer startPlane)
void	setStepping(Integer stepping)
void	setType(ProjectionType type)
void	setVersion(Integer version) use with caution.
protected void	throwNullCollectionException(String propertyName)
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 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

renderingDef

protected RenderingDef renderingDef

axis

protected ProjectionAxis axis

type

protected ProjectionType type

active

protected Boolean active

startPlane

protected Integer startPlane

endPlane

protected Integer endPlane

stepping

protected Integer stepping

details

protected Details details

RENDERINGDEF

public static final String RENDERINGDEF

See Also:

Constant Field Values

AXIS

public static final String AXIS

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

ACTIVE

public static final String ACTIVE

See Also:

Constant Field Values

STARTPLANE

public static final String STARTPLANE

See Also:

Constant Field Values

ENDPLANE

public static final String ENDPLANE

See Also:

Constant Field Values

STEPPING

public static final String STEPPING

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

ProjectionDef

public ProjectionDef()

ProjectionDef

protected ProjectionDef(Long id)

ProjectionDef

public ProjectionDef(Long id,
                     boolean loaded)

Main constructor.

ProjectionDef

public ProjectionDef(RenderingDef _renderingDef,
                     ProjectionAxis _axis,
                     ProjectionType _type,
                     Boolean _active)

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.

getRenderingDef

public RenderingDef getRenderingDef()

Many-to-one field ome.model.display.ProjectionDef.renderingDef (ome.model.display.RenderingDef)

setRenderingDef

public void setRenderingDef(RenderingDef renderingDef)

getAxis

public ProjectionAxis getAxis()

Many-to-one field ome.model.display.ProjectionDef.axis (ome.model.enums.ProjectionAxis)

setAxis

public void setAxis(ProjectionAxis axis)

getType

public ProjectionType getType()

Many-to-one field ome.model.display.ProjectionDef.type (ome.model.enums.ProjectionType)

setType

public void setType(ProjectionType type)

getActive

public Boolean getActive()

Simple field ome.model.display.ProjectionDef.active (java.lang.Boolean)

setActive

public void setActive(Boolean active)

getStartPlane

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Integer getStartPlane()

Simple field ome.model.display.ProjectionDef.startPlane (java.lang.Integer)

setStartPlane

public void setStartPlane(Integer startPlane)

getEndPlane

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Integer getEndPlane()

Simple field ome.model.display.ProjectionDef.endPlane (java.lang.Integer)

setEndPlane

public void setEndPlane(Integer endPlane)

getStepping

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public Integer getStepping()

Simple field ome.model.display.ProjectionDef.stepping (java.lang.Integer)

setStepping

public void setStepping(Integer stepping)

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 subclass 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 ProjectionDef.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 ProjectionDef newInstance()

proxy

public ProjectionDef 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)