ome.model.meta

Class DBPatch

java.lang.Object

ome.model.meta.DBPatch

All Implemented Interfaces:

java.io.Serializable, IGlobal, IObject, Filterable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DBPatch.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.lang.Integer	currentPatch
static java.lang.String	CURRENTPATCH
protected java.lang.String	currentVersion
static java.lang.String	CURRENTVERSION
protected Details	details
static java.lang.String	DETAILS
static java.util.Set<java.lang.String>	FIELDS
protected java.sql.Timestamp	finished
static java.lang.String	FINISHED
protected java.lang.Long	id
static java.lang.String	ID
protected java.lang.String	message
static java.lang.String	MESSAGE
protected java.lang.Integer	previousPatch
static java.lang.String	PREVIOUSPATCH
protected java.lang.String	previousVersion
static java.lang.String	PREVIOUSVERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	DBPatch()
protected	DBPatch(java.lang.Long id)
	DBPatch(java.lang.Long id, boolean loaded) Main constructor.
	DBPatch(java.lang.String _currentVersion, java.lang.Integer _currentPatch, java.lang.String _previousVersion, java.lang.Integer _previousPatch)

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
java.lang.Integer	getCurrentPatch() Simple field ome.model.meta.DBPatch.currentPatch (java.lang.Integer)
java.lang.String	getCurrentVersion() Simple field ome.model.meta.DBPatch.currentVersion (java.lang.String)
Details	getDetails() The details of this object correspond to low-level system information.
java.sql.Timestamp	getFinished() Simple field ome.model.meta.DBPatch.finished (java.sql.Timestamp)
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.DBPatch.message (java.lang.String)
java.lang.Integer	getPreviousPatch() Simple field ome.model.meta.DBPatch.previousPatch (java.lang.Integer)
java.lang.String	getPreviousVersion() Simple field ome.model.meta.DBPatch.previousVersion (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()
DBPatch	newInstance()
DBPatch	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	setCurrentPatch(java.lang.Integer currentPatch)
void	setCurrentVersion(java.lang.String currentVersion)
protected void	setDetails(Details details) Use the Details.copy(ome.model.internal.Details) or Details.shallowCopy(ome.model.internal.Details) methods to set the DBPatch.Details instance instead.
void	setFinished(java.sql.Timestamp finished)
void	setId(java.lang.Long id) usually unneeded.
void	setMessage(java.lang.String message)
void	setPreviousPatch(java.lang.Integer previousPatch)
void	setPreviousVersion(java.lang.String previousVersion)
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

ID

public static final java.lang.String ID

See Also:

Constant Field Values

id

protected java.lang.Long id

currentVersion

protected java.lang.String currentVersion

currentPatch

protected java.lang.Integer currentPatch

previousVersion

protected java.lang.String previousVersion

previousPatch

protected java.lang.Integer previousPatch

finished

protected java.sql.Timestamp finished

message

protected java.lang.String message

details

protected Details details

CURRENTVERSION

public static final java.lang.String CURRENTVERSION

See Also:

Constant Field Values

CURRENTPATCH

public static final java.lang.String CURRENTPATCH

See Also:

Constant Field Values

PREVIOUSVERSION

public static final java.lang.String PREVIOUSVERSION

See Also:

Constant Field Values

PREVIOUSPATCH

public static final java.lang.String PREVIOUSPATCH

See Also:

Constant Field Values

FINISHED

public static final java.lang.String FINISHED

See Also:

Constant Field Values

MESSAGE

public static final java.lang.String MESSAGE

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

DBPatch

public DBPatch()

DBPatch

protected DBPatch(java.lang.Long id)

DBPatch

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

Main constructor.

DBPatch

public DBPatch(java.lang.String _currentVersion,
               java.lang.Integer _currentPatch,
               java.lang.String _previousVersion,
               java.lang.Integer _previousPatch)

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.

getCurrentVersion

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

Simple field ome.model.meta.DBPatch.currentVersion (java.lang.String)

setCurrentVersion

public void setCurrentVersion(java.lang.String currentVersion)

getCurrentPatch

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Integer getCurrentPatch()

Simple field ome.model.meta.DBPatch.currentPatch (java.lang.Integer)

setCurrentPatch

public void setCurrentPatch(java.lang.Integer currentPatch)

getPreviousVersion

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

Simple field ome.model.meta.DBPatch.previousVersion (java.lang.String)

setPreviousVersion

public void setPreviousVersion(java.lang.String previousVersion)

getPreviousPatch

@Field(index=UN_TOKENIZED) @Field(index=UN_TOKENIZED,name="combined_fields")
public java.lang.Integer getPreviousPatch()

Simple field ome.model.meta.DBPatch.previousPatch (java.lang.Integer)

setPreviousPatch

public void setPreviousPatch(java.lang.Integer previousPatch)

getFinished

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

Simple field ome.model.meta.DBPatch.finished (java.sql.Timestamp)

setFinished

public void setFinished(java.sql.Timestamp finished)

getMessage

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

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

setMessage

public void setMessage(java.lang.String message)

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

proxy

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