com.edorasware.commons.core.entity

Class DomainObject<T extends EntityId,D extends EntityId,P extends Id>

java.lang.Object

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

com.edorasware.commons.core.entity.DomainObject<T,D,P>

Type Parameters:

T - The type of the id/externalId

D - The type of the definitionId

P - The type of the providerId

All Implemented Interfaces:

Identifiable<T>

Direct Known Subclasses:

WorkObject

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

Base class for all domain objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DomainObject.DomainObjectBuilder<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,SELF extends DomainObject.DomainObjectBuilder<T,D,P,E,SELF>>
protected static class	DomainObject.DomainObjectData<T extends EntityId,D extends EntityId,P extends Id> Data container that holds the state of a domain object.

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 DomainObject.DomainObjectData<T,D,P>	domainObjectData
static com.google.common.base.Optional<Object>	VARIABLE_DELETED_VALUE Variable value used inside the DomainObjectModification as a flag to delete the variables in the next update.

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

entityData

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DomainObject(Entity.EntityData<T,P> entityData, DomainObject.DomainObjectData<T,D,P> domainObjectData)
protected	DomainObject(Entity.EntityData<T,P> entityData, DomainObject.DomainObjectData<T,D,P> domainObjectData, List<? extends EntityId> variablesPath)

Method Summary

Modifier and Type	Method and Description
D	getDefinitionId() Returns the definition id of the entity.
Variable	getLocalVariable(String name) Returns the local variable with the given name.
List<Variable>	getLocalVariables() Returns the local variables of the entity.
List<Variable>	getLocalVariables(com.google.common.base.Predicate<Variable> predicate) Returns the local variables of the entity, filtered by the given predicate.
Map<String,Object>	getLocalVariablesMap() Returns the local variables of the entity as name/value pairs.
Map<String,Object>	getLocalVariablesMap(com.google.common.base.Predicate<Variable> predicate) Returns the local variables of the entity as name/value pairs, filtered by the given predicate.
<V,W> V	getLocalVariableValue(NamedValueAccessor<V,W> variableAccessor) Returns the value of the local variable with the name defined by the variable accessor, deserialized and cast to the type expected by the variable accessor.
Object	getLocalVariableValue(String name) Returns the value of the local variable with the given name.
<T> T	getLocalVariableValue(String name, Class<T> expectedType) Returns the value of the local variable with the given name, cast to the expected type.
<T> T	getLocalVariableValue(String name, com.google.common.reflect.TypeToken<T> expectedType) Returns the value of the local variable with the given name, cast to the expected type.
State	getState() Returns the current state of the entity.
Date	getStateUpdateTime() Returns the time the entity state was last updated.
State	getSubState() Returns the current sub state of the entity.
Date	getSubStateUpdateTime() Returns the time the entity sub state was last updated.
Variable	getVariable(String name) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariable(String) method instead and recheck where you store the variables
List<Variable>	getVariables() Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariables() method instead and recheck where you store the variables
List<Variable>	getVariables(com.google.common.base.Predicate<Variable> predicate) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariables(Predicate) method instead and recheck where you store the variables
Map<String,Object>	getVariablesMap() Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariablesMap() method instead and recheck where you store the variables
Map<String,Object>	getVariablesMap(com.google.common.base.Predicate<Variable> predicate) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariablesMap(Predicate) method instead and recheck where you store the variables
<V,W> V	getVariableValue(NamedValueAccessor<V,W> variableAccessor) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariableValue(NamedValueAccessor) method instead and recheck where you store the variables
Object	getVariableValue(String name) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariableValue(String) method instead and recheck where you store the variables
<T> T	getVariableValue(String name, Class<T> expectedType) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariableValue(String, Class) method instead and recheck where you store the variables
<T> T	getVariableValue(String name, com.google.common.reflect.TypeToken<T> expectedType) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalVariableValue(String, Class) method instead and recheck where you store the variables
boolean	hasLocalVariable(NamedValueAccessor<?,?> variableAccessor) Returns true if the entity has a local variable with the name of the given variable accessor.
boolean	hasLocalVariable(String name) Returns true if the entity has a local variable with the given name.
boolean	hasVariable(NamedValueAccessor<?,?> variableAccessor) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the hasLocalVariable(NamedValueAccessor) method instead and recheck where you store the variables
boolean	hasVariable(String name) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the hasLocalVariable(String) method instead and recheck where you store the variables

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

VARIABLE_DELETED_VALUE

public static final com.google.common.base.Optional<Object> VARIABLE_DELETED_VALUE

Variable value used inside the DomainObjectModification as a flag to delete the variables in the next update.

domainObjectData

protected final DomainObject.DomainObjectData<T extends EntityId,D extends EntityId,P extends Id> domainObjectData

Constructor Detail

DomainObject

protected DomainObject(Entity.EntityData<T,P> entityData,
                       DomainObject.DomainObjectData<T,D,P> domainObjectData)

DomainObject

protected DomainObject(Entity.EntityData<T,P> entityData,
                       DomainObject.DomainObjectData<T,D,P> domainObjectData,
                       List<? extends EntityId> variablesPath)

Method Detail

getDefinitionId

public D getDefinitionId()

