com.edorasware.commons.core.any

Class AnyWorkObjectDefinition

java.lang.Object

com.edorasware.commons.core.entity.Entity

com.edorasware.commons.core.any.AnyWorkObjectDefinition

All Implemented Interfaces:

HierarchicalEntity, Identifiable

public class AnyWorkObjectDefinition
extends Entity
implements HierarchicalEntity

Represents a concrete work object definition. <p> Note: This class is useful when working with work object definitions in a generic way.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnyWorkObjectDefinition.Builder Builder for an AnyWorkObjectDefinition instance.

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

Entity.EntityBuilder<E extends Entity,SELF extends Entity.EntityBuilder<E,SELF>>

Nested classes/interfaces inherited from interface com.edorasware.commons.core.entity.HierarchicalEntity

HierarchicalEntity.HierarchicalEntityBuilder<SELF extends HierarchicalEntity.HierarchicalEntityBuilder<SELF>>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY_WORK_OBJECT_DEFINITION_TYPE Deprecated.
static TimestampOperand<Instant>	CREATION_TIME Allows to build predicates testing for certain work object definition creation time values.
static StringOperand<String>	EXTERNAL_ID Allows to build predicates testing for certain external work object definition id values.
static VersionOperand	EXTERNAL_VERSION Allows to build predicates testing for certain work object definition external version values.
static HierarchyOperandImpl	HIERARCHY Allows to build predicates testing for certain work object definition path values.
static StringOperand<String>	ID Allows to build predicates testing for certain work object definition id values.
static StringOperand<String>	KEY Allows to build predicates testing for certain work object definition key values.
static LatestVersionOperand	LATEST_EXTERNAL_VERSION Allows to build predicates that test for the latest external version of all work object definitions with a certain key.
static LatestVersionOperand	LATEST_VERSION Allows to build predicates that test for the latest version of all work object definitions with a certain key.
static StringOperand<String>	NAME Allows to build predicates testing for certain work object definition name values.
static PropertyOperand	PROPERTY Allows to build predicates testing for certain work object definition property values.
static StringOperand<String>	PROVIDER_ID Allows to build predicates testing for certain work object definition provider id values.
static StringOperand<String>	TENANT_ID Allows to build predicates testing for certain work object definition tenant id values.
static StringOperand<String>	TYPE Allows to build predicates testing for certain work object definition type values.
static TimestampOperand<Instant>	UPDATE_TIME Allows to build predicates testing for certain work object definition update time values.
static TimestampOperand<Instant>	VALID_FROM Allows to build predicates testing for certain work object definition valid from date values.
static TimestampOperand<Instant>	VALID_TO Allows to build predicates testing for certain work object definition valid to date values.
static VersionOperand	VERSION Allows to build predicates testing for certain work object definition version values.

Method Summary

