Package com.aquima.interactions.mapping.ds

Interface IMappingDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ReportingMappingDS, XmlMappingDS
public interface IMappingDS extends IReportingDS
This interface returns the information needed to map the model of one application to another. The mapping information consists of two parts:
  • How the models should be mapped.
  • What part of the models should be mapped. Depending on the direction, only certain parts of the model may need to be transferred.
Since:
7.1
Author:
O. Kerpershoek

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Category
    CATEGORY
    This member defines the category that is used when reporting errors or warnings.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    This method returns a unique name of the mapping.
    String
    getSourceName()
    This method returns the name of the source module.
    Version
    getSourceVersion()
    This method returns the version of the source module.
    String
    getTargetName()
    This method returns the name of the target module.
    Version
    getTargetVersion()
    This method returns the version of the target module.
    void
    iterateMappings(IEntityMappingVisitor visitor)
    This method should iterate over all the entity mappings and add a data source for each mapping that should be used.

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

    addMessage

  • Field Details

    • CATEGORY

      static final Category CATEGORY
      This member defines the category that is used when reporting errors or warnings.

  • Method Details

    • getName

      String getName()
      This method returns a unique name of the mapping.
      Returns:
      The unique name, never null or empty.

    • iterateMappings

      void iterateMappings(IEntityMappingVisitor visitor)
      This method should iterate over all the entity mappings and add a data source for each mapping that should be used.
      Parameters:
      visitor - The visitor that should be used to add the entity mappings to.
      Throws:
      InitializationException - This exception is thrown when the mappings could not be initialized.

    • getSourceName

      String getSourceName()
      This method returns the name of the source module.
      Returns:
      The name of the source module.

    • getSourceVersion

      Version getSourceVersion()
      This method returns the version of the source module.
      Returns:
      the version of the source module.

    • getTargetName

      String getTargetName()
      This method returns the name of the target module.
      Returns:
      The name of the target module.

    • getTargetVersion

      Version getTargetVersion()
      This method returns the version of the target module.
      Returns:
      the version of the target module.