public interface IAnalystModel
Add the requirement containers and dictionaries can be accessed using this class.
To get the current requirement model, please do as following:
IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel = session.getRequirementModel();
This requirement model is accessible only if the Requirement MDAC is deployed in the project.
IUmlModel
Type | Property and Description |
---|---|
PropertyDefinition |
create
Create a new property.
The returned property has to be added to a property set, defined in the admin requirement model, using the PropertySet#getOwned() |
Modifier and Type | Field and Description |
---|---|
static String |
BUSINESS_RULE_CONTAINER_STEREOTYPE
The name of the stereotype defining a Business Rule Container.
|
static String |
BUSINESS_RULE_DIAGRAM_STEREOTYPE
The name of the stereotype defining a Business Rule Diagram.
|
static String |
BUSINESS_RULE_PROPERTYSET_STEREOTYPE
The name of the stereotype defining a Business Rule PropertySet.
|
static String |
BUSINESS_RULE_STEREOTYPE
The name of the stereotype defining a Business Rule.
|
static String |
DICTIONARY_DIAGRAM_STEREOTYPE
The name of the stereotype defining a Dictionary Diagram.
|
static String |
GOAL_CONTAINER_STEREOTYPE
The name of the stereotype defining a Goal Container.
|
static String |
GOAL_DIAGRAM_STEREOTYPE
The name of the stereotype defining a Goal Diagram.
|
static String |
GOAL_PROPERTYSET_STEREOTYPE
The name of the stereotype defining a Goal PropertySet.
|
static String |
GOAL_STEREOTYPE
The name of the stereotype defining a Goal.
|
static String |
REQUIREMENT_CONTAINER_STEREOTYPE
The name of the stereotype defining a Requirement Container.
|
static String |
REQUIREMENT_DIAGRAM_STEREOTYPE
The name of the stereotype defining a Requirement Diagram.
|
static String |
REQUIREMENT_PROPERTYSET_STEREOTYPE
The name of the stereotype defining a Requirement PropertySet.
|
static String |
REQUIREMENT_STEREOTYPE
The name of the stereotype defining a Requirement.
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertySet(PropertyTableDefinition set)
Add a new property set in the requirement administration model.
|
void |
addPropertyType(PropertyType type)
Add a new property type in the requirement admin model.
|
BusinessRule |
createBusinessRule()
Create a new BusinessRule without container.
The returned BusinessRule has to be added in the BusinessRule hierarchy. |
BusinessRule |
createBusinessRule(String name,
BusinessRule owner)
Create a new BusinessRule without container.
The returned BusinessRule has to be added in the BusinessRule hierarchy. |
BusinessRule |
createBusinessRule(String name,
BusinessRuleContainer owner)
Create a new BusinessRule without container.
The returned BusinessRule has to be added in the BusinessRule hierarchy. |
BusinessRuleContainer |
createBusinessRuleContainer()
Create a new BusinessRule container without container.
The returned BusinessRule container has to be added in the BusinessRule hierarchy. |
BusinessRuleContainer |
createBusinessRuleContainer(String name,
BusinessRuleContainer owner)
Create a new BusinessRule container without container.
The returned BusinessRule container has to be added in the BusinessRule hierarchy. |
Dictionary |
createDictionary()
Create a new dictionary without container.
The returned dictionary has to be added in the dictionary hierarchy. |
Dictionary |
createDictionary(String name,
Dictionary owner)
Create a new dictionary without container.
The returned dictionary has to be added in the dictionary hierarchy. |
EnumeratedPropertyType |
createEnumeratedPropertyType()
Create a new enumerated property type.
The returned property type has to be added in the admin requirement model, using the addPropertyType(PropertyType) method. |
Goal |
createGoal()
Create a new goal without container.
The returned goal has to be added in the goal hierarchy. |
Goal |
createGoal(String name,
Goal owner)
Create a new goal without container.
The returned goal has to be added in the goal hierarchy. |
Goal |
createGoal(String name,
GoalContainer owner)
Create a new goal without container.
The returned goal has to be added in the goal hierarchy. |
GoalContainer |
createGoalContainer()
Create a new goal container without container.
The returned goal container has to be added in the goal hierarchy. |
GoalContainer |
createGoalContainer(String name,
GoalContainer owner)
Create a new goal container without container.
The returned goal container has to be added in the goal hierarchy. |
PropertyDefinition |
createProperty()
Create a new property.
The returned property has to be added to a property set, defined in the admin requirement model, using the PropertySet#getOwned() |
PropertyEnumerationLitteral |
createPropertyEnumerationLitteral()
Create a new enumeration litteral for the enumerated property type.
The returned enumeration litteral has to be added to a enumerated property type. |
PropertyTableDefinition |
createPropertySet()
Create a new property set.
The returned property set has to be added to the admin requirement model, using the IAnalystModel#addPropertySet(PropertySet) method. |
AnalystPropertyTable |
createPropertyTable()
Create a new property value set.
The returned property value set has to be defined on the following elements: RequirementContainer, Requirement, Dictionary, Term. |
PropertyType |
createPropertyType()
Create a new simple property type.
The returned property type has to be added to the admin requirement model, using the addPropertyType(PropertyType) method. |
Requirement |
createRequirement()
Create a new requirement without container.
The returned requirement has to be added in the requirement container hierarchy. |
Requirement |
createRequirement(String name,
Requirement owner)
Create a new requirement without container.
The returned requirement has to be added in the requirement container hierarchy. |
Requirement |
createRequirement(String name,
RequirementContainer owner)
Create a new requirement without container.
The returned requirement has to be added in the requirement container hierarchy. |
RequirementContainer |
createRequirementContainer()
Create a new requirement container without container.
The returned requirement container has to be added in the requirement container hierarchy. |
RequirementContainer |
createRequirementContainer(String name,
RequirementContainer owner)
Create a new requirement container without container.
The returned requirement container has to be added in the requirement container hierarchy. |
Risk |
createRisk()
Create a new risk without container.
The returned risk has to be added in the risk container hierarchy. |
Risk |
createRisk(String name,
Risk owner)
Create a new risk without container.
The returned risk has to be added in the risk container hierarchy. |
Risk |
createRisk(String name,
RiskContainer owner)
Create a new risk without container.
The returned risk has to be added in the risk container hierarchy. |
RiskContainer |
createRiskContainer()
Create a new risk container without container.
The returned risk container has to be added in the risk container hierarchy. |
RiskContainer |
createRiskContainer(String name,
RiskContainer owner)
Create a new risk container without container.
The returned risk container has to be added in the risk container hierarchy. |
Term |
createTerm()
Create a new term without container.
The returned term has to be added in the dictionary hierarchy. |
Term |
createTerm(String name,
Dictionary owner)
Create a new term without container.
The returned term has to be added in the dictionary hierarchy. |
Test |
createTest()
Create a new test without container.
The returned test has to be added in the test container hierarchy. |
Test |
createTest(String name,
Test owner)
Create a new test without container.
The returned test has to be added in the test container hierarchy. |
Test |
createTest(String name,
TestContainer owner)
Create a new test without container.
The returned test has to be added in the test container hierarchy. |
TestContainer |
createTestContainer()
Create a new test container without container.
The returned test container has to be added in the test container hierarchy. |
TestContainer |
createTestContainer(String name,
TestContainer owner)
Create a new test container without container.
The returned test container has to be added in the test container hierarchy. |
List<PropertyTableDefinition> |
getPropertySets()
Get the list of known property sets.
|
List<PropertyType> |
getPropertyTypes()
Get the list of known property types.
|
List<BusinessRuleContainer> |
getRootBusinessRuleContainer()
Get the main business rules container that owns the business rules elements.
The requirement elements are the business rules containers and business rules. |
List<Dictionary> |
getRootDictionary()
Get the main dictionary that owns the sub dictionaries and terms.
|
List<GoalContainer> |
getRootGoalContainer()
Get the main goal container that owns the goal elements.
The requirement elements are the goal containers and goals. |
List<RequirementContainer> |
getRootRequirementContainer()
Get the main requirement container that owns the requirement elements.
The requirement elements are the requirement containers and requirements. |
void |
removePropertySet(PropertyTableDefinition set)
Remove an existing property set from the requirement administration model.
|
void |
removePropertyType(PropertyType type)
Remove an existing property type from the requirement administration model.
|
PropertyDefinition createProperty
PropertySet#getOwned()
static final String BUSINESS_RULE_CONTAINER_STEREOTYPE
static final String BUSINESS_RULE_DIAGRAM_STEREOTYPE
static final String BUSINESS_RULE_PROPERTYSET_STEREOTYPE
static final String BUSINESS_RULE_STEREOTYPE
static final String DICTIONARY_DIAGRAM_STEREOTYPE
static final String GOAL_CONTAINER_STEREOTYPE
static final String GOAL_DIAGRAM_STEREOTYPE
static final String GOAL_PROPERTYSET_STEREOTYPE
static final String GOAL_STEREOTYPE
static final String REQUIREMENT_CONTAINER_STEREOTYPE
static final String REQUIREMENT_DIAGRAM_STEREOTYPE
static final String REQUIREMENT_PROPERTYSET_STEREOTYPE
static final String REQUIREMENT_STEREOTYPE
void addPropertySet(PropertyTableDefinition set)
New property sets can be created, using the createPropertySet()
method and can added to
this model through the use of this method.
set
- property set#removePropertySet(PropertySet)
void addPropertyType(PropertyType type)
New property types can be created, using the createPropertyType()
method and can added
to this model through the use of this method.
type
- property typeremovePropertyType(PropertyType)
BusinessRule createBusinessRule()
BusinessRule createBusinessRule(String name, BusinessRule owner)
BusinessRule createBusinessRule(String name, BusinessRuleContainer owner)
BusinessRuleContainer createBusinessRuleContainer()
BusinessRuleContainer createBusinessRuleContainer(String name, BusinessRuleContainer owner)
Dictionary createDictionary()
IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
Dictionary root = model.getRootDictionary();
Dictionary newDictionary = model.createDictionary();
newDictionary.setName ("dic1");
root.addOwned (newDictionary);
Dictionary createDictionary(String name, Dictionary owner)
IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
Dictionary root = model.getRootDictionary();
Dictionary newDictionary = model.createDictionary();
newDictionary.setName ("dic1");
root.addOwned (newDictionary);
EnumeratedPropertyType createEnumeratedPropertyType()
addPropertyType(PropertyType)
method.addPropertyType(PropertyType)
Goal createGoal()
Goal createGoal(String name, GoalContainer owner)
Goal createGoal(String name, Goal owner)
GoalContainer createGoalContainer()
GoalContainer createGoalContainer(String name, GoalContainer owner)
PropertyDefinition createProperty()
PropertySet#getOwned()
PropertyEnumerationLitteral createPropertyEnumerationLitteral()
EnumeratedPropertyType.getLitteral()
PropertyTableDefinition createPropertySet()
IAnalystModel#addPropertySet(PropertySet)
method.IAnalystModel#addPropertySet(PropertySet)
AnalystPropertyTable createPropertyTable()
RequirementContainer#setDefaultSet(PropertyValueSet)
,
Requirement#setProperties(PropertyValueSet)
,
Dictionary#setDefaultSet(PropertyValueSet)
,
Term#setProperties(PropertyValueSet)
PropertyType createPropertyType()
addPropertyType(PropertyType)
method.addPropertyType(PropertyType)
Requirement createRequirement()
IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
RequirementContainer root = model.getRootContainer();
Requirement newRequirement = model.createRequirement();
newRequirement.setName ("req1");
newRequirement.setText ("All the methods have to be documented");
root.addOwned (newRequirement);
Requirement createRequirement(String name, Requirement owner)
IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
RequirementContainer root = model.getRootContainer();
Requirement newRequirement = model.createRequirement();
newRequirement.setName ("req1");
newRequirement.setText ("All the methods have to be documented");
root.addOwned (newRequirement);
Requirement createRequirement(String name, RequirementContainer owner)
IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
RequirementContainer root = model.getRootContainer();
Requirement newRequirement = model.createRequirement();
newRequirement.setName ("req1");
newRequirement.setText ("All the methods have to be documented");
root.addOwned (newRequirement);
RequirementContainer createRequirementContainer()
IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
RequirementContainer root = model.getRootContainer();
RequirementContainer newRequirementContainer = model.createRequirement();
newRequirementContainer.setName ("functional requirements");
root.addOwned (newRequirementContainer);
RequirementContainer createRequirementContainer(String name, RequirementContainer owner)
IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
RequirementContainer root = model.getRootContainer();
RequirementContainer newRequirementContainer = model.createRequirement();
newRequirementContainer.setName ("functional requirements");
root.addOwned (newRequirementContainer);
Term createTerm()
IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
Dictionary root = model.getRootDictionary();
Term newTerm = model.createRequirement();
newTerm.setName ("system");
newTerm.setDefinition ("The system is the place where the program should run");
root.addOwned (newTerm);
Term createTerm(String name, Dictionary owner)
IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
Dictionary root = model.getRootDictionary();
Term newTerm = model.createRequirement();
newTerm.setName ("system");
newTerm.setDefinition ("The system is the place where the program should run");
root.addOwned (newTerm);
List<PropertyTableDefinition> getPropertySets()
Default property sets already exist and can be extended by the user. This method permits to return the list of known property sets.
List<PropertyType> getPropertyTypes()
Default property types already exist and can be extended by the user. This method permits to return the list of known property types.
List<BusinessRuleContainer> getRootBusinessRuleContainer()
List<Dictionary> getRootDictionary()
List<GoalContainer> getRootGoalContainer()
List<RequirementContainer> getRootRequirementContainer()
void removePropertySet(PropertyTableDefinition set)
set
- property set#addPropertySet(PropertySet)
void removePropertyType(PropertyType type)
type
- property typeaddPropertyType(PropertyType)
Risk createRisk()
Risk createRisk(String name, Risk owner)
Risk createRisk(String name, RiskContainer owner)
RiskContainer createRiskContainer()
RiskContainer createRiskContainer(String name, RiskContainer owner)
Test createTest()
Test createTest(String name, Test owner)
Test createTest(String name, TestContainer owner)
TestContainer createTestContainer()
TestContainer createTestContainer(String name, TestContainer owner)