com.change_vision.jude.api.stpa.editor
Interface StampDiagramEditor

com.change_vision.jude.api.stpa.editor.StampDiagramEditor

All Superinterfaces:

BasicDiagramEditor, DiagramEditor

All Implemented Interfaces:

BasicDiagramEditor, DiagramEditor

public abstract StampDiagramEditor
extends BasicDiagramEditor

Interface to create presentations in STAMP Diagram.

Method Summary

abstract IControlLoopDiagram	createControlLoopDiagram(ILinkPresentation controlLink, String name) Create Control Link Diagram for owner Control Link.
abstract IControlStructureDiagram	createControlStructureDiagram(INamedElement owner, String name) Create Control Structure Diagram in owner NamedElement .
abstract ILinkPresentation	createLinkPresentation(IElement model, INodePresentation source, INodePresentation target) Create a Link Presentation.
abstract INodePresentation	createNodePresentation(IElement model, Point2D location) Create a Presentation on a parent.
abstract INodePresentation	createNodePresentation(IElement model, INodePresentation parent, Point2D location) Create a Presentation in a parent Presentation.
abstract IAccidentHazardSafetyConstraintTable	createOrGetAccidentHazardSafetyConstraintTable(IStpaAnalysis analysis, String name) Create Accident Hazard Safety Constraint Table for StpaAnalysis.
abstract ICountermeasureTable	createOrGetCountermeasureTable(IStpaAnalysis analysis, String name) Create Countermeasure Table for StpaAnalysis.
abstract ILossScenarioTable	createOrGetLossScenarioTable(IUnsafeControlAction unsafeControlAction, String name) Create LossScenario Table for UCA.
abstract IPreconditionTable	createOrGetPreconditionTable(IStpaAnalysis analysis, String name) Create Precondition Table for StpaAnalysis.
abstract IUCATable	createOrGetUCATable(IControlStructureDiagram diagram, String name) Create UCATable for Control Structure Diagram.

Methods inherited from class com.change_vision.jude.api.inf.editor.BasicDiagramEditor

createNote, createNoteAnchor, createNoteAnchor

Methods inherited from class com.change_vision.jude.api.inf.editor.DiagramEditor

createImage, createImage, createLine, createRect, createText, delete, deleteDiagram, deletePresentation, getDiagram, setDiagram

Method Detail

createControlStructureDiagram

abstract IControlStructureDiagram createControlStructureDiagram(INamedElement owner,
                                                                String name)

Create Control Structure Diagram in owner NamedElement . Diagram is set to DiagramEditor (DiagramEditor.setDiagram(IDiagram diagram)) if the diagram is created successfully.

Parameters:

owner - NamedElement

name - Control Structure Diagram Name

Returns:

IControlStructureDiagram Control Structure Diagram

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       BAD_TRANSACTION_KEY - Bad Transaction.

Values:
       Error messages for exceptions.

createControlLoopDiagram

abstract IControlLoopDiagram createControlLoopDiagram(ILinkPresentation controlLink,
                                                      String name)

Create Control Link Diagram for owner Control Link. Diagram is set to DiagramEditor (DiagramEditor.setDiagram(IDiagram diagram)) if the diagram is created successfully.

Parameters:

controlLink - control Link

name - Control Link Diagram name

Returns:

IControlLoopDiagram Control Loop Diagram

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       BAD_TRANSACTION_KEY - Bad Transaction.

Values:
       Error messages for exceptions.

createOrGetPreconditionTable

abstract IPreconditionTable createOrGetPreconditionTable(IStpaAnalysis analysis,
                                                         String name)

Create Precondition Table for StpaAnalysis. Table is set to DiagramEditor (DiagramEditor.setDiagram(IDiagram diagram)) if the table is created successfully. If there is Precondition Table for StpaAnalysis,the table will be returned,otherwise,PreconditionTable can be created.

Parameters:

analysis - StpaAnalysis

name - Table Name

Returns:

IPreconditionTable Precondition Table

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       BAD_TRANSACTION_KEY - Bad Transaction.

Values:
       Error messages for exceptions.

createOrGetAccidentHazardSafetyConstraintTable

