Package com.aquima.interactions.metamodel.ds.xml.r12.parsing

Class XmlEntityDS

java.lang.Object

com.aquima.interactions.foundation.report.ReportingDS

com.aquima.interactions.metamodel.ds.xml.r12.parsing.XmlEntityDS

All Implemented Interfaces:

IReportingDS, IEntityDS

public class XmlEntityDS
extends ReportingDS
implements IEntityDS

Xml datasource implementation.

Since:

7.2

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XmlEntityDS(IInitializationReport report, IXmlNode node)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	This method return the description for this entity.
String	getId()	This method returns the unique identifier of the entity, consisting of the lowercased entity name.
String	getName()	This method returns the unique name of the entity.
String	getSingletonName()	This method may return the name that should be used when creating a singleton instance for this entity.
String	getSuperType()	This method returns the name of the super type of the entity.
boolean	isAbstract()	This method returns a boolean indicating if the entity definition is abstract, and may only used as super type of other entity definitions.
boolean	isSingleton()	This method returns a boolean indicating if only a single instance of this type may exist at runtime.
void	iterateAttributes(IAttributeVisitor visitor)	This method will be invoked by the meta model component to request the information of all attributes that are defined for this entity.

Methods inherited from class com.aquima.interactions.foundation.report.ReportingDS

addError, addMessage, getCategory, getReport

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

addMessage

Constructor Details

XmlEntityDS

protected XmlEntityDS(IInitializationReport report,
 IXmlNode node)

Method Details

getDescription

public String getDescription()

Description copied from interface: IEntityDS

This method return the description for this entity.

Specified by:

getDescription in interface IEntityDS

Returns:

Return the description for this entity

getId

public String getId()

Description copied from interface: IEntityDS

This method returns the unique identifier of the entity, consisting of the lowercased entity name.

Specified by:

getId in interface IEntityDS

Returns:

the unique identifier of the entity.

getName

public String getName()

Description copied from interface: IEntityDS

This method returns the unique name of the entity.

Specified by:

getName in interface IEntityDS

Returns:

name of the entity

getSingletonName

public String getSingletonName()

Description copied from interface: IEntityDS

This method may return the name that should be used when creating a singleton instance for this entity. The name of a singleton is only relevant when isSingleton method returns true.

Specified by:

getSingletonName in interface IEntityDS

Returns:

This method returns the name of the singleton instance.

getSuperType

public String getSuperType()

Description copied from interface: IEntityDS

This method returns the name of the super type of the entity. When the entity does not have any super type, the method should return a null value.

Specified by:

getSuperType in interface IEntityDS

Returns:

name of the super type of this entity

isAbstract

public boolean isAbstract()

Description copied from interface: IEntityDS

This method returns a boolean indicating if the entity definition is abstract, and may only used as super type of other entity definitions. Abstract entities can never be instantiated in the profile. If an entity is defined both abstract and singleton, the profile may hold multiple instances of this type, but each instance of an entity extending this abstract type must be a singleton.

Specified by:

isAbstract in interface IEntityDS

Returns:

A boolean indicating if the entity definition is abstract.

isSingleton

public boolean isSingleton()

Description copied from interface: IEntityDS

This method returns a boolean indicating if only a single instance of this type may exist at runtime.

Specified by:

isSingleton in interface IEntityDS

Returns:

A boolean indicating whether only a single instance of this type may exist at runtime.

iterateAttributes

public void iterateAttributes(IAttributeVisitor visitor)

Description copied from interface: IEntityDS

This method will be invoked by the meta model component to request the information of all attributes that are defined for this entity.

Specified by:

iterateAttributes in interface IEntityDS

Parameters:

visitor - The visitor that should be used to add the attribute definitions to.