com.edorasware.commons.core.entity

Class DomainObjectDefinition<T extends EntityId,P extends Id>

java.lang.Object

com.edorasware.commons.core.entity.Entity<T,P>

com.edorasware.commons.core.entity.DomainObjectDefinition<T,P>

Type Parameters:

T - The type of the id/externalId

P - The type of the providerId

All Implemented Interfaces:

Identifiable<T>

Direct Known Subclasses:

WorkObjectDefinition

public abstract class DomainObjectDefinition<T extends EntityId,P extends Id>
extends Entity<T,P>

Base class for all definitions of domain objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DomainObjectDefinition.DomainObjectDefinitionBuilder<T extends EntityId,P extends Id,E extends DomainObjectDefinition<T,P>,SELF extends DomainObjectDefinition.DomainObjectDefinitionBuilder<T,P,E,SELF>>
protected static class	DomainObjectDefinition.DomainObjectDefinitionData<T extends EntityId,P extends Id> Data container that holds the state of a domain object definition.

Nested classes/interfaces inherited from class com.edorasware.commons.core.entity.Entity

Entity.EntityBuilder<T extends EntityId,P extends Id,E extends Entity<T,P>,SELF extends Entity.EntityBuilder<T,P,E,SELF>>, Entity.EntityData<T extends EntityId,P extends Id>

Field Summary

Fields

Modifier and Type	Field and Description
protected DomainObjectDefinition.DomainObjectDefinitionData<T,P>	domainObjectDefinitionData

Fields inherited from class com.edorasware.commons.core.entity.Entity

entityData

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DomainObjectDefinition(Entity.EntityData<T,P> entityData, DomainObjectDefinition.DomainObjectDefinitionData<T,P> domainObjectDefinitionData)
protected	DomainObjectDefinition(Entity.EntityData<T,P> entityData, DomainObjectDefinition.DomainObjectDefinitionData<T,P> domainObjectDefinitionData, List<? extends EntityId> propertiesPath)

Method Summary

Modifier and Type	Method and Description
int	getExternalVersion() Returns the external version of the entity.
String	getKey() Returns the key of the entity.
List<Property>	getLocalProperties() Returns the local properties of the entity.
List<Property>	getLocalProperties(com.google.common.base.Predicate<Property> predicate) Returns the local properties of the entity, filtered by the given predicate.
Map<String,String>	getLocalPropertiesMap() Returns the local properties of the entity, mapped by the property name.
Map<String,String>	getLocalPropertiesMap(com.google.common.base.Predicate<Property> predicate) Returns the local properties of the entity as name/value pairs, filtered by the given predicate.
Property	getLocalProperty(String name) Returns the local property with the given name.
<V> V	getLocalPropertyValue(NamedValueAccessor<V,String> propertyAccessor) Returns the value of the local property with the name defined by the property accessor, deserialized and cast to the type expected by the property accessor.
String	getLocalPropertyValue(String name) Returns the value of the local property with the given name.
List<Property>	getProperties() Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalProperties() method instead and recheck where you store the properties
List<Property>	getProperties(com.google.common.base.Predicate<Property> predicate) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalProperties(Predicate) method instead and recheck where you store the properties
Map<String,String>	getPropertiesMap() Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalPropertiesMap() method instead and recheck where you store the properties
Map<String,String>	getPropertiesMap(com.google.common.base.Predicate<Property> predicate) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalPropertiesMap(Predicate) method instead and recheck where you store the properties
Property	getProperty(String name) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalProperty(String) method instead and recheck where you store the properties
<V> V	getPropertyValue(NamedValueAccessor<V,String> propertyAccessor) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalPropertyValue(NamedValueAccessor) method instead and recheck where you store the properties
String	getPropertyValue(String name) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalPropertyValue(String) method instead and recheck where you store the properties
String	getResourceString() Returns the resource string of the entity.
Date	getValidFrom() Returns the date from which the entity is valid.
Date	getValidTo() Returns the date until which the entity is valid.
int	getVersion() Returns the version of the entity.
boolean	hasLocalProperty(NamedValueAccessor<?,?> propertyAccessor) Returns true if the entity has a local property with the name of the given property accessor.
boolean	hasLocalProperty(String name) Returns true if the entity has a local property with the given name.
boolean	hasProperty(NamedValueAccessor<?,String> propertyAccessor) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the hasLocalProperty(NamedValueAccessor) method instead and recheck where you store the properties
boolean	hasProperty(String name) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the hasLocalProperty(String) method instead and recheck where you store the properties

Methods inherited from class com.edorasware.commons.core.entity.Entity

getCreationTime, getDescription, getExternalId, getGlobalId, getId, getModificationCreatorId, getModificationUpdaterId, getModificationVersion, getName, getProviderId, getTenantId, getType, getUpdateTime, toString

Methods inherited from class java.lang.Object

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

Field Detail

domainObjectDefinitionData

protected final DomainObjectDefinition.DomainObjectDefinitionData<T extends EntityId,P extends Id> domainObjectDefinitionData

Constructor Detail

DomainObjectDefinition

protected DomainObjectDefinition(Entity.EntityData<T,P> entityData,
                                 DomainObjectDefinition.DomainObjectDefinitionData<T,P> domainObjectDefinitionData)

DomainObjectDefinition

protected DomainObjectDefinition(Entity.EntityData<T,P> entityData,
                                 DomainObjectDefinition.DomainObjectDefinitionData<T,P> domainObjectDefinitionData,
                                 List<? extends EntityId> propertiesPath)

Method Detail

getKey

public String getKey()

Returns the key of the entity.

Returns:

