nl.tue.buildingsmart.express.population

Class EntityInstance

java.lang.Object

nl.tue.buildingsmart.express.population.EntityInstance

public class EntityInstance
extends Object

Author:

Jakob Beetz j.beetz@tue.nl

The EntityInstance gives access to an EXPRESS entity instance generated i.e. by reading in a SPFF / p21 file.

Depending on the type of the EntityInstance that can be retrieved with the getEntityDefinition() function, the attributes can be retrieved as an ArrayList or by their name.

Member functions that have a "BN" in their name, e.g. "getAttributeValueBN" take a string argument to get a certain attribute value by its name according to the schema definition. (Roughly oriented at SDAI)

Constructor Summary

Constructors

Constructor and Description
EntityInstance(ModelPopulation model, int id)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(AttributeInstance attribute)
void	addReference(EntityInstance instance)
ArrayList<AttributeInstance>	getAttributes() disscuraged to call this and operate on the attributes directly
Object	getAttributeValueBN(String attributeName) get an attribute of this EntityInstance by its name an return its value as an Object.
EntityInstance	getAttributeValueBNasEntityInstance(String attributeName) Try to get the attribute by its name and return it as an EntityInstance
ArrayList<EntityInstance>	getAttributeValueBNasEntityInstanceList(String attributeName)
String	getAttributeValueBNasString(String attributeName) get an attribute value by its name and return the value as a string
EntityDefinition	getEntityDefinition()
int	getId()
ModelPopulation	getModel()
int	getNumAttribues() get the number of attributes of this instance
ArrayList<EntityInstance>	getReferneces()
void	setAttributes(ArrayList<AttributeInstance> attributes)
void	setEntityDefinition(EntityDefinition entDef)
void	setId(int id)
void	setModel(ModelPopulation model)
void	setReferneces(ArrayList<EntityInstance> referneces)

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityInstance

public EntityInstance(ModelPopulation model,
                      int id)

Method Detail

getAttributes

public ArrayList<AttributeInstance> getAttributes()

disscuraged to call this and operate on the attributes directly

Returns:

the list of attributes for this EntityInstance

addAttribute

public void addAttribute(AttributeInstance attribute)

setAttributes

public void setAttributes(ArrayList<AttributeInstance> attributes)

getEntityDefinition

public EntityDefinition getEntityDefinition()

setEntityDefinition

public void setEntityDefinition(EntityDefinition entDef)

getId

public int getId()

setId

public void setId(int id)

getReferneces

public ArrayList<EntityInstance> getReferneces()

addReference

public void addReference(EntityInstance instance)

setReferneces

public void setReferneces(ArrayList<EntityInstance> referneces)

getAttributeValueBN

public Object getAttributeValueBN(String attributeName)

get an attribute of this EntityInstance by its name an return its value as an Object. Possible object types include EntityInstance, literal values or aggregate types.

Parameters:

attributeName -

Returns:

the value of the attribute as an object

getAttributeValueBNasString

public String getAttributeValueBNasString(String attributeName)

get an attribute value by its name and return the value as a string

Parameters:

attributeName -

Returns:

a string representation of the Value of the attribute

getNumAttribues

public int getNumAttribues()

get the number of attributes of this instance

Returns:

the number of attributes

getAttributeValueBNasEntityInstance

public EntityInstance getAttributeValueBNasEntityInstance(String attributeName)

Try to get the attribute by its name and return it as an EntityInstance

Parameters:

attributeName -

Returns:

the EntityInstance or null if its not an EntityInstance but a e.g. a literal or an Aggregate

getAttributeValueBNasEntityInstanceList

public ArrayList<EntityInstance> getAttributeValueBNasEntityInstanceList(String attributeName)

Parameters:

attributeName - the case-sensitive name of the AttributeInstance to retrieve

Returns:

getModel

public ModelPopulation getModel()

setModel

public void setModel(ModelPopulation model)