Interface IValueVisitor

All Known Implementing Classes:
InstanceValueVisitor, ReportingValueVisitor

public interface IValueVisitor
This interface is used during initialization to add values to an instance definition.
Since:
5.0
Author:
O. Kerpershoek
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addChild(String attribute, IInstanceDS childDS)
    This method can be used to add an anonymous child instance.
    void
    addRelation(String attribute, String entityType, String instanceName)
    This method can be invoked to link the attribute to another static instance.
    void
    setValue(String attribute, IValue attributeValue)
    When a setValue is invoked for a relation attribute, the value should be either the name or the ID of the (static) instance that should be referenced.
  • Method Details

    • setValue

      void setValue(String attribute, IValue attributeValue)
      When a setValue is invoked for a relation attribute, the value should be either the name or the ID of the (static) instance that should be referenced.
      Parameters:
      attribute - The name of the attribute of which the value should be set.
      attributeValue - The value for the attribute.
      Throws:
      InitializationException - This exception is raised when the value could not be set.
    • addChild

      void addChild(String attribute, IInstanceDS childDS)
      This method can be used to add an anonymous child instance. To add a reference to another static instance use the addRelation method instead.
      Parameters:
      attribute - The name of the attribute to which the child instance definition should be added.
      childDS - The data source that provides the information for the child instance.
      Throws:
      InitializationException - This exception is thrown when the child instance could not be added.
    • addRelation

      void addRelation(String attribute, String entityType, String instanceName)
      This method can be invoked to link the attribute to another static instance. Both the name and the type of the static instance should be provided, as the name of an instance needs only be unique amongst the other instances of that type.
      Parameters:
      attribute - The name of the attribute to which the child instance definition should be added.
      entityType - The type of the instance the relation should refer to.
      instanceName - The name of the instance the relation should refer to.
      Throws:
      InitializationException - This exception is raised when the instance relation could not be added.