sirius.db.jdbc

Class SQLEntity

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.BaseEntity<Long>

sirius.db.jdbc.SQLEntity

All Implemented Interfaces:

sirius.kernel.di.transformers.Transformable

public abstract class SQLEntity
extends BaseEntity<Long>

Represents the base class for all entities which are managed via OMA and stored in a JDBC / SQL database.

Field Summary

Fields

Modifier and Type	Field and Description
protected Row	fetchRow
protected long	id
static Mapping	ID Contains the unique ID of the entity.
static long	NON_PERSISTENT_ENTITY_ID Represents the id which signals that the entity was not persisted yet.
protected static OMA	oma

Fields inherited from class sirius.db.mixing.BaseEntity

mixing, NEW, persistedData, version

Fields inherited from class sirius.db.mixing.Mixable

elastic, mango

Fields inherited from class sirius.kernel.di.transformers.Composable

components

Constructor Summary

Constructors

Constructor and Description
SQLEntity()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Indicates whether some other object is "equal to" this one.
Row	getFetchRow() If the entity was created as the result of a TransformedQuery, the original Row is accessible via this method.
Long	getId() Returns the ID of the entity.
<E extends BaseEntity<?>,C extends Constraint,Q extends Query<Q,E,C>> BaseMapper<E,C,Q>	getMapper() Provides the mapper which is used to actually manage the entity.
int	hashCode() Returns a hash code value for the object.
boolean	isNew() Determines if the entity is new (not yet written to the database).
protected boolean	isUnique(Mapping field, Object value, Mapping... within) Determines if the given value in the given field is unique within the given side constraints.
void	setId(long id) Sets the ID of the entity.

Methods inherited from class sirius.db.mixing.BaseEntity

assertUnique, getDescriptor, getIdAsString, getTypeName, getUniqueName, getVersion, isAnyMappingChanged, isChanged, setVersion, toString

Methods inherited from class sirius.db.mixing.Mixable

is, makeNewInstance, tryAs

Methods inherited from class sirius.kernel.di.transformers.Composable

as, attach, attach

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NON_PERSISTENT_ENTITY_ID

public static final long NON_PERSISTENT_ENTITY_ID

Represents the id which signals that the entity was not persisted yet.

See Also:

Constant Field Values

oma

protected static OMA oma

ID

public static final Mapping ID

Contains the unique ID of the entity.

This is automatically assigned by the database. Never assign manually a value unless you are totally aware of what you're doing. Also you should not use this ID for external purposes (e.g. as customer number or invoice number) as it cannot be changed.

This field is marked as transient as this column is automatically managed by the framework.

id

protected long id

fetchRow

protected Row fetchRow

Constructor Detail

SQLEntity

public SQLEntity()

Method Detail

isNew

public boolean isNew()

Description copied from class: BaseEntity

Determines if the entity is new (not yet written to the database).

Overrides:

isNew in class BaseEntity<Long>

Returns:

true if the entity has not been written to the database yes, false otherwise

getMapper

public <E extends BaseEntity<?>,C extends Constraint,Q extends Query<Q,E,C>> BaseMapper<E,C,Q> getMapper()

Description copied from class: BaseEntity

Provides the mapper which is used to actually manage the entity.

Specified by:

getMapper in class BaseEntity<Long>

Type Parameters:

E - the entity type of the mapper

Q - the query type of the mapper

Returns:

the mapper which is in charge of this entity.

getId

public Long getId()

Returns the ID of the entity.

Specified by:

getId in class BaseEntity<Long>

Returns:

the ID of the entity or a negative value if the entity was not written to the database yet

setId

public void setId(long id)

Sets the ID of the entity.

This method must be used very carefully. For normal operations, this method should ne be used at all as the database ID is managed by the framework.

Parameters:

id - the id of the entity in the database

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The hash code of an entity is based on its ID. If the entity is not written to the database yet, we use the hash code as computed by Object.hashCode(). This matches the behaviour of equals(Object).

Overrides:

hashCode in class BaseEntity<Long>

Returns:

a hash code value for this object.

equals

public boolean equals(Object other)

Description copied from class: BaseEntity

Indicates whether some other object is "equal to" this one.

Equality of two entities is based on their type and ID. If an entity is not written to the database yet, we determine equality as computed by Object.equals(Object). This matches the behaviour of BaseEntity.hashCode().

Overrides:

equals in class BaseEntity<Long>

Returns:

true if this object is the same as the obj argument; false otherwise.

isUnique

protected boolean isUnique(Mapping field,
                           Object value,
                           Mapping... within)

Description copied from class: BaseEntity

Determines if the given value in the given field is unique within the given side constraints.

Specified by:

isUnique in class BaseEntity<Long>

Parameters:

field - the field to check

value - the value to be unique

within - the side constraints within the value must be unique

Returns:

true if the given field is unique, false otherwise

getFetchRow

public Row getFetchRow()

If the entity was created as the result of a TransformedQuery, the original Row is accessible via this method.

Returns:

the original row from which the entity was loaded.