org.jminor.framework.domain

Interface Entity

All Superinterfaces:

java.lang.Comparable<Entity>, java.io.Serializable, ValueCollectionProvider<java.lang.Object>, ValueMap<Property,java.lang.Object>, ValueProvider<Property,java.lang.Object>

public interface Entity
extends ValueMap<Property,java.lang.Object>, java.lang.Comparable<Entity>, java.io.Serializable

Represents a row in a database table, providing access to the column values via the ValueMap interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Entity.BackgroundColorProvider Provides background colors for entities.
static interface	Entity.Definition Specifies a entity definition.
static interface	Entity.Key A class representing a primary key.
static interface	Entity.KeyGenerator Generates primary key values for entities on insert.
static interface	Entity.OrderBy Specifies a order by clause
static interface	Entity.ToString Describes an object responsible for providing String representations of entity instances
static interface	Entity.Validator Responsible for providing validation for entities.

Method Summary

Modifier and Type	Method and Description
void	clearKeyValues() Clears the primary key values from this entity, current as well as original values if any
boolean	containsKey(java.lang.String propertyId) Returns true if this Entity contains a value for the given property, that value can be null.
java.lang.Object	get(java.lang.String propertyId)
java.lang.String	getAsString(java.lang.String propertyId) This method returns a String representation of the value associated with the given property, if the property has a format it is used.
java.lang.Object	getBackgroundColor(Property property)
java.lang.Boolean	getBoolean(java.lang.String propertyId)
java.lang.Character	getCharacter(java.lang.String propertyId)
java.time.LocalDate	getDate(java.lang.String propertyId)
java.lang.Double	getDouble(java.lang.String propertyId)
java.lang.String	getEntityId()
Entity	getForeignKey(Property.ForeignKeyProperty foreignKeyProperty) Returns the Entity instance referenced by the given foreign key property.
Entity	getForeignKey(java.lang.String foreignKeyPropertyId) Returns the Entity instance referenced by the given foreign key property.
java.lang.String	getFormatted(Property property, java.text.Format format)
java.lang.String	getFormatted(java.lang.String propertyId, java.text.Format format)
java.lang.Integer	getInteger(java.lang.String propertyId)
Entity.Key	getKey()
Entity.KeyGenerator.Type	getKeyGeneratorType()
java.lang.Object	getOriginal(java.lang.String propertyId)
Entity.Key	getOriginalKey()
java.util.List<Property.ColumnProperty>	getPrimaryKeyProperties()
java.util.List<Property>	getProperties()
Property	getProperty(java.lang.String propertyId) Retrieves the property identified by propertyId from the entity repository
Entity.Key	getReferencedKey(Property.ForeignKeyProperty foreignKeyProperty) Returns the primary key of the entity referenced by the given Property.ForeignKeyProperty, if the reference is null this method returns null.
java.lang.String	getString(java.lang.String propertyId)
java.time.LocalTime	getTime(java.lang.String propertyId)
java.time.LocalDateTime	getTimestamp(java.lang.String propertyId)
boolean	is(java.lang.String entityId)
boolean	isForeignKeyNull(Property.ForeignKeyProperty foreignKeyProperty) Returns true if the value of the given foreign key is null, in case of composite foreign keys a single null value is enough.
boolean	isKeyNull()
boolean	isLoaded(java.lang.String foreignKeyPropertyId) Returns true if the entity referenced via the given foreign key property has been loaded
boolean	isModified(java.lang.String propertyId)
boolean	isValueNull(java.lang.String propertyId) Returns true if a null value is mapped to the given property.
java.lang.Object	put(Property property, java.lang.Object value, boolean validateType) Sets the value of the given property
java.lang.Object	put(java.lang.String propertyId, java.lang.Object value) Sets the value of the given property
void	remove(java.lang.String propertyId) Removes the given property and value from this Entity along with the original value if any.
void	revert(java.lang.String propertyId) Reverts the value associated with the given property to its original value.
void	save(java.lang.String propertyId) Saves the value associated with the given key, that is, removes the original value.
boolean	valuesEqual(Entity entity)

Methods inherited from interface org.jminor.common.db.valuemap.ValueMap

addValueListener, clear, containsKey, getAsString, getCopy, getModifiedObserver, getOriginal, getOriginalCopy, getValueObserver, isModified, isModified, isValueNull, keySet, newInstance, originalKeySet, put, remove, removeValueListener, revert, revertAll, save, saveAll, setAs, size

Methods inherited from interface org.jminor.common.db.valuemap.ValueProvider

get

