Entity (AristaFlow Business Process Platform API)

java.lang.Object
- de.aristaflow.adept2.model.orgmodel.Entity

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Entity
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
This class represents an entity, i.e. instance of an entity type like Agent, OrgPosition etc.. However, an Entity-object doesn't necessarily have to contain all attributes that are defined for an entity type. In future, there might be methods that allow the caller to specify which attributes are needed.
All attribute names are case insensitive, still the original case should be preserved. getAttributeNames() should reflect the insertion order of the attributes.
This class not only defines methods to read but also to add and set attributes. These, however, will not be propagated to the data source!
When setting values it will NOT be ensured, that they have the correct data type or any known or supported data type at all. This is simply a container class!

Author:

Patrick Schmidt

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Entity(EntityType entityType)` Constructs a new `DefaultEntity` with the given entity type.
`Entity(EntityType entityType, int attributeCount)` Constructs a new `DefaultEntity` with the given entity type.
`Entity(EntityType entityType, long id)` Constructs a new `DefaultEntity` with the given entity type and ID.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Entity`	`clone()`
`boolean`	`containsAttribute(java.lang.String attrName)` Returns whether an attribute with the given name is contained in this `Entity`-object.
`boolean`	`equals(java.lang.Object obj)` This implementation recognises two `Entity`s as equal if their ID attributes match.
`java.lang.Object`	`get(java.lang.String attrName)` Returns the value object for the given attribute name.
`int`	`getAttributeCount()` Returns the number of attributes stored in this `Entity`-object.
`java.lang.String[]`	`getAttributeNames()` Returns the names of the attributes that are contained in this `Entity`-object.
`java.util.Date`	`getDate(java.lang.String attrName)` This method will return the attribute value as `Date` or `null`.
`double`	`getFloat(java.lang.String attrName)` This method will return the attribute value as float or 0 if it is `null`.
`long`	`getInteger(java.lang.String attrName)` This method will return the attribute value as an int or 0 if it is `null`.
`java.lang.String`	`getString(java.lang.String attrName)` This method will return the attribute value as `String` or `null`.
`EntityType`	`getType()` Returns the type of this entity.
`int`	`hashCode()`
`boolean`	`isNull(java.lang.String attrName)` Returns whether the specified attribute is null (not set) for this entity.
`void`	`removeAttribute(java.lang.String attrName)` Removes the given attribute from this entity.
`void`	`set(java.lang.String attrName, java.lang.Object value)` Sets the given attribute to the given value.
`void`	`setDate(java.lang.String attrName, java.util.Date value)` Sets the given attribute to the given value.
`void`	`setFloat(java.lang.String attrName, double value)` Sets the given attribute to the given value.
`void`	`setInteger(java.lang.String attrName, long value)` Sets the given attribute to the given value.
`void`	`setNull(java.lang.String attrName)` Sets the given attribute to the given value.
`void`	`setString(java.lang.String attrName, java.lang.String value)` Sets the given attribute to the given value.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Entity
```
public Entity(EntityType entityType)
```
    Constructs a new DefaultEntity with the given entity type.
    
    Parameters:
    
    entityType - the type of the entity
  - Entity
```
public Entity(EntityType entityType,
              long id)
```
    Constructs a new DefaultEntity with the given entity type and ID.
    
    Parameters:
    
    entityType - the type of the entity
    
    id - the initial ID of this entity object
  - Entity
```
public Entity(EntityType entityType,
              int attributeCount)
```
    Constructs a new DefaultEntity with the given entity type. The ArrayList is initialised for the given number of attributes.
    
    Parameters:
    
    entityType - the type of the entity
    
    attributeCount - the number of attributes this entity will hold
- Method Detail
  - getType
```
public EntityType getType()
```
    Returns the type of this entity.
    
    Returns:
    
    the type of this entity
  - getAttributeCount
```
public int getAttributeCount()
```
    Returns the number of attributes stored in this Entity-object.
    
    Returns:
    
    the number of attributes stored in this Entity-object
  - getAttributeNames
```
public java.lang.String[] getAttributeNames()
```
    Returns the names of the attributes that are contained in this Entity-object.
    
    Returns:
    
    a string array containing the names of the attributes that are contained in this Entity-object
  - containsAttribute
```
public boolean containsAttribute(java.lang.String attrName)
```
    Returns whether an attribute with the given name is contained in this Entity-object.
    
    Parameters:
    
    attrName - the attribute name to be checked
    
    Returns:
    
    whether an attribute with the given name is contained in this Entity-object
  - isNull
```
public boolean isNull(java.lang.String attrName)
               throws java.lang.IllegalArgumentException
```
    Returns whether the specified attribute is null (not set) for this entity.
    
    Parameters:
    
    attrName - the attribute name to be checked
    
    Returns:
    
    whether the specified attribute is null (not set) for this entity
    
    Throws:
    
    java.lang.IllegalArgumentException - if the Entity-object doesn't contain an attribute with this name
  - removeAttribute
