ome.model.meta

Class Session

java.lang.Object

ome.model.meta.Session

All Implemented Interfaces:

java.io.Serializable, IAnnotated, IGlobal, IMutable, IObject, Filterable

Direct Known Subclasses:

Share

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Session.Details

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	_dynamicFields
protected boolean	_loaded
protected java.util.Set<SessionAnnotationLink>	annotationLinks
static java.lang.String	ANNOTATIONLINKS
static java.lang.String	ANNOTATIONLINKSCOUNTPEROWNER
protected java.sql.Timestamp	closed
static java.lang.String	CLOSED
protected java.lang.String	defaultEventType
static java.lang.String	DEFAULTEVENTTYPE
protected Details	details
static java.lang.String	DETAILS
static java.lang.String	EVENT_FILTER_ANNOTATIONLINKS
protected java.util.Set<Event>	events
static java.lang.String	EVENTS
static java.util.Set<java.lang.String>	FIELDS
static java.lang.String	GROUP_FILTER_ANNOTATIONLINKS
protected java.lang.Long	id
static java.lang.String	ID
protected java.lang.String	message
static java.lang.String	MESSAGE
protected Node	node
static java.lang.String	NODE
protected Experimenter	owner
static java.lang.String	OWNER
static java.lang.String	OWNER_FILTER_ANNOTATIONLINKS
static java.lang.String	PERMS_FILTER_ANNOTATIONLINKS
protected java.sql.Timestamp	started
static java.lang.String	STARTED
protected Experimenter	sudoer
static java.lang.String	SUDOER
protected java.lang.Long	timeToIdle
static java.lang.String	TIMETOIDLE
protected java.lang.Long	timeToLive
static java.lang.String	TIMETOLIVE
protected java.lang.String	userAgent
static java.lang.String	USERAGENT
protected java.lang.String	userIP
static java.lang.String	USERIP
protected java.lang.String	uuid
static java.lang.String	UUID
protected java.lang.Integer	version
static java.lang.String	VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	Session()
protected	Session(java.lang.Long id)
	Session(java.lang.Long id, boolean loaded) Main constructor.
	Session(Node _node, java.lang.String _uuid, Experimenter _owner, java.lang.Long _timeToIdle, java.lang.Long _timeToLive, java.sql.Timestamp _started, java.lang.String _defaultEventType)

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
void	addEvent(Event target) use instead of setEvents .
void	addEventSet(java.util.Collection<Event> targets) use like addEvent.
void	addSessionAnnotationLink(SessionAnnotationLink target) use instead of setAnnotationLinks .
void	addSessionAnnotationLink(SessionAnnotationLink link, boolean bothSides) Adds a ome.model.annotations.SessionAnnotationLink to annotationLinks, allowing for recursion -- whether or not addSessionAnnotationLink will be called on the addition if it is loaded
void	addSessionAnnotationLinkSet(java.util.Collection<SessionAnnotationLink> targets) use like addSessionAnnotationLink.
void	clearAnnotationLinks() clears the set.
void	clearEvents() clears the set.
<E> java.util.List<E>	collectAnnotationLinks(CBlock<E> block) takes a CBlock and calls the block once for each ome.model.annotations.SessionAnnotationLink while collecting the results.
<E> java.util.List<E>	collectEvents(CBlock<E> block) takes a CBlock and calls the block once for each ome.model.meta.Event while collecting the results.
<E> java.util.List<E>	eachLinkedAnnotation(CBlock<E> block) takes a CBlock and calls the block once for each ome.model.annotations.Annotation 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.util.Set<SessionAnnotationLink>	findSessionAnnotationLink(Annotation target) find all ome.model.annotations.SessionAnnotationLink which have the argument as their child.
protected java.util.Set<SessionAnnotationLink>	getAnnotationLinks() returns annotationLinks .
java.util.Map<java.lang.Long,java.lang.Long>	getAnnotationLinksCountPerOwner() If fetched, returns the count(*) of ome.model.annotations.SessionAnnotationLink that a user has.
java.sql.Timestamp	getClosed() Simple field ome.model.meta.Session.closed (java.sql.Timestamp)
java.lang.String	getDefaultEventType() Simple field ome.model.meta.Session.defaultEventType (java.lang.String)
Details	getDetails() The details of this object correspond to low-level system information.
protected java.util.Set<Event>	getEvents() returns events .
GraphHolder	getGraphHolder() retrieves the GraphHolder for this entity.
java.lang.Long	getId() The DB unique identifier for this object.
java.lang.String	getMessage() Simple field ome.model.meta.Session.message (java.lang.String)
Node	getNode() Many-to-one field ome.model.meta.Session.node (ome.model.meta.Node)
Experimenter	getOwner() Many-to-one field ome.model.meta.Session.owner (ome.model.meta.Experimenter)
java.sql.Timestamp	getStarted() Simple field ome.model.meta.Session.started (java.sql.Timestamp)
Experimenter	getSudoer() Many-to-one field ome.model.meta.Session.sudoer (ome.model.meta.Experimenter)
java.lang.Long	getTimeToIdle() Simple field ome.model.meta.Session.timeToIdle (java.lang.Long)
java.lang.Long	getTimeToLive() Simple field ome.model.meta.Session.timeToLive (java.lang.Long)
java.lang.String	getUserAgent() Simple field ome.model.meta.Session.userAgent (java.lang.String)
java.lang.String	getUserIP() Simple field ome.model.meta.Session.userIP (java.lang.String)
java.lang.String	getUuid() Simple field ome.model.meta.Session.uuid (java.lang.String)
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<SessionAnnotationLink>	iterateAnnotationLinks() should be used rather than accessing the annotationLinks set directly.
java.util.Iterator<Event>	iterateEvents() should be used rather than accessing the events set directly.
SessionAnnotationLink	linkAnnotation(Annotation addition) Adds a ome.model.annotations.SessionAnnotationLink to annotationLinks .
java.util.Iterator<Annotation>	linkedAnnotationIterator() provides an iterator over the parent values of the annotationLinks.
java.util.List<Annotation>	linkedAnnotationList() produces a List-copy of the underlying collection.
Session	newInstance()
Session	proxy()
void	putAt(java.lang.String field, java.lang.Object value) stores a value in this instance.
void	removeEvent(Event target) removes a single element from this set and makes the inverse call on ome.model.meta.Event
void	removeEventSet(java.util.Collection<Event> targets) use like removeEvent
void	removeSessionAnnotationLink(SessionAnnotationLink target) removes a single element from this set and makes the inverse call on ome.model.annotations.SessionAnnotationLink
void	removeSessionAnnotationLink(SessionAnnotationLink link, boolean bothSides) removes the given SessionAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkSession again if loaded.
void	removeSessionAnnotationLinkSet(java.util.Collection<SessionAnnotationLink> targets) use like removeSessionAnnotationLink
java.lang.Object	retrieve(java.lang.String field) retrieves a value from this instance.
protected void	setAnnotationLinks(java.util.Set<SessionAnnotationLink> annotationLinks) setter for annotationLinks should be avoided.
protected void	setAnnotationLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)
void	setClosed(java.sql.Timestamp closed)
void	setDefaultEventType(java.lang.String defaultEventType)
protected void	setDetails(Details details) Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the Session.Details instance instead.
protected void	setEvents(java.util.Set<Event> events) setter for events should be avoided.
void	setId(java.lang.Long id) usually unneeded.
void	setMessage(java.lang.String message)
void	setNode(Node node)
void	setOwner(Experimenter owner)
void	setStarted(java.sql.Timestamp started)
void	setSudoer(Experimenter sudoer)
void	setTimeToIdle(java.lang.Long timeToIdle)
void	setTimeToLive(java.lang.Long timeToLive)
void	setUserAgent(java.lang.String userAgent)
void	setUserIP(java.lang.String userIP)
void	setUuid(java.lang.String uuid)
void	setVersion(java.lang.Integer version) use with caution.
int	sizeOfAnnotationLinks() returns the size of annotationLinks.
int	sizeOfEvents() returns the size of events.
protected void	throwNullCollectionException(java.lang.String propertyName)
java.lang.String	toString()
void	unlinkAnnotation(Annotation removal) unlinks all ome.model.annotations.Annotation instances from this instance.
void	unload() set the loaded field to false, and set all non-ID fields to null.
java.util.Collection<SessionAnnotationLink>	unmodifiableAnnotationLinks() Returns an unmodifiable collection-view
java.util.Collection<Event>	unmodifiableEvents() 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