the key of the entity

getProperties

@Deprecated
public List<Property> getProperties()

Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalProperties() method instead and recheck where you store the properties

Returns the properties of the entity.

Returns:

the properties of the entity

getProperties

@Deprecated
public final List<Property> getProperties(com.google.common.base.Predicate<Property> predicate)

Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalProperties(Predicate) method instead and recheck where you store the properties

Returns the properties of the entity, filtered by the given predicate.

Parameters:

predicate - the predicate to filter by

Returns:

the properties of the entity

getPropertiesMap

@Deprecated
public Map<String,String> getPropertiesMap()

Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalPropertiesMap() method instead and recheck where you store the properties

Returns the properties of the entity as name/value pairs. In case of name clashes, properties closer to this entity have precedence.

Returns:

the properties map of the entity

getPropertiesMap

@Deprecated
public final Map<String,String> getPropertiesMap(com.google.common.base.Predicate<Property> predicate)

Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalPropertiesMap(Predicate) method instead and recheck where you store the properties

Returns the properties of the entity as name/value pairs, filtered by the given predicate.

Parameters:

predicate - the predicate to filter by

Returns:

the filtered properties map of the entity

getProperty

@Deprecated
public Property getProperty(String name)

Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalProperty(String) method instead and recheck where you store the properties

Returns the property with the given name. In case of name clashes, properties closer to this entity have precedence.

Parameters:

name - the name of the property to return

Returns:

the property

getPropertyValue

@Deprecated
public String getPropertyValue(String name)

Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalPropertyValue(String) method instead and recheck where you store the properties

Returns the value of the property with the given name. In case of name clashes, properties closer to this entity have precedence.

Parameters:

name - the name of the property whose value to return

Returns:

the property value

getPropertyValue

@Deprecated
public <V> V getPropertyValue(NamedValueAccessor<V,String> propertyAccessor)

Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalPropertyValue(NamedValueAccessor) method instead and recheck where you store the properties

Returns the value of the property with the name defined by the property accessor, deserialized and cast to the type expected by the property accessor.

Type Parameters:

V - the expected transient and persisted type of the property value

Parameters:

propertyAccessor - the accessor from which to derive the name, deserialize the value, and cast to the expected type

Returns:

the property value

hasProperty

@Deprecated
public boolean hasProperty(String name)

Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the hasLocalProperty(String) method instead and recheck where you store the properties

Returns true if the entity has a property with the given name.

Parameters:

name - the name of the property

Returns:

true if the entity has a property with the given name

hasProperty

@Deprecated
public boolean hasProperty(NamedValueAccessor<?,String> propertyAccessor)

Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the hasLocalProperty(NamedValueAccessor) method instead and recheck where you store the properties

Returns true if the entity has a property with the name of the given property accessor.

Parameters:

propertyAccessor - the accessor from which to derive the name, deserialize the value, and cast to the expected type

Returns:

true if the entity has a property with the name of the given property accessor

getLocalProperties

public final List<Property> getLocalProperties()

Returns the local properties of the entity.

Returns:

the local properties of the entity

getLocalProperties

public final List<Property> getLocalProperties(com.google.common.base.Predicate<Property> predicate)

Returns the local properties of the entity, filtered by the given predicate.

Parameters:

predicate - the predicate to filter by

Returns:

the filtered local properties of the entity

getLocalPropertiesMap

public final Map<String,String> getLocalPropertiesMap()

Returns the local properties of the entity, mapped by the property name.

Returns:

the local properties map of the entity

getLocalPropertiesMap

public final Map<String,String> getLocalPropertiesMap(com.google.common.base.Predicate<Property> predicate)

Returns the local properties of the entity as name/value pairs, filtered by the given predicate.

Parameters:

predicate - the predicate to filter by

Returns:

the filtered local properties map of the entity

getLocalProperty

public final Property getLocalProperty(String name)

Returns the local property with the given name.

Parameters:

name - the name of the local property to return

Returns:

the property

getLocalPropertyValue

public final String getLocalPropertyValue(String name)

Returns the value of the local property with the given name.

Parameters:

name - the name of the local property whose value to return

Returns:

the property value

getLocalPropertyValue

public final <V> V getLocalPropertyValue(NamedValueAccessor<V,String> propertyAccessor)

Returns the value of the local property with the name defined by the property accessor, deserialized and cast to the type expected by the property accessor.

Type Parameters:

V - the expected transient and persisted type of the property value

Parameters:

propertyAccessor - the accessor from which to derive the name, deserialize the value, and cast to the expected type

Returns:

the property value

hasLocalProperty

public boolean hasLocalProperty(String name)

Returns true if the entity has a local property with the given name.

Parameters:

name - the name of the property

Returns:

true if the entity has a local property with the given name

hasLocalProperty

public boolean hasLocalProperty(NamedValueAccessor<?,?> propertyAccessor)

Returns true if the entity has a local property with the name of the given property accessor.

Parameters:

propertyAccessor - the accessor from which to derive the name, deserialize the value, and cast to the expected type

Returns:

true if the entity has a local property with the name of the given property accessor

getValidFrom

public Date getValidFrom()

Returns the date from which the entity is valid.

Returns:

the valid from date of the entity

getValidTo

public Date getValidTo()

Returns the date until which the entity is valid.

Returns:

the valid to date of the entity

getVersion

public int getVersion()

Returns the version of the entity.

Returns:

the version of the entity

getExternalVersion

public int getExternalVersion()

Returns the external version of the entity.

Returns:

the external version of the entity

getResourceString

public String getResourceString()

Returns the resource string of the entity.

Returns:

the resource string of the entity