```
public void removeAttribute(java.lang.String attrName)
```
    Removes the given attribute from this entity.
    
    Parameters:
    
    attrName - the attribute to be removed from this entity
  - get
```
public java.lang.Object get(java.lang.String attrName)
                     throws java.lang.IllegalArgumentException
```
    Returns the value object for the given attribute name.
    
    Parameters:
    
    attrName - the attribute name for which the value object should be returned
    
    Returns:
    
    the value object for the given attribute name
    
    Throws:
    
    java.lang.IllegalArgumentException - if the Entity-object doesn't contain an attribute with this name
  - getInteger
```
public long getInteger(java.lang.String attrName)
                throws java.lang.IllegalArgumentException
```
    This method will return the attribute value as an int or 0 if it is null. Please make sure that the attribute really is an int. You will receive a ClassCastException if it isn't!
    
    Parameters:
    
    attrName - the attribute whose value should be returned as an int
    
    Returns:
    
    the attribute as an int; or 0 if it is null
    
    Throws:
    
    java.lang.IllegalArgumentException - if the Entity-object doesn't contain an attribute with this name
  - getFloat
```
public double getFloat(java.lang.String attrName)
                throws java.lang.IllegalArgumentException
```
    This method will return the attribute value as float or 0 if it is null. Please make sure that the attribute really is a float. You will receive a ClassCastException if it isn't!
    
    Parameters:
    
    attrName - the attribute whose value should be returned as float
    
    Returns:
    
    the attribute as float; or 0 if it is null
    
    Throws:
    
    java.lang.IllegalArgumentException - if the Entity-object doesn't contain an attribute with this name
  - getString
```
public java.lang.String getString(java.lang.String attrName)
                           throws java.lang.IllegalArgumentException
```
    This method will return the attribute value as String or null. Please make sure that the attribute really is a string. You will receive a ClassCastException if it isn't! If you need the attribute in string representation regardless of the actual type, get(..).toString() could be used instead.
    
    Parameters:
    
    attrName - the attribute whose value should be returned as String
    
    Returns:
    
    the attribute as string; or null
    
    Throws:
    
    java.lang.IllegalArgumentException - if the Entity-object doesn't contain an attribute with this name
  - getDate
```
public java.util.Date getDate(java.lang.String attrName)
                       throws java.lang.IllegalArgumentException
```
    This method will return the attribute value as Date or null. Please make sure that the attribute really is a date. You will receive a ClassCastException if it isn't!
    
    Parameters:
    
    attrName - the attribute whose value should be returned as Date
    
    Returns:
    
    the attribute as string; or null
    
    Throws:
    
    java.lang.IllegalArgumentException - if the Entity-object doesn't contain an attribute with this name
  - set
```
public void set(java.lang.String attrName,
                java.lang.Object value)
```
    Sets the given attribute to the given value. The attribute is added if it's not already contained in this entity-object.
    
    Parameters:
    
    attrName - the attribute to be set (and added if needed)
    
    value - the value of the attribute
  - setNull
```
public void setNull(java.lang.String attrName)
```
    Sets the given attribute to the given value. The attribute is added if it's not already contained in this entity-object.
    
    Parameters:
    
    attrName - the attribute to be set (and added if needed)
  - setInteger
```
public void setInteger(java.lang.String attrName,
                       long value)
```
    Sets the given attribute to the given value. The attribute is added if it's not already contained in this entity-object.
    
    Parameters:
    
    attrName - the attribute to be set (and added if needed)
    
    value - the value of the attribute
  - setFloat
```
public void setFloat(java.lang.String attrName,
                     double value)
```
    Sets the given attribute to the given value. The attribute is added if it's not already contained in this entity-object.
    
    Parameters:
    
    attrName - the attribute to be set (and added if needed)
    
    value - the value of the attribute
  - setString
```
public void setString(java.lang.String attrName,
                      java.lang.String value)
```
    Sets the given attribute to the given value. The attribute is added if it's not already contained in this entity-object.
    
    Parameters:
    
    attrName - the attribute to be set (and added if needed)
    
    value - the value of the attribute
  - setDate
```
public void setDate(java.lang.String attrName,
                    java.util.Date value)
```
    Sets the given attribute to the given value. The attribute is added if it's not already contained in this entity-object.
    
    Parameters:
    
    attrName - the attribute to be set (and added if needed)
    
    value - the value of the attribute
  - equals
```
public boolean equals(java.lang.Object obj)
```
    This implementation recognises two Entitys as equal if their ID attributes match. If either one of them does not have an ID this method returns false.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - clone
```
public Entity clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class Entity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Entity

Entity

Entity

Method Detail

getType

getAttributeCount

getAttributeNames

containsAttribute

isNull

removeAttribute

get

getInteger

getFloat

getString

getDate

set

setNull

setInteger

setFloat

setString

setDate

equals

hashCode

toString

clone