Methods inherited from interface org.jminor.common.db.valuemap.ValueCollectionProvider

values

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getEntityId

java.lang.String getEntityId()

Returns:

the entity ID

getKey

Entity.Key getKey()

Returns:

the primary key of this entity

getOriginalKey

Entity.Key getOriginalKey()

Returns:

the primary key of this entity in its original state

getKeyGeneratorType

Entity.KeyGenerator.Type getKeyGeneratorType()

Returns:

the type of key generator used for generating primary key values for entities of this type

getProperty

Property getProperty(java.lang.String propertyId)

Retrieves the property identified by propertyId from the entity repository

Parameters:

propertyId - the ID of the property to retrieve

Returns:

the property identified by propertyId

Throws:

java.lang.IllegalArgumentException - in case the property does not exist in this entity

getProperties

java.util.List<Property> getProperties()

Returns:

the properties comprising this entity

getPrimaryKeyProperties

java.util.List<Property.ColumnProperty> getPrimaryKeyProperties()

Returns:

the primary key properties of this entity type, sorted by primary key column index

get

java.lang.Object get(java.lang.String propertyId)

Parameters:

propertyId - the ID of the property for which to retrieve the value

Returns:

the value of the given property

getOriginal

java.lang.Object getOriginal(java.lang.String propertyId)

Parameters:

propertyId - the ID of the property for which to retrieve the original value

Returns:

the original value of the given property

getString

java.lang.String getString(java.lang.String propertyId)

Parameters:

propertyId - the ID of the property for which to retrieve the value

Returns:

the value of the property identified by propertyId, assuming it is a String

Throws:

java.lang.ClassCastException - if the value is not a String instance

getInteger

java.lang.Integer getInteger(java.lang.String propertyId)

Parameters:

propertyId - the ID of the property for which to retrieve the value

Returns:

the value of the property identified by propertyId, assuming it is an Integer

Throws:

java.lang.ClassCastException - if the value is not a Integer instance

getCharacter

java.lang.Character getCharacter(java.lang.String propertyId)

Parameters:

propertyId - the ID of the property for which to retrieve the value

Returns:

the value of the property identified by propertyId, assuming it is a Character

Throws:

java.lang.ClassCastException - if the value is not a Character instance

getDouble

java.lang.Double getDouble(java.lang.String propertyId)

Parameters:

propertyId - the ID of the property for which to retrieve the value

Returns:

the value of the property identified by propertyId, assuming it is a Double. Rounds the value before returning it in case maximumFractionDigits have been specified.

Throws:

java.lang.ClassCastException - if the value is not a Double instance

See Also:

Property.getMaximumFractionDigits()

getTime

java.time.LocalTime getTime(java.lang.String propertyId)

Parameters:

propertyId - the ID of the date property for which to retrieve the value

Returns:

the value of the property identified by propertyId, assuming it is a LocalTime

Throws:

java.lang.ClassCastException - if the value is not a LocalTime instance

getDate

java.time.LocalDate getDate(java.lang.String propertyId)

Parameters:

propertyId - the ID of the date property for which to retrieve the value

Returns:

the value of the property identified by propertyId, assuming it is a LocalDate

Throws:

java.lang.ClassCastException - if the value is not a LocalDate instance

getTimestamp

java.time.LocalDateTime getTimestamp(java.lang.String propertyId)

Parameters:

propertyId - the ID of the date property for which to retrieve the value

Returns:

the value of the property identified by propertyId, assuming it is a LocalDatetime

Throws:

java.lang.ClassCastException - if the value is not a LocalDateTime instance

getBoolean

java.lang.Boolean getBoolean(java.lang.String propertyId)

Parameters:

propertyId - the ID of the property for which to retrieve the value

Returns:

the value of the property identified by propertyId, assuming it is a Boolean

Throws:

java.lang.ClassCastException - if the value is not a Boolean instance

getFormatted

java.lang.String getFormatted(java.lang.String propertyId,
                              java.text.Format format)

Parameters:

propertyId - the ID of the property for which to retrieve the formatted value

format - the format object

Returns:

the value of the property identified by propertyId, formatted with format

getFormatted

java.lang.String getFormatted(Property property,
                              java.text.Format format)

Parameters:

property - the property for which to retrieve the formatted value

format - the format object

Returns:

the value of the given property, formatted with format

getAsString

java.lang.String getAsString(java.lang.String propertyId)

This method returns a String representation of the value associated with the given property, if the property has a format it is used.

Parameters:

propertyId - the ID of the property for which to retrieve the value

Returns:

a String representation of the value of property

See Also:

