org.jminor.framework.domain

Class Entities

java.lang.Object

org.jminor.framework.domain.Entities

public final class Entities
extends java.lang.Object

Helper class for working with Entity instances and related classes

Method Summary

Modifier and Type	Method and Description
static java.util.List<Entity>	copyEntities(java.util.List<Entity> entities) Copies the given entities, with new copied instances of all foreign key value entities.
static boolean	equal(Entity entityOne, Entity entityTwo, java.lang.String... propertyIds) Returns true if the values of the given properties are equal in the given entities.
static <T> java.util.List<T>	getDistinctValues(java.lang.String propertyId, java.util.Collection<Entity> entities) Returns a Collection containing the distinct values of propertyId from the given entities, excluding null values.
static <T> java.util.List<T>	getDistinctValues(java.lang.String propertyId, java.util.Collection<Entity> entities, boolean includeNullValue) Returns a Collection containing the distinct values of propertyId from the given entities.
static java.util.List<Entity>	getEntitiesByValue(java.util.Collection<Entity> entities, java.util.Map<java.lang.String,java.lang.Object> values) Finds entities according to the values of values
static java.util.List<Entity.Key>	getKeys(java.util.List<Entity> entities) Returns the primary keys of the given entities.
static java.util.List<Entity.Key>	getKeys(java.util.List<Entity> entities, boolean originalValue) Returns the primary key values of the given entities, current or original.
static java.util.Collection<ColumnProperty>	getModifiedColumnProperties(Entity entity, Entity comparison, boolean includeReadOnlyProperties) Returns all ColumnPropertys which value is missing or the original value differs from the one in the comparison entity, returns an empty Collection if all of entitys original values match the values found in comparison
static java.util.List<Entity>	getModifiedEntities(java.util.Collection<Entity> entities) Returns all of the given entities which have been modified
static java.lang.String[][]	getStringValueArray(java.util.List<? extends Property> properties, java.util.List<Entity> entities) Creates a two dimensional array containing the values of the given properties for the given entities in string format.
static <T> java.util.List<T>	getValues(java.util.List<Entity.Key> keys) Retrieves the values of the given keys, assuming they are single column keys.
static <T> java.util.List<T>	getValues(java.lang.String propertyId, java.util.Collection<Entity> entities) Returns the values associated with the given property from the given entities.
static <T> java.util.List<T>	getValues(java.lang.String propertyId, java.util.Collection<Entity> entities, boolean includeNullValues) Returns the values associated with the given property from the given entities.
static boolean	isEntityNew(Entity entity) Returns true if the entity has a null primary key or a null original primary key, which is the best guess about an entity being new, as in, not existing in a database.
static boolean	isKeyModified(java.util.Collection<Entity> entities) Checks if the primary key of any of the given entities is modified
static java.util.LinkedHashMap<java.lang.String,java.util.List<Entity.Key>>	mapKeysToEntityId(java.util.Collection<Entity.Key> keys) Returns a LinkedHashMap containing the given entity keys mapped to their entityIds, respecting the iteration order of the given collection
static java.util.LinkedHashMap<java.lang.String,java.util.List<Entity>>	mapToEntityId(java.util.Collection<Entity> entities) Returns a LinkedHashMap containing the given entities mapped to their entityIds, respecting the iteration order of the given collection
static java.util.Map<Entity.Key,Entity>	mapToKey(java.util.Collection<Entity> entities) Maps the given entities to their primary key
static java.util.Map<Entity.Key,Entity>	mapToOriginalPrimaryKey(java.util.List<Entity> entitiesBeforeUpdate, java.util.List<Entity> entitiesAfterUpdate) Maps the given entities and their updated counterparts to their original primary keys, assumes a single copy of each entity in the given lists.
static <K> java.util.LinkedHashMap<K,java.util.List<Entity>>	mapToValue(java.lang.String propertyId, java.util.Collection<Entity> entities) Returns a LinkedHashMap containing the given entities mapped to the value of the property with id propertyId, respecting the iteration order of the given collection
static java.util.Map<Entity.Key,java.lang.Object>	put(java.lang.String propertyId, java.lang.Object value, java.util.Collection<Entity> entities) Sets the value of the property with id propertyId to value in the given entities

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isEntityNew

