ome.model.enums

Class Format

java.lang.Object

ome.model.enums.Format

All Implemented Interfaces:

Serializable, IEnum, IGlobal, IObject, Filterable

@Entity
 @Indexed(index="FullText")
 @ClassBridge(name="details",
             impl=DetailsFieldBridge.class,
             index=UN_TOKENIZED,
             store=NO)
public class Format
extends Object
implements Serializable, IObject, IGlobal, IEnum

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Format.Details

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	_dynamicFields
protected boolean	_loaded
protected Details	details
static String	DETAILS
static Set<String>	FIELDS
protected Long	id
static String	ID
protected String	value
static String	VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	Format()
protected	Format(Long id)
	Format(Long id, boolean loaded) Main constructor.
	Format(String value)

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
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.
String	getValue() Simple field ome.model.enums.Format.value (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()
Format	newInstance()
Format	proxy()
void	putAt(String field, Object value) stores a value in this instance.
Object	retrieve(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 Format.Details instance instead.
void	setId(Long id) usually unneeded.
void	setValue(String value)
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

ID

public static final String ID

See Also:

Constant Field Values

id

protected Long id

value

protected String value

details

protected Details details

VALUE

public static final String VALUE

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

Format

public Format()

Format

protected Format(Long id)

Format

public Format(Long id,
              boolean loaded)

Main constructor.

Format

public Format(String value)

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.

getValue

@Field(index=TOKENIZED) @Field(index=TOKENIZED,name="combined_fields")
public String getValue()

Simple field ome.model.enums.Format.value (java.lang.String)

Specified by:

getValue in interface IEnum

setValue

public void setValue(String value)

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

proxy

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