ID

public static final java.lang.String ID

See Also:

Constant Field Values

id

protected java.lang.Long id

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

version

protected java.lang.Integer version

node

protected Node node

uuid

protected java.lang.String uuid

owner

protected Experimenter owner

sudoer

protected Experimenter sudoer

timeToIdle

protected java.lang.Long timeToIdle

timeToLive

protected java.lang.Long timeToLive

started

protected java.sql.Timestamp started

closed

protected java.sql.Timestamp closed

message

protected java.lang.String message

defaultEventType

protected java.lang.String defaultEventType

userAgent

protected java.lang.String userAgent

userIP

protected java.lang.String userIP

events

protected java.util.Set<Event> events

annotationLinks

protected java.util.Set<SessionAnnotationLink> annotationLinks

OWNER_FILTER_ANNOTATIONLINKS

public static final java.lang.String OWNER_FILTER_ANNOTATIONLINKS

See Also:

Constant Field Values

GROUP_FILTER_ANNOTATIONLINKS

public static final java.lang.String GROUP_FILTER_ANNOTATIONLINKS

See Also:

Constant Field Values

EVENT_FILTER_ANNOTATIONLINKS

public static final java.lang.String EVENT_FILTER_ANNOTATIONLINKS

See Also:

Constant Field Values

PERMS_FILTER_ANNOTATIONLINKS