Returns the definition id of the entity. The definition serves as the template to create the actual entity instance.

Returns:

the underlying definition of the entity

getState

public State getState()

Returns the current state of the entity.

Returns:

the state of the entity

getSubState

public State getSubState()

Returns the current sub state of the entity.

Returns:

the sub state of the entity

getVariables

@Deprecated
public final List<Variable> getVariables()

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

Returns the variables of the entity.

Returns:

the variables of the entity

getVariables

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

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

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

Parameters:

predicate - the predicate to filter by

Returns:

the variables of the entity

getVariablesMap

@Deprecated
public final Map<String,Object> getVariablesMap()

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

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

Returns:

the variables map of the entity

getVariablesMap

@Deprecated
public final Map<String,Object> getVariablesMap(com.google.common.base.Predicate<Variable> predicate)

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

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

Parameters:

predicate - the predicate to filter by

Returns:

the filtered variables map of the entity

getVariable

@Deprecated
public Variable getVariable(String name)

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

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

Parameters:

name - the name of the variable to return

Returns:

the variable

getVariableValue

@Deprecated
public final Object getVariableValue(String name)

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

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

Parameters:

name - the name of the variable whose value to return

Returns:

the variable value

getVariableValue

@Deprecated
public final <T> T getVariableValue(String name,
                                                Class<T> expectedType)

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

Returns the value of the variable with the given name, cast to the expected type.

Type Parameters:

T - the type of the id/externalId

Parameters:

name - the name of the variable whose value to return

expectedType - the expected type of the variable value

Returns:

the variable value

getVariableValue

@Deprecated
public final <T> T getVariableValue(String name,
                                                com.google.common.reflect.TypeToken<T> expectedType)

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

Returns the value of the variable with the given name, cast to the expected type.

Note: using this TypeToken based API is useful when working with parameterized values.

Type Parameters:

T - the type of the id/externalId

Parameters:

name - the name of the variable whose value to return

expectedType - the expected type of the variable value

Returns:

the variable value

getVariableValue

@Deprecated
public final <V,W> V getVariableValue(NamedValueAccessor<V,W> variableAccessor)

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

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

Type Parameters:

V - the expected transient type of the named value

W - the expected persisted type of the named value

Parameters:

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

Returns:

the variable value

hasVariable

@Deprecated
public boolean hasVariable(String name)

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

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

Parameters:

name - the name of the variable

Returns:

true if the entity has a variable with the given name

hasVariable

@Deprecated
public boolean hasVariable(NamedValueAccessor<?,?> variableAccessor)

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

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

Parameters:

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

Returns:

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

getLocalVariables

public final List<Variable> getLocalVariables()

Returns the local variables of the entity.

Returns:

the local variables of the entity

getLocalVariables

public final List<Variable> getLocalVariables(com.google.common.base.Predicate<Variable> predicate)

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

Parameters:

predicate - the predicate to filter by

Returns:

the filtered local variables of the entity

getLocalVariablesMap

public final Map<String,Object> getLocalVariablesMap()

Returns the local variables of the entity as name/value pairs.

Returns:

the local variables map of the entity

getLocalVariablesMap

public final Map<String,Object> getLocalVariablesMap(com.google.common.base.Predicate<Variable> predicate)

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

Parameters:

predicate - the predicate to filter by

Returns:

the filtered local variables map of the entity

getLocalVariable

public Variable getLocalVariable(String name)

Returns the local variable with the given name.

Parameters:

name - the name of the local variable to return

Returns:

the variable

getLocalVariableValue

public final Object getLocalVariableValue(String name)

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

Parameters:

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

Returns:

the variable value

getLocalVariableValue

public final <T> T getLocalVariableValue(String name,
                                         Class<T> expectedType)

Returns the value of the local variable with the given name, cast to the expected type.

Type Parameters:

T - the type of the id/externalId

Parameters:

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

expectedType - the expected type of the variable value

Returns:

the variable value

getLocalVariableValue

public final <T> T getLocalVariableValue(String name,
                                         com.google.common.reflect.TypeToken<T> expectedType)

Returns the value of the local variable with the given name, cast to the expected type.

Note: using this TypeToken based API is useful when working with parameterized values.

Type Parameters:

T - the type of the id/externalId

Parameters:

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

expectedType - the expected type of the variable value

Returns:

the variable value

getLocalVariableValue

public final <V,W> V getLocalVariableValue(NamedValueAccessor<V,W> variableAccessor)

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

Type Parameters:

V - the expected transient type of the named value

W - the expected persisted type of the named value

Parameters:

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

Returns:

the variable value

hasLocalVariable

public boolean hasLocalVariable(String name)

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

Parameters:

name - the name of the variable

Returns:

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

hasLocalVariable

public boolean hasLocalVariable(NamedValueAccessor<?,?> variableAccessor)

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

Parameters:

variableAccessor - 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 variable with the name of the given variable accessor

getStateUpdateTime

public Date getStateUpdateTime()

Returns the time the entity state was last updated.

Returns:

the last update time of the entity's state

getSubStateUpdateTime

public Date getSubStateUpdateTime()

Returns the time the entity sub state was last updated.

Returns:

the last update time of the entity's sub state