Modifier and Type	Method and Description
static AnyWorkObjectDefinition.Builder	builder() Creates a builder for a new concrete work object definition instance.
static AnyWorkObjectDefinition.Builder	builder(AnyWorkObjectDefinition template) Creates a builder for a new concrete work object definition instance and applies the given template.
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(PropertyName<V> 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.
String	getParentId() Returns the id of the parent entity.
List<String>	getPath() Returns the path of the hierarchy to which the entity belongs.
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(PropertyName<V> propertyAccessor) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalPropertyValue(PropertyName) 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.
String	getRootId() Returns the id of the root entity.
Instant	getValidFrom() Returns the date from which the entity is valid.
Instant	getValidTo() Returns the date until which the entity is valid.
int	getVersion() Returns the version of the entity.
boolean	hasLocalProperty(PropertyName<?> propertyAccessor) Returns <i>true</i> if the entity has a local property with the name of the given property accessor.
boolean	hasLocalProperty(String name) Returns <i>true</i> if the entity has a local property with the given name.
boolean	hasParent() Returns <i>true</i> if the entity has a parent.
boolean	hasProperty(PropertyName<?> propertyAccessor) Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the hasLocalProperty(PropertyName) 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
String	toString()

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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.edorasware.commons.core.id.Identifiable

getId

Field Detail

ANY_WORK_OBJECT_DEFINITION_TYPE

@Deprecated
public static final String ANY_WORK_OBJECT_DEFINITION_TYPE

Deprecated.

See Also:

Constant Field Values

ID

public static final StringOperand<String> ID

Allows to build predicates testing for certain work object definition id values.

EXTERNAL_ID

public static final StringOperand<String> EXTERNAL_ID

Allows to build predicates testing for certain external work object definition id values.

PROVIDER_ID

public static final StringOperand<String> PROVIDER_ID

Allows to build predicates testing for certain work object definition provider id values.

TENANT_ID

public static final StringOperand<String> TENANT_ID

Allows to build predicates testing for certain work object definition tenant id values.

NAME

public static final StringOperand<String> NAME

Allows to build predicates testing for certain work object definition name values.

CREATION_TIME

public static final TimestampOperand<Instant> CREATION_TIME

Allows to build predicates testing for certain work object definition creation time values.

UPDATE_TIME

public static final TimestampOperand<Instant> UPDATE_TIME

Allows to build predicates testing for certain work object definition update time values.

TYPE

public static final StringOperand<String> TYPE

Allows to build predicates testing for certain work object definition type values.

KEY

public static final StringOperand<String> KEY

Allows to build predicates testing for certain work object definition key values.

PROPERTY

public static final PropertyOperand PROPERTY

Allows to build predicates testing for certain work object definition property values.

VALID_FROM

public static final TimestampOperand<Instant> VALID_FROM

Allows to build predicates testing for certain work object definition valid from date values.

VALID_TO

public static final TimestampOperand<Instant> VALID_TO

Allows to build predicates testing for certain work object definition valid to date values.

VERSION

public static final VersionOperand VERSION

Allows to build predicates testing for certain work object definition version values.

LATEST_VERSION

public static final LatestVersionOperand LATEST_VERSION

Allows to build predicates that test for the latest version of all work object definitions with a certain key.

EXTERNAL_VERSION

public static final VersionOperand EXTERNAL_VERSION

Allows to build predicates testing for certain work object definition external version values.

LATEST_EXTERNAL_VERSION

public static final LatestVersionOperand LATEST_EXTERNAL_VERSION

Allows to build predicates that test for the latest external version of all work object definitions with a certain key.

HIERARCHY

public static final HierarchyOperandImpl HIERARCHY

Allows to build predicates testing for certain work object definition path values.

Method Detail

builder

public static AnyWorkObjectDefinition.Builder builder()

Creates a builder for a new concrete work object definition instance.

Returns:

the builder

builder

public static AnyWorkObjectDefinition.Builder builder(AnyWorkObjectDefinition template)

Creates a builder for a new concrete work object definition instance and applies the given template.

Parameters:

template - the work object definition template

Returns:

the builder

getPath

public List<String> getPath()

Description copied from interface: HierarchicalEntity

Returns the path of the hierarchy to which the entity belongs. The path starts with the root and ends with the entity itself, when iterating through the list from beginning to end.

Specified by:

getPath in interface HierarchicalEntity

Returns:

the hierarchy path

getRootId

public String getRootId()

Description copied from interface: HierarchicalEntity

Returns the id of the root entity.

Specified by:

getRootId in interface HierarchicalEntity

Returns:

the root entity id, if the entity is itself the root entity, the id of the entity is returned

hasParent

public boolean hasParent()

Description copied from interface: HierarchicalEntity

Returns <i>true</i> if the entity has a parent.

Specified by:

hasParent in interface HierarchicalEntity

Returns:

<i>true</i> if the entity has a parent

getParentId

public String getParentId()

Description copied from interface: HierarchicalEntity

Returns the id of the parent entity.

Specified by:

getParentId in interface HierarchicalEntity

Returns:

the parent entity id, or null if the entity has no parent

toString

public String toString()

Specified by:

toString in class Entity

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(PropertyName<V> propertyAccessor)

Deprecated. support for non-explicit hierarchy parsing is going to be removed. Please use the getLocalPropertyValue(PropertyName) 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 <i>true</i> if the entity has a property with the given name.

Parameters:

name - the name of the property

Returns:

<i>true</i> if the entity has a property with the given name

hasProperty

@Deprecated
public boolean hasProperty(PropertyName<?> propertyAccessor)

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

Returns <i>true</i> 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:

<i>true</i> 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(PropertyName<V> 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 <i>true</i> if the entity has a local property with the given name.

Parameters:

name - the name of the property

Returns:

<i>true</i> if the entity has a local property with the given name

hasLocalProperty

public boolean hasLocalProperty(PropertyName<?> propertyAccessor)

Returns <i>true</i> 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:

<i>true</i> if the entity has a local property with the name of the given property accessor

getValidFrom

public Instant getValidFrom()

Returns the date from which the entity is valid.

Returns:

the valid from date of the entity

getValidTo

public Instant 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