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

com.change_vision.jude.api.stpa.editor.StampModelEditor
All Superinterfaces:
ModelEditor
All Implemented Interfaces:
ModelEditor

public abstract StampModelEditor
extends ModelEditor

Interface to edit (create/delete) STAMP Models. Throws Exception when invalid models are generated.


Method Summary
abstract  IAccident createAccident(IStpaAnalysis owner, String description)
          Create Accident for StpaAnalysis.
abstract  IComponent createComponent(IStpaAnalysis owner, String name)
          Create a Component in a StpaAnalysis.
abstract  IComponent createComponent(IComponent owner, String name)
          Create a component in a owner component.
abstract  IControlAction createControlAction(IControlLink controlLink, String name)
          Create ControlAction for owner ControlLink
abstract  IControlLink createControlLink(ILinkableElement source, ILinkableElement target)
          Create a ControlLink between .LinkableElements.
abstract  ICountermeasure createCountermeasure(List<IHazardCausalFactor> hazardCausalFactors, String description)
          Create Countermeasure for HCF
abstract  IFeedback createFeedback(IFeedbackLink feedbackLink, String name)
          Create a Feedback for owner FeedbackLink
abstract  IFeedbackLink createFeedbackLink(ILinkableElement source, ILinkableElement target)
          Create a FeedbackLink between .LinkableElements.
abstract  IHazard createHazard(IStpaAnalysis owner, List<IAccident> accidents, String description)
          Create hazard for accident.
abstract  IHazardCausalFactor createHazardCausalFactor(IUnsafeControlAction unsafeControlAction, String description)
          Create UCF for UCA
abstract  IHazardScenario createHazardScenario(IHazardCausalFactor hazardCausalFactor, String description)
          Create HazardScenario for HCF
abstract  ILinkEnd createLinkEnd(IStpaAnalysis owner, String name)
          Create a LinkEnd in StpaAnalysis.
abstract  IStampComment createNonUnsafeControlAction(IControlAction controlAction, INamedElement guideWord, String body)
          Create NonUnsafeControlAction for ControlAction and guideword.
abstract  IPrecondition createPrecondition(IStpaAnalysis owner, String description)
          Create Precondition for StpaAnalysis.
abstract  IProcessModel createProcessModel(IComponent owner, String name)
          Create ProcessModel for a component
abstract  IProcessValue createProcessValue(IProcessVariable owner, String name)
          Create ProcessVariable Value for ProcessVariable.
abstract  IProcessVariable createProcessVariable(IProcessModel owner, String name)
          Create ProcessVariable for ProcessModel.
abstract  ISafetyConstraint createSafetyConstraint(IStpaAnalysis owner, List<IHazard> hazards, String description)
          Create SafetyConstraint for Hazard.
abstract  IUnsafeControlAction createUnsafeControlAction(IControlAction controlAction, INamedElement guideWord, String description)
          Create UCA for ControlAction and GuideWord
 
Methods inherited from class com.change_vision.jude.api.inf.editor.ModelEditor
changeParent, delete
 

Method Detail

createComponent

abstract IComponent createComponent(IStpaAnalysis owner,
                                    String name)
Create a Component in a StpaAnalysis.

Parameters:
owner - StpaAnalysis
name - Component Names
Returns:
IComponent Component
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createComponent

abstract IComponent createComponent(IComponent owner,
                                    String name)
Create a component in a owner component.

Parameters:
owner - Owner Component
name - Name
Returns:
IComponent Component
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createLinkEnd

abstract ILinkEnd createLinkEnd(IStpaAnalysis owner,
                                String name)
Create a LinkEnd in StpaAnalysis.

Parameters:
owner - StpaAnalysis
name - LinkEnd Name
Returns:
IComponent Component
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createControlLink

abstract IControlLink createControlLink(ILinkableElement source,
                                        ILinkableElement target)
Create a ControlLink between .LinkableElements.

Parameters:
source - Source LinkableElement
target - Target LinkableElement
Returns:
IControlLink Control Link
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createFeedbackLink

abstract IFeedbackLink createFeedbackLink(ILinkableElement source,
                                          ILinkableElement target)
Create a FeedbackLink between .LinkableElements.

Parameters:
source - Source LinkableElement
target - Target LinkableElement
Returns:
IFeedbackLink Feedback Link
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createControlAction

abstract IControlAction createControlAction(IControlLink controlLink,
                                            String name)
Create ControlAction for owner ControlLink