public static final java.lang.String PERMS_FILTER_ANNOTATIONLINKS

See Also:

Constant Field Values

details

protected Details details

NODE

public static final java.lang.String NODE

See Also:

Constant Field Values

UUID

public static final java.lang.String UUID

See Also:

Constant Field Values

OWNER

public static final java.lang.String OWNER

See Also:

Constant Field Values

SUDOER

public static final java.lang.String SUDOER

See Also:

Constant Field Values

TIMETOIDLE

public static final java.lang.String TIMETOIDLE

See Also:

Constant Field Values

TIMETOLIVE

public static final java.lang.String TIMETOLIVE

See Also:

Constant Field Values

STARTED

public static final java.lang.String STARTED

See Also:

Constant Field Values

CLOSED

public static final java.lang.String CLOSED

See Also:

Constant Field Values

MESSAGE

public static final java.lang.String MESSAGE

See Also:

Constant Field Values

DEFAULTEVENTTYPE

public static final java.lang.String DEFAULTEVENTTYPE

See Also:

Constant Field Values

USERAGENT

public static final java.lang.String USERAGENT

See Also:

Constant Field Values

USERIP

public static final java.lang.String USERIP

See Also:

Constant Field Values

EVENTS

public static final java.lang.String EVENTS

See Also:

Constant Field Values

ANNOTATIONLINKSCOUNTPEROWNER

public static final java.lang.String ANNOTATIONLINKSCOUNTPEROWNER

See Also:

Constant Field Values

ANNOTATIONLINKS

public static final java.lang.String ANNOTATIONLINKS

See Also:

Constant Field Values

DETAILS

public static final java.lang.String DETAILS

See Also:

Constant Field Values

FIELDS

public static final java.util.Set<java.lang.String> FIELDS

_dynamicFields

protected java.util.Map<java.lang.String,java.lang.Object> _dynamicFields

_loaded

protected boolean _loaded

Constructor Detail

Session

public Session()

Session

protected Session(java.lang.Long id)

Session

public Session(java.lang.Long id,
               boolean loaded)

Main constructor.

Session

public Session(Node _node,
               java.lang.String _uuid,
               Experimenter _owner,
               java.lang.Long _timeToIdle,
               java.lang.Long _timeToLive,
               java.sql.Timestamp _started,
               java.lang.String _defaultEventType)

Method Detail

getId

