Package com.aquima.interactions.metamodel.ds

Interface IMetaModelDS

All Superinterfaces:

IReportingDS

All Known Implementing Classes:

MetaModelDelegateDS, MetaModelDS, MetaModelDS, ReportingMetaModelDS, XmlMetaModelDS, XmlMetaModelDS

public interface IMetaModelDS
extends IReportingDS

This interface defines the methods that should be implemented to initialize a meta model.

Copyright: Copyright (c) 2003

Company: Everest b.v.

Since:

5.0

Author:

O. Kerpershoek

Field Summary

Fields

Modifier and Type	Field	Description
static final Category	CATEGORY	Category that should be used when reporting errors or warnings that are encountered during initialization.

Method Summary

Modifier and Type	Method	Description
String	getModuleName()	This method returns the name of the module this model belongs to.
Version	getModuleVersion()	This method returns the version of the module this model belongs to.
void	iterateAggregates(IAggregateVisitor visitor)	This method will be invoked by the meta model component to allow the data layer to add new aggregate definitions to the meta model.
void	iterateDomains(IDomainVisitor visitor)	This method will be invoked by the meta model component to allow the data layer to add new domain definitions to the meta model.
void	iterateEntities(IEntityVisitor visitor)	This method will be invoked by the meta model component to allow the data layer to add new entity definitions to the meta model.
void	iterateInstances(IInstanceVisitor visitor)	This method should iterate over all (static) instances and invoke the visitor with an implementation of IStaticInstanceDS to allow the instance to be initialized.

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

addMessage

Field Details

CATEGORY

static final Category CATEGORY

Category that should be used when reporting errors or warnings that are encountered during initialization.

Method Details

getModuleName

String getModuleName()

This method returns the name of the module this model belongs to.

Returns:

the name of the module this model belongs to.

getModuleVersion

Version getModuleVersion()

This method returns the version of the module this model belongs to.

Returns:

The version of the module this model belongs to.

iterateDomains

void iterateDomains(IDomainVisitor visitor)

This method will be invoked by the meta model component to allow the data layer to add new domain definitions to the meta model.

Parameters:

visitor - This object will be provided by the meta model to allow new domains to be added.

Throws:

InitializationException - This error is thrown when an error is encountered during the processing of the domains.

iterateEntities

void iterateEntities(IEntityVisitor visitor)

This method will be invoked by the meta model component to allow the data layer to add new entity definitions to the meta model.

Parameters:

visitor - The visitor that should be used to add the entities to.

Throws:

InitializationException - This error is thrown when an error is encountered during the processing of the entities.

iterateInstances

void iterateInstances(IInstanceVisitor visitor)

This method should iterate over all (static) instances and invoke the visitor with an implementation of IStaticInstanceDS to allow the instance to be initialized.

Parameters:

visitor - The visitor that should be used to add the instances to.

Throws:

InitializationException - This error is thrown when an error is encountered during the processing of the instances.

iterateAggregates

void iterateAggregates(IAggregateVisitor visitor)

This method will be invoked by the meta model component to allow the data layer to add new aggregate definitions to the meta model.

Parameters:

visitor - This object will be provided by the meta model to allow new aggregates to be added.

Throws:

InitializationException - This error is thrown if something goes wrong while processing the aggregates,