Parameters:
controlLink - ControlLink
name - ControlAction Name
Returns:
IControlAction Owner ControlAction Control Action
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createFeedback

abstract IFeedback createFeedback(IFeedbackLink feedbackLink,
                                  String name)
Create a Feedback for owner FeedbackLink

Parameters:
feedbackLink - Owner FeedbackLink
name - Feedback Name
Returns:
IFeedback Feedback
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createProcessModel

abstract IProcessModel createProcessModel(IComponent owner,
                                          String name)
Create ProcessModel for a component

Parameters:
IComponent - Component
name - ProcessModel Name
Returns:
IProcessModel Process Model
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createProcessVariable

abstract IProcessVariable createProcessVariable(IProcessModel owner,
                                                String name)
Create ProcessVariable for ProcessModel.

Parameters:
owner - ProcessModel
name - ProcessVariable Name
Returns:
IProcessVariable Process Variable
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createProcessValue

abstract IProcessValue createProcessValue(IProcessVariable owner,
                                          String name)
Create ProcessVariable Value for ProcessVariable.

Parameters:
owner - ProcessVariable
name - ProcessVariable Value Name
Returns:
IProcessValue Process Value
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createPrecondition

abstract IPrecondition createPrecondition(IStpaAnalysis owner,
                                          String description)
Create Precondition for StpaAnalysis.

Parameters:
owner - StpaAnalysis
description - Precondition description
Returns:
IPrecondition Precondition
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createAccident

abstract IAccident createAccident(IStpaAnalysis owner,
                                  String description)
Create Accident for StpaAnalysis.

Parameters:
owner - StpaAnalysis
description - Accident description
Returns:
IAccident Accident
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createHazard

abstract IHazard createHazard(IStpaAnalysis owner,
                              List<IAccident> accidents,
                              String description)
Create hazard for accident.

Parameters:
accidents - Accidents List
description - Hazard description
Returns:
IHazard Hazard
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createSafetyConstraint

abstract ISafetyConstraint createSafetyConstraint(IStpaAnalysis owner,
                                                  List<IHazard> hazards,
                                                  String description)
Create SafetyConstraint for Hazard.

Parameters:
owner - StpaAnalysis
hazards - Hazards
description - SafetyConstraint description
Returns:
ISafetyConstraint Safety Constraint
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createUnsafeControlAction

abstract IUnsafeControlAction createUnsafeControlAction(IControlAction controlAction,
                                                        INamedElement guideWord,
                                                        String description)
Create UCA for ControlAction and GuideWord

Parameters:
controlAction - ControlAction
guideWord - GuideWord
description - UCA Description
Returns:
IUnsafeControlAction Unsafe Control Action
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createNonUnsafeControlAction

abstract IStampComment createNonUnsafeControlAction(IControlAction controlAction,
                                                    INamedElement guideWord,
                                                    String body)
Create NonUnsafeControlAction for ControlAction and guideword.

Parameters:
controlAction - ControlAction
guideWord - guideWord
description - NonUnsafeControlAction descriptions
Returns:
IUnsafeControlAction Non Unsafe Control Action
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createHazardCausalFactor

abstract IHazardCausalFactor createHazardCausalFactor(IUnsafeControlAction unsafeControlAction,
                                                      String description)
Create UCF for UCA

Parameters:
unsafeControlAction - UCA
description - HCF description
Returns:
IHazardCausalFactor Hazard Causal Factor
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createCountermeasure

abstract ICountermeasure createCountermeasure(List<IHazardCausalFactor> hazardCausalFactors,
                                              String description)
Create Countermeasure for HCF

Parameters:
hazardCausalFactors - hazardCausalFactors
description - Countermeasure Description
Returns:
ICountermeasure Countermeasure
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.

createHazardScenario

abstract IHazardScenario createHazardScenario(IHazardCausalFactor hazardCausalFactor,
                                              String description)
Create HazardScenario for HCF

Parameters:
hazardCausalFactors - HCF
description - HazardScenario Description
Returns:
IHazardScenario Hazard Scenario
Throws:
InvalidEditingException - InvalidEditingException occurs.
Keys:
       PARAMETER_ERROR_KEY - if a parameter is not set properly.
       INVALID_PARENT_KEY - if the parent is invalid.
       INVALID_OWNER_KEY - if the owner is invalid.
       BAD_TRANSACTION_KEY - Bad Transaction.
Values:
       Error messages for exceptions.