public static boolean isEntityNew(Entity entity)

Returns true if the entity has a null primary key or a null original primary key, which is the best guess about an entity being new, as in, not existing in a database.

Parameters:

entity - the entity

Returns:

true if this entity has not been persisted

isKeyModified

public static boolean isKeyModified(java.util.Collection<Entity> entities)

Checks if the primary key of any of the given entities is modified

Parameters:

entities - the entities to check

Returns:

true if any of the given entities has a modified primary key

getModifiedEntities

public static java.util.List<Entity> getModifiedEntities(java.util.Collection<Entity> entities)

Returns all of the given entities which have been modified

Parameters:

entities - the entities

Returns:

a List of entities that have been modified

See Also:

ValueMap.isModified()

getModifiedColumnProperties

public static final java.util.Collection<ColumnProperty> getModifiedColumnProperties(Entity entity,
                                                                                     Entity comparison,
                                                                                     boolean includeReadOnlyProperties)

Returns all ColumnPropertys which value is missing or the original value differs from the one in the comparison entity, returns an empty Collection if all of entitys original values match the values found in comparison

Parameters:

entity - the entity instance to check

comparison - the entity instance to compare with

includeReadOnlyProperties - if true then readOnly properties are included in the comparison

Returns:

the properties which values differ from the ones in the comparison entity

getKeys

public static java.util.List<Entity.Key> getKeys(java.util.List<Entity> entities)

Returns the primary keys of the given entities.

Parameters:

entities - the entities

Returns:

a List containing the primary keys of the given entities

getKeys

public static java.util.List<Entity.Key> getKeys(java.util.List<Entity> entities,
                                                 boolean originalValue)

Returns the primary key values of the given entities, current or original.

Parameters:

entities - the entities

originalValue - if true then the original value of the primary key is returned

Returns:

a List containing the primary keys of the given entities

getValues

public static <T> java.util.List<T> getValues(java.util.List<Entity.Key> keys)

Retrieves the values of the given keys, assuming they are single column keys.

Type Parameters:

T - the value type

Parameters:

keys - the keys

Returns:

the actual property values of the given keys

getValues

public static <T> java.util.List<T> getValues(java.lang.String propertyId,
                                              java.util.Collection<Entity> entities)

Returns the values associated with the given property from the given entities.

Type Parameters:

T - the value type

Parameters:

propertyId - the id of the property for which to retrieve the values

entities - the entities from which to retrieve the property value

Returns:

a List containing the values of the property with the given id from the given entities, null values are included

getValues

public static <T> java.util.List<T> getValues(java.lang.String propertyId,
                                              java.util.Collection<Entity> entities,
                                              boolean includeNullValues)

Returns the values associated with the given property from the given entities.

Type Parameters:

T - the value type

Parameters:

propertyId - the id of the property for which to retrieve the values

entities - the entities from which to retrieve the property value

includeNullValues - if true then null values are included

Returns:

a List containing the values of the property with the given id from the given entities

getDistinctValues

public static <T> java.util.List<T> getDistinctValues(java.lang.String propertyId,
                                                      java.util.Collection<Entity> entities)

Returns a Collection containing the distinct values of propertyId from the given entities, excluding null values. If the entities list is null an empty Collection is returned.

Type Parameters:

T - the value type

Parameters:

propertyId - the id of the property for which to retrieve the values

entities - the entities from which to retrieve the values

Returns:

a List containing the distinct property values, excluding null values

getDistinctValues

public static <T> java.util.List<T> getDistinctValues(java.lang.String propertyId,
                                                      java.util.Collection<Entity> entities,
                                                      boolean includeNullValue)

Returns a Collection containing the distinct values of propertyId from the given entities. If the entities list is null an empty Collection is returned.

