sirius.db.mixing

Class BaseEntity<I>

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.BaseEntity<I>

Type Parameters:

I - the type of the ID used by subclasses

All Implemented Interfaces:

sirius.kernel.di.transformers.Transformable

Direct Known Subclasses:

ElasticEntity, MongoEntity, SQLEntity

public abstract class BaseEntity<I>
extends Mixable

Represents the base class for all entities which can be managed using Mixing.

Each field will become a property, unless it is annotated with Transient.

The framework highly encourages composition over inheritance. Therefore Composite fields will directly result in the equivalent properties required to store the fields declared there. Still inheritance might be useful and is fully supported for both, entities and composites.

What is not supported, is merging distinct subclasses into one table or other weired inheritance methods. Therefore all superclasses should be abstract.

Additionally all Mixins Mixin will be used to add properties to the entity. This is especially useful to extend existing entities from within customizations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Mixing	mixing
static String	NEW Contains the constant used to mark a new (unsaved) entity.
protected Map<Property,Object>	persistedData
protected int	version

Fields inherited from class sirius.db.mixing.Mixable

elastic, mango, oma

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

components

Constructor Summary

Constructors

Constructor and Description
BaseEntity()

Method Summary

Modifier and Type	Method and Description
protected void	assertUnique(Mapping field, Object value, Mapping... within) Ensures that the given value in the given field is unique within the given side constraints.
boolean	equals(Object other) Indicates whether some other object is "equal to" this one.
EntityDescriptor	getDescriptor() Returns the descriptor which maps the entity to the database table.
abstract I	getId() Returns the id of the entity.
String	getIdAsString() Returns a string representation of the entity ID.
abstract <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.
String	getTypeName() Each entity type can be addressed by its class or by a unique name, which is its simple class name in upper case.
String	getUniqueName() Returns an unique name of this entity.
int	getVersion() Returns the version of the entity.
int	hashCode() Returns a hash code value for the object.
boolean	isAnyMappingChanged() Checks whether any Mapping of the current SQLEntity changed.
boolean	isChanged(Mapping... mappingsToCheck) Determines if at least one of the given Mappings were changed in this SQLEntity since it was last fetched from the database.
boolean	isNew() Determines if the entity is new (not yet written to the database).
protected abstract 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	setVersion(int version) Note that only the framework must use this to specify the version of the entity.
String	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

mixing

protected static Mixing mixing

version

protected int version

persistedData

protected Map<Property,Object> persistedData

NEW

public static final String NEW

Contains the constant used to mark a new (unsaved) entity.

See Also:

Constant Field Values

Constructor Detail

BaseEntity

public BaseEntity()

Method Detail

getDescriptor

public EntityDescriptor getDescriptor()

Returns the descriptor which maps the entity to the database table.

Returns:

the ddescriptor which is in charge of checking and mapping the entity to the database

getId

@Nullable
public abstract I getId()

Returns the id of the entity.

Returns:

the id of the entity

isNew

public boolean isNew()

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

Returns:

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

getTypeName

public String getTypeName()

Each entity type can be addressed by its class or by a unique name, which is its simple class name in upper case.

Returns:

the type name of this entity type

See Also:

getUniqueName()

getUniqueName

public final String getUniqueName()

Returns an unique name of this entity.

This unique string representation of this entity is made up of its type along with its id.

Returns:

an unique representation of this entity or an empty string if the entity was not written to the database yet

getMapper

public abstract <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.

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.

isUnique

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

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

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

assertUnique

protected void assertUnique(Mapping field,
                            Object value,
                            Mapping... within)

Ensures that the given value in the given field is unique within the given side constraints.

Parameters:

field - the field to check

value - the value to be unique

within - the side constraints within the value must be unique

Throws:

sirius.kernel.health.HandledException - if the value isn't unique

getIdAsString

public final String getIdAsString()

Returns a string representation of the entity ID.

If the entity is new, "new" will be returned.

Returns:

the entity ID as string or "new" if the entity isNew().

isChanged

public boolean isChanged(Mapping... mappingsToCheck)

Determines if at least one of the given Mappings were changed in this SQLEntity since it was last fetched from the database.

Parameters:

mappingsToCheck - the columns to check whether they were changed

Returns:

true if at least one column was changed, false otherwise

isAnyMappingChanged

public boolean isAnyMappingChanged()

Checks whether any Mapping of the current SQLEntity changed.

Returns:

true if at least one column was changed, false otherwise.

getVersion

public int getVersion()

Returns the version of the entity.

Returns:

the version of the entity

setVersion

public void setVersion(int version)

Note that only the framework must use this to specify the version of the entity.

Parameters:

version - the version of this entity

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 Object

Returns:

a hash code value for this object.

equals

public boolean equals(Object other)

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 hashCode().

Overrides:

equals in class Object

Returns:

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

toString

public String toString()

Overrides:

toString in class Object