ome.model.meta

Class ExternalInfo

java.lang.Object

ome.model.meta.ExternalInfo

All Implemented Interfaces:

java.io.Serializable, IObject, Filterable

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

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	ExternalInfo.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 Details	details
static java.lang.String	DETAILS
protected java.lang.Long	entityId
static java.lang.String	ENTITYID
protected java.lang.String	entityType
static java.lang.String	ENTITYTYPE
static java.lang.String	EVENT_FILTER
static java.util.Set<java.lang.String>	FIELDS
static java.lang.String	GROUP_FILTER
protected java.lang.Long	id
static java.lang.String	ID
protected java.lang.String	lsid
static java.lang.String	LSID
static java.lang.String	OWNER_FILTER
static java.lang.String	PERMS_FILTER
protected java.lang.String	uuid
static java.lang.String	UUID

Constructor Summary

Constructors

Modifier	Constructor and Description
	ExternalInfo()
protected	ExternalInfo(java.lang.Long id)
	ExternalInfo(java.lang.Long id, boolean loaded) Main constructor.
	ExternalInfo(java.lang.Long _entityId, java.lang.String _entityType)

Method Summary

Modifier and Type	Method and Description
boolean	acceptFilter(Filter __filter)
protected void	errorIfUnloaded()
java.util.Set<java.lang.String>	fields() returns a Set of field names that belong to this class
Details	getDetails() The details of this object correspond to low-level system information.
java.lang.Long	getEntityId() Simple field ome.model.meta.ExternalInfo.entityId (java.lang.Long)
java.lang.String	getEntityType() Simple field ome.model.meta.ExternalInfo.entityType (java.lang.String)
GraphHolder	getGraphHolder() retrieves the GraphHolder for this entity.
java.lang.Long	getId() The DB unique identifier for this object.
java.lang.String	getLsid() Simple field ome.model.meta.ExternalInfo.lsid (java.lang.String)
java.lang.String	getUuid() Simple field ome.model.meta.ExternalInfo.uuid (java.lang.String)
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()
ExternalInfo	newInstance()
ExternalInfo	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.
protected void	setDetails(Details details) Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the ExternalInfo.Details instance instead.
void	setEntityId(java.lang.Long entityId)
void	setEntityType(java.lang.String entityType)
void	setId(java.lang.Long id) usually unneeded.
void	setLsid(java.lang.String lsid)
void	setUuid(java.lang.String uuid)
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

ID

public static final java.lang.String ID

See Also:

Constant Field Values

id

protected java.lang.Long id

entityId

protected java.lang.Long entityId

entityType

protected java.lang.String entityType

lsid

protected java.lang.String lsid

uuid

protected java.lang.String uuid

details

protected Details details

ENTITYID

public static final java.lang.String ENTITYID

See Also:

Constant Field Values

ENTITYTYPE

public static final java.lang.String ENTITYTYPE

See Also:

Constant Field Values

LSID

public static final java.lang.String LSID

See Also:

Constant Field Values

UUID

public static final java.lang.String UUID

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

ExternalInfo

public ExternalInfo()

ExternalInfo

protected ExternalInfo(java.lang.Long id)

ExternalInfo

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

Main constructor.

ExternalInfo

public ExternalInfo(java.lang.Long _entityId,
                    java.lang.String _entityType)

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.

getEntityId

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

Simple field ome.model.meta.ExternalInfo.entityId (java.lang.Long)

setEntityId

public void setEntityId(java.lang.Long entityId)

getEntityType

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

Simple field ome.model.meta.ExternalInfo.entityType (java.lang.String)

setEntityType

public void setEntityType(java.lang.String entityType)

getLsid

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

Simple field ome.model.meta.ExternalInfo.lsid (java.lang.String)

setLsid

public void setLsid(java.lang.String lsid)

getUuid

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

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

setUuid

public void setUuid(java.lang.String uuid)

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

proxy

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