Type Parameters:

T - the value type

Parameters:

propertyId - the id of the property for which to retrieve the values

entities - the entities from which to retrieve the values

includeNullValue - if true then null is considered a value

Returns:

a List containing the distinct property values

put

public static java.util.Map<Entity.Key,java.lang.Object> put(java.lang.String propertyId,
                                                             java.lang.Object value,
                                                             java.util.Collection<Entity> entities)

Sets the value of the property with id propertyId to value in the given entities

Parameters:

propertyId - the id of the property for which to set the value

value - the value

entities - the entities for which to set the value

Returns:

the previous property values mapped to the primary key of the entity

mapToKey

public static java.util.Map<Entity.Key,Entity> mapToKey(java.util.Collection<Entity> entities)

Maps the given entities to their primary key

Parameters:

entities - the entities to map

Returns:

the mapped entities

mapToValue

public static <K> java.util.LinkedHashMap<K,java.util.List<Entity>> mapToValue(java.lang.String propertyId,
                                                                               java.util.Collection<Entity> entities)

Returns a LinkedHashMap containing the given entities mapped to the value of the property with id propertyId, respecting the iteration order of the given collection

Type Parameters:

K - the key type

Parameters:

propertyId - the id of the property which value should be used for mapping

entities - the entities to map by property value

Returns:

a Map of entities mapped to property value

mapToEntityId

public static java.util.LinkedHashMap<java.lang.String,java.util.List<Entity>> mapToEntityId(java.util.Collection<Entity> entities)

Returns a LinkedHashMap containing the given entities mapped to their entityIds, respecting the iteration order of the given collection

Parameters:

entities - the entities to map by entityId

Returns:

a Map of entities mapped to entityId

mapKeysToEntityId

public static java.util.LinkedHashMap<java.lang.String,java.util.List<Entity.Key>> mapKeysToEntityId(java.util.Collection<Entity.Key> keys)

Returns a LinkedHashMap containing the given entity keys mapped to their entityIds, respecting the iteration order of the given collection

Parameters:

keys - the entity keys to map by entityId

Returns:

a Map of entity keys mapped to entityId

mapToOriginalPrimaryKey

public static java.util.Map<Entity.Key,Entity> mapToOriginalPrimaryKey(java.util.List<Entity> entitiesBeforeUpdate,
                                                                       java.util.List<Entity> entitiesAfterUpdate)

Maps the given entities and their updated counterparts to their original primary keys, assumes a single copy of each entity in the given lists.

Parameters:

entitiesBeforeUpdate - the entities before update

entitiesAfterUpdate - the entities after update

Returns:

the updated entities mapped to their respective original primary keys

getStringValueArray

public static java.lang.String[][] getStringValueArray(java.util.List<? extends Property> properties,
                                                       java.util.List<Entity> entities)

Creates a two dimensional array containing the values of the given properties for the given entities in string format.

Parameters:

properties - the properties

entities - the entities

Returns:

the values of the given properties from the given entities in a two dimensional array

copyEntities

public static java.util.List<Entity> copyEntities(java.util.List<Entity> entities)

Copies the given entities, with new copied instances of all foreign key value entities.

Parameters:

entities - the entities to copy

Returns:

deep copies of the entities, in the same order as they are received

getEntitiesByValue

public static java.util.List<Entity> getEntitiesByValue(java.util.Collection<Entity> entities,
                                                        java.util.Map<java.lang.String,java.lang.Object> values)

Finds entities according to the values of values

Parameters:

entities - the entities to search

values - the property values to use as condition mapped to their respective propertyIds

Returns:

the entities having the exact same property values as in the given value map

equal

public static boolean equal(Entity entityOne,
                            Entity entityTwo,
                            java.lang.String... propertyIds)

Returns true if the values of the given properties are equal in the given entities.

Parameters:

entityOne - the first entity

entityTwo - the second entity

propertyIds - the ids of the properties to use

Returns:

true if the values of the given properties are equal in the given entities