getFormatted(Property, java.text.Format)

getForeignKey

Entity getForeignKey(java.lang.String foreignKeyPropertyId)

Returns the Entity instance referenced by the given foreign key property. If the underlying reference property contains a value, that is, a foreign key value exists but the actual referenced entity has not been loaded, an "empty" entity is returned, containing only the primary key value. Null is returned only if the actual reference property is null.

Parameters:

foreignKeyPropertyId - the ID of the property for which to retrieve the value

Returns:

the value of the property identified by propertyId, assuming it is an Entity

Throws:

java.lang.IllegalArgumentException - if the property is not a foreign key property

See Also:

isLoaded(String)

getForeignKey

Entity getForeignKey(Property.ForeignKeyProperty foreignKeyProperty)

Returns the Entity instance referenced by the given foreign key property. If the underlying reference property contains a value, that is, a foreign key value exists but the actual referenced entity has not been loaded, an "empty" entity is returned, containing only the primary key value. Null is returned only if the actual reference property is null.

Parameters:

foreignKeyProperty - the foreign key property for which to retrieve the value

Returns:

the value of the foreign key property

See Also:

isLoaded(String)

getReferencedKey

Entity.Key getReferencedKey(Property.ForeignKeyProperty foreignKeyProperty)

Returns the primary key of the entity referenced by the given Property.ForeignKeyProperty, if the reference is null this method returns null.

Parameters:

foreignKeyProperty - the foreign key property for which to retrieve the underlying Entity.Key

Returns:

the primary key of the underlying entity, null if no entity is referenced

isForeignKeyNull

boolean isForeignKeyNull(Property.ForeignKeyProperty foreignKeyProperty)

Returns true if the value of the given foreign key is null, in case of composite foreign keys a single null value is enough.

Parameters:

foreignKeyProperty - the foreign key property

Returns:

true if the foreign key value is null

put

java.lang.Object put(java.lang.String propertyId,
                     java.lang.Object value)

Sets the value of the given property

Parameters:

propertyId - the ID of the property

value - the value

Returns:

the previous value

Throws:

java.lang.IllegalArgumentException - in case the value type does not fit the property

put

java.lang.Object put(Property property,
                     java.lang.Object value,
                     boolean validateType)

Sets the value of the given property

Parameters:

property - the property

value - the value

validateType - if true then the type of the value is validated

Returns:

the previous value

Throws:

java.lang.IllegalArgumentException - in case type validation is enabled, and the value type does not fit the property

isKeyNull

boolean isKeyNull()

Returns:

true if the this entity instance has a null primary key

isModified

boolean isModified(java.lang.String propertyId)

Parameters:

propertyId - the propertyId

Returns:

true if the value associated with the given property has been modified

clearKeyValues

void clearKeyValues()

Clears the primary key values from this entity, current as well as original values if any

is

boolean is(java.lang.String entityId)

Parameters:

entityId - the entityId

Returns:

true if this entity is of the given type

valuesEqual

boolean valuesEqual(Entity entity)

Parameters:

entity - the entity to compare to

Returns:

true if all column property values (Property.ColumnProperty) are equal

isLoaded

boolean isLoaded(java.lang.String foreignKeyPropertyId)

Returns true if the entity referenced via the given foreign key property has been loaded

Parameters:

foreignKeyPropertyId - the property id

Returns:

true if the reference entity has been loaded

getBackgroundColor

java.lang.Object getBackgroundColor(Property property)

Parameters:

property - the property for which to retrieve the background color

Returns:

the background color to use when displaying this property in a table

revert

void revert(java.lang.String propertyId)

Reverts the value associated with the given property to its original value. If the value has not been modified then calling this method has no effect.

Parameters:

propertyId - the ID of the property for which to revert the value

save

void save(java.lang.String propertyId)

Saves the value associated with the given key, that is, removes the original value. If no original value exists calling this method has no effect.

Parameters:

propertyId - the ID of the property for which to save the value

isValueNull

boolean isValueNull(java.lang.String propertyId)

Returns true if a null value is mapped to the given property.

Parameters:

propertyId - the ID of the property

Returns:

true if the value mapped to the given property is null

containsKey

boolean containsKey(java.lang.String propertyId)

Returns true if this Entity contains a value for the given property, that value can be null.

Parameters:

propertyId - the propertyId

Returns:

true if a value is mapped to this property

remove

void remove(java.lang.String propertyId)

Removes the given property and value from this Entity along with the original value if any. If no value is mapped to the given property, this method has no effect.

Parameters:

propertyId - the ID of the property to remove