@DocumentId
public java.lang.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(java.lang.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 java.lang.Integer getVersion()

This version number is controlled by the database for optimisitic locking.

Specified by:

getVersion in interface IMutable

setVersion

public void setVersion(java.lang.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.

getNode

public Node getNode()

Many-to-one field ome.model.meta.Session.node (ome.model.meta.Node)

setNode

public void setNode(Node node)

getUuid

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public java.lang.String getUuid()

Simple field ome.model.meta.Session.uuid (java.lang.String)

setUuid

public void setUuid(java.lang.String uuid)

getOwner

public Experimenter getOwner()

Many-to-one field ome.model.meta.Session.owner (ome.model.meta.Experimenter)

setOwner

public void setOwner(Experimenter owner)

getSudoer

public Experimenter getSudoer()

Many-to-one field ome.model.meta.Session.sudoer (ome.model.meta.Experimenter)

setSudoer

public void setSudoer(Experimenter sudoer)

getTimeToIdle

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Long getTimeToIdle()

Simple field ome.model.meta.Session.timeToIdle (java.lang.Long)

setTimeToIdle

public void setTimeToIdle(java.lang.Long timeToIdle)

getTimeToLive

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Long getTimeToLive()

Simple field ome.model.meta.Session.timeToLive (java.lang.Long)

setTimeToLive

public void setTimeToLive(java.lang.Long timeToLive)

getStarted

@DateBridge(resolution=MINUTE)
 @Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.sql.Timestamp getStarted()

Simple field ome.model.meta.Session.started (java.sql.Timestamp)

setStarted

public void setStarted(java.sql.Timestamp started)

getClosed

@DateBridge(resolution=MINUTE)
 @Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.sql.Timestamp getClosed()

Simple field ome.model.meta.Session.closed (java.sql.Timestamp)

setClosed

public void setClosed(java.sql.Timestamp closed)

getMessage

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public java.lang.String getMessage()

Simple field ome.model.meta.Session.message (java.lang.String)

setMessage

public void setMessage(java.lang.String message)

getDefaultEventType

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public java.lang.String getDefaultEventType()

Simple field ome.model.meta.Session.defaultEventType (java.lang.String)

setDefaultEventType

public void setDefaultEventType(java.lang.String defaultEventType)

getUserAgent

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public java.lang.String getUserAgent()

Simple field ome.model.meta.Session.userAgent (java.lang.String)

setUserAgent

public void setUserAgent(java.lang.String userAgent)

getUserIP

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public java.lang.String getUserIP()

Simple field ome.model.meta.Session.userIP (java.lang.String)

setUserIP

public void setUserIP(java.lang.String userIP)

getEvents

protected java.util.Set<Event> getEvents()

returns events . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.meta.Session.events (ome.model.meta.Event)

setEvents

protected void setEvents(java.util.Set<Event> events)

setter for events should be avoided. Does not fulfill normal semantics.

sizeOfEvents

public int sizeOfEvents()

returns the size of events. If less than zero, the Set was null.

iterateEvents

public java.util.Iterator<Event> iterateEvents()

should be used rather than accessing the events set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfEvents() is less than zero.

unmodifiableEvents

public java.util.Collection<Event> unmodifiableEvents()

Returns an unmodifiable collection-view

collectEvents

public <E> java.util.List<E> collectEvents(CBlock<E> block)

takes a CBlock and calls the block once for each ome.model.meta.Event while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateEvents() internally and so will return a value even if the underlying collection is null.

addEvent

public void addEvent(Event target)

use instead of setEvents . Makes the necessary call on ome.model.meta.Event as well.

addEventSet

public void addEventSet(java.util.Collection<Event> targets)

use like addEvent.

removeEvent

public void removeEvent(Event target)

removes a single element from this set and makes the inverse call on ome.model.meta.Event

removeEventSet

public void removeEventSet(java.util.Collection<Event> targets)

use like removeEvent

clearEvents

public void clearEvents()

clears the set.

getAnnotationLinks

protected java.util.Set<SessionAnnotationLink> getAnnotationLinks()

returns annotationLinks . You should not modify this collection unless you know what you are doing. Use the iterate method instead. one-to-many Set ome.model.meta.Session.annotationLinks (ome.model.annotations.SessionAnnotationLink)

setAnnotationLinks

protected void setAnnotationLinks(java.util.Set<SessionAnnotationLink> annotationLinks)

setter for annotationLinks should be avoided. Does not fulfill normal semantics.

sizeOfAnnotationLinks

public int sizeOfAnnotationLinks()

returns the size of annotationLinks. If less than zero, the Set was null.

Specified by:

sizeOfAnnotationLinks in interface IAnnotated

iterateAnnotationLinks

public java.util.Iterator<SessionAnnotationLink> iterateAnnotationLinks()

should be used rather than accessing the annotationLinks set directly. This method will never return null, but rather will return an instance of EmptyIterator. To test for a null collection, see of sizeOfAnnotationLinks() is less than zero.

Specified by:

iterateAnnotationLinks in interface IAnnotated

unmodifiableAnnotationLinks

public java.util.Collection<SessionAnnotationLink> unmodifiableAnnotationLinks()

Returns an unmodifiable collection-view

Specified by:

unmodifiableAnnotationLinks in interface IAnnotated

collectAnnotationLinks

public <E> java.util.List<E> collectAnnotationLinks(CBlock<E> block)

takes a CBlock and calls the block once for each ome.model.annotations.SessionAnnotationLink while collecting the results. If block == null, then the iterator values themselves are collected. This method uses iterateAnnotationLinks() internally and so will return a value even if the underlying collection is null.

Specified by:

collectAnnotationLinks in interface IAnnotated

addSessionAnnotationLink

public void addSessionAnnotationLink(SessionAnnotationLink target)

use instead of setAnnotationLinks . Makes the necessary call on ome.model.annotations.SessionAnnotationLink as well.

addSessionAnnotationLinkSet

public void addSessionAnnotationLinkSet(java.util.Collection<SessionAnnotationLink> targets)

use like addSessionAnnotationLink.

removeSessionAnnotationLink

public void removeSessionAnnotationLink(SessionAnnotationLink target)

removes a single element from this set and makes the inverse call on ome.model.annotations.SessionAnnotationLink

removeSessionAnnotationLinkSet

public void removeSessionAnnotationLinkSet(java.util.Collection<SessionAnnotationLink> targets)

use like removeSessionAnnotationLink

linkAnnotation

public SessionAnnotationLink linkAnnotation(Annotation addition)

Adds a ome.model.annotations.SessionAnnotationLink to annotationLinks . This entails changing our annotationLinks Set, creating a new ome.model.annotations.SessionAnnotationLink and calling linkAnnotation on the ome.model.annotations.Annotation.

Specified by:

linkAnnotation in interface IAnnotated

addSessionAnnotationLink

public void addSessionAnnotationLink(SessionAnnotationLink link,
                                     boolean bothSides)

Adds a ome.model.annotations.SessionAnnotationLink to annotationLinks, allowing for recursion -- whether or not addSessionAnnotationLink will be called on the addition if it is loaded

linkedAnnotationIterator

public java.util.Iterator<Annotation> linkedAnnotationIterator()

provides an iterator over the parent values of the annotationLinks. Like with most Collection iterators, modifications to the underlying collection while iterating will result in an ConcurrentModificationException. Use linkedAnnotationList() instead.

Specified by:

linkedAnnotationIterator in interface IAnnotated

findSessionAnnotationLink

public java.util.Set<SessionAnnotationLink> findSessionAnnotationLink(Annotation target)

find all ome.model.annotations.SessionAnnotationLink which have the argument as their child.

linkedAnnotationList

public java.util.List<Annotation> linkedAnnotationList()

produces a List-copy of the underlying collection. Unlike, linkedAnnotationIterator(), while using the returned List, modifications can be made to the underlying collection without throwing ConcurrentModificationException.

Specified by:

linkedAnnotationList in interface IAnnotated

eachLinkedAnnotation

public <E> java.util.List<E> eachLinkedAnnotation(CBlock<E> block)

takes a CBlock and calls the block once for each ome.model.annotations.Annotation while collecting the results. If block == null, then the iterator values themselves are collected.

Specified by:

eachLinkedAnnotation in interface IAnnotated

unlinkAnnotation

public void unlinkAnnotation(Annotation removal)

unlinks all ome.model.annotations.Annotation instances from this instance.

Specified by:

unlinkAnnotation in interface IAnnotated

removeSessionAnnotationLink

public void removeSessionAnnotationLink(SessionAnnotationLink link,
                                        boolean bothSides)

removes the given SessionAnnotationLink from annotationLinks, allowing for recursion -- whether or not the removal will call unlinkSession again if loaded.

clearAnnotationLinks

public void clearAnnotationLinks()

clears the set.

Specified by:

clearAnnotationLinks in interface IAnnotated

setAnnotationLinksCountPerOwner

protected void setAnnotationLinksCountPerOwner(java.util.Map<java.lang.Long,java.lang.Long> map)

getAnnotationLinksCountPerOwner

public java.util.Map<java.lang.Long,java.lang.Long> getAnnotationLinksCountPerOwner()

If fetched, returns the count(*) of ome.model.annotations.SessionAnnotationLink that a user has. If unfetched, returns null. No entries in the collection should be null.

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

proxy

public Session proxy()

acceptFilter

public boolean acceptFilter(Filter __filter)

Specified by:

acceptFilter in interface Filterable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

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

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

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(java.lang.String propertyName)