Package io.github.webbasedwodt.application.component

Interface DTKGEngine

All Superinterfaces:
DTKGEngineReader
public interface DTKGEngine extends DTKGEngineReader
This interface models the DTKGEngine component of the Abstract Architecture in a compatible way with the WLDT Framework.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAction(it.wldt.core.state.DigitalTwinStateAction action)
    Add an available action on the Digital Twin Knowledge Graph.
    void
    addDigitalTwinProperty(it.wldt.core.state.DigitalTwinStateProperty<?> property)
    Add a Digital Twin property within the Digital Twin Knowledge Graph.
    void
    addDTKGObserver(DTKGObserver observer)
    Add a DTKGObserver that will be notified for each DTKG update.
    void
    addRelationship(it.wldt.core.state.DigitalTwinStateRelationshipInstance<?> relationshipInstance)
    Add a relationship with another Digital Twin.
    void
    commitUpdateTransaction()
    Commits a transaction, notifying all the observers about the changes occurred in the DTKG update.
    boolean
    removeAction(it.wldt.core.state.DigitalTwinStateAction action)
    Remove an action from the Digital Twin Knowledge Graph.
    void
    removeDigitalTwin()
    Method that allows to signal the deletion or the stop of the underlying Digital Twin.
    boolean
    removeProperty(it.wldt.core.state.DigitalTwinStateProperty<?> property)
    Remove a Digital Twin property within the Digital Twin Knowledge Graph.
    boolean
    removeRelationship(it.wldt.core.state.DigitalTwinStateRelationshipInstance<?> relationshipInstance)
    Delete an existing relationship with another Digital Twin.
    void
    updateDigitalTwinProperty(it.wldt.core.state.DigitalTwinStateProperty<?> property, it.wldt.core.state.DigitalTwinStateProperty<?> oldProperty)
    Update a Digital Twin property within the Digital Twin Knowledge Graph.

    Methods inherited from interface io.github.webbasedwodt.application.component.DTKGEngineReader

    getCurrentDigitalTwinKnowledgeGraph

  • Method Details

    • removeDigitalTwin

      void removeDigitalTwin()
      Method that allows to signal the deletion or the stop of the underlying Digital Twin.

    • addDigitalTwinProperty

      void addDigitalTwinProperty(it.wldt.core.state.DigitalTwinStateProperty<?> property)
      Add a Digital Twin property within the Digital Twin Knowledge Graph.
      Parameters:
      property - the property to add

    • updateDigitalTwinProperty

      void updateDigitalTwinProperty(it.wldt.core.state.DigitalTwinStateProperty<?> property, it.wldt.core.state.DigitalTwinStateProperty<?> oldProperty)
      Update a Digital Twin property within the Digital Twin Knowledge Graph.
      Parameters:
      property - the property to update
      oldProperty - the old property that has been updated

    • removeProperty

      boolean removeProperty(it.wldt.core.state.DigitalTwinStateProperty<?> property)
      Remove a Digital Twin property within the Digital Twin Knowledge Graph.
      Parameters:
      property - the property to delete.
      Returns:
      true if deleted, false if not-existent.

    • addRelationship

      void addRelationship(it.wldt.core.state.DigitalTwinStateRelationshipInstance<?> relationshipInstance)
      Add a relationship with another Digital Twin.
      Parameters:
      relationshipInstance - the relationship instance to add.

    • removeRelationship

      boolean removeRelationship(it.wldt.core.state.DigitalTwinStateRelationshipInstance<?> relationshipInstance)
      Delete an existing relationship with another Digital Twin.
      Parameters:
      relationshipInstance - the relationship instance to remove.
      Returns:
      true if correctly deleted, false if the relationship doesn't exist

    • addAction

      void addAction(it.wldt.core.state.DigitalTwinStateAction action)
      Add an available action on the Digital Twin Knowledge Graph.
      Parameters:
      action - the action to add.

    • removeAction

      boolean removeAction(it.wldt.core.state.DigitalTwinStateAction action)
      Remove an action from the Digital Twin Knowledge Graph.
      Parameters:
      action - the action to remove
      Returns:
      true if correctly deleted, false if the action id doesn't exist

    • addDTKGObserver

      void addDTKGObserver(DTKGObserver observer)
      Add a DTKGObserver that will be notified for each DTKG update.
      Parameters:
      observer - the observer to add.

    • commitUpdateTransaction

      void commitUpdateTransaction()
      Commits a transaction, notifying all the observers about the changes occurred in the DTKG update.