abstract IAccidentHazardSafetyConstraintTable createOrGetAccidentHazardSafetyConstraintTable(IStpaAnalysis analysis,
                                                                                             String name)

Create Accident Hazard Safety Constraint Table for StpaAnalysis. Table is set to DiagramEditor (DiagramEditor.setDiagram(IDiagram diagram)) if the table is created successfully. If there is Accident Hazard SafetyConstraint Table for StpaAnalysis,the table will be returned even the name of the table is different, otherwise,Accident Hazard SafetyConstraintTable can be created.

Parameters:

analysis - StpaAnalysis

name - Table Name

Returns:

IAccidentHazardSafetyConstraintTable Accident Hazard SafetyConstraint Table

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       BAD_TRANSACTION_KEY - Bad Transaction.

Values:
       Error messages for exceptions.

createOrGetUCATable

abstract IUCATable createOrGetUCATable(IControlStructureDiagram diagram,
                                       String name)

Create UCATable for Control Structure Diagram. Table is set to DiagramEditor (DiagramEditor.setDiagram(IDiagram diagram)) if the table is created successfully. If there is UCATable for the Control Structure Diagram,the table will be returned even the name of the table is different, otherwise,UCATable can be created.

Parameters:

diagram - Control Structure Diagram

name - Diagram Name

Returns:

IUCATable UCA Table

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       BAD_TRANSACTION_KEY - Bad Transaction.

Values:
       Error messages for exceptions.

createOrGetLossScenarioTable

abstract ILossScenarioTable createOrGetLossScenarioTable(IUnsafeControlAction unsafeControlAction,
                                                         String name)

Create LossScenario Table for UCA. Table is set to DiagramEditor (DiagramEditor.setDiagram(IDiagram diagram)) if the table is created successfully. If there is LossScenario Table for the UCA,the table will be returned.

Parameters:

unsafeControlAction - UnsafeControlAction

name - Table Name

Returns:

ILossScenarioTable LossScenario Table

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       BAD_TRANSACTION_KEY - Bad Transaction.

Values:
       Error messages for exceptions.

createOrGetCountermeasureTable

abstract ICountermeasureTable createOrGetCountermeasureTable(IStpaAnalysis analysis,
                                                             String name)

Create Countermeasure Table for StpaAnalysis. Table is set to DiagramEditor (DiagramEditor.setDiagram(IDiagram diagram)) if the table is created successfully. If there is Countermeasure Table for the StpaAnalysis,the table will be returned.

Parameters:

analysis - StpaAnalysis

name - Table Name

Returns:

ICountermeasureTable Countermeasure Table

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       BAD_TRANSACTION_KEY - Bad Transaction.

Values:
       Error messages for exceptions.

createNodePresentation

abstract INodePresentation createNodePresentation(IElement model,
                                                  Point2D location)

Create a Presentation on a parent.

Parameters:

model - Model

location - Location

Returns:

INodePresentation Node Presentation

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       BAD_TRANSACTION_KEY - Bad Transaction.
       INVALID_DIAGRAM_ERROR_KEY - if a diagram of an element is not correct.

Values:
       Error messages for exceptions.

createNodePresentation

abstract INodePresentation createNodePresentation(IElement model,
                                                  INodePresentation parent,
                                                  Point2D location)

Create a Presentation in a parent Presentation.

Parameters:

model - model

parent - Parent Presentation

location - Location

Returns:

INodePresentation Node Presentation

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       BAD_TRANSACTION_KEY - Bad Transaction.
       INVALID_DIAGRAM_ERROR_KEY - if a diagram of an element is not correct.

Values:
       Error messages for exceptions.

createLinkPresentation

abstract ILinkPresentation createLinkPresentation(IElement model,
                                                  INodePresentation source,
                                                  INodePresentation target)

Create a Link Presentation.

Parameters:

model - Model

source - Source Presentation

target - Target Presentation

Returns:

Link Presentation

Throws:

InvalidEditingException - InvalidEditingException occurs.

Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       NO_TARGET_DIAGRAM_KEY - if target Diagram is not set.
       INVALID_DIAGRAM_ERROR_KEY - if a diagram of an element is not correct.

Values:
       Error messages for exceptions.