com.modeliosoft.modelio.analyst.model

Interface IAnalystModel

public interface IAnalystModel

This class represents the root model of requirement classes.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUSINESS_RULE_CONTAINER_STEREOTYPE The name of the stereotype defining a Business Rule Container.
static java.lang.String	BUSINESS_RULE_DIAGRAM_STEREOTYPE The name of the stereotype defining a Business Rule Diagram.
static java.lang.String	BUSINESS_RULE_PropertyTableDefinition_STEREOTYPE The name of the stereotype defining a Business Rule PropertyTableDefinition.
static java.lang.String	BUSINESS_RULE_STEREOTYPE The name of the stereotype defining a Business Rule.
static java.lang.String	DICTIONARY_DIAGRAM_STEREOTYPE The name of the stereotype defining a Dictionary Diagram.
static java.lang.String	GOAL_CONTAINER_STEREOTYPE The name of the stereotype defining a Goal Container.
static java.lang.String	GOAL_DIAGRAM_STEREOTYPE The name of the stereotype defining a Goal Diagram.
static java.lang.String	GOAL_PropertyTableDefinition_STEREOTYPE The name of the stereotype defining a Goal PropertyTableDefinition.
static java.lang.String	GOAL_STEREOTYPE The name of the stereotype defining a Goal.
static java.lang.String	REQUIREMENT_CONTAINER_STEREOTYPE The name of the stereotype defining a Requirement Container.
static java.lang.String	REQUIREMENT_DIAGRAM_STEREOTYPE The name of the stereotype defining a Requirement Diagram.
static java.lang.String	REQUIREMENT_PropertyTableDefinition_STEREOTYPE The name of the stereotype defining a Requirement PropertyTableDefinition.
static java.lang.String	REQUIREMENT_STEREOTYPE The name of the stereotype defining a Requirement.

Method Summary

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.
BusinessRule	createBusinessRule(java.lang.String name, BusinessRule owner) Create a new BusinessRule without container.
BusinessRule	createBusinessRule(java.lang.String name, BusinessRuleContainer owner) Create a new BusinessRule without container.
BusinessRuleContainer	createBusinessRuleContainer() Create a new BusinessRule container without container.
BusinessRuleContainer	createBusinessRuleContainer(java.lang.String name, BusinessRuleContainer owner) Create a new BusinessRule container without container.
Dictionary	createDictionary() Create a new dictionary without container.
Dictionary	createDictionary(java.lang.String name, Dictionary owner) Create a new dictionary without container.
EnumeratedPropertyType	createEnumeratedPropertyType() Create a new enumerated property type.
Goal	createGoal() Create a new goal without container.
Goal	createGoal(java.lang.String name, Goal owner) Create a new goal without container.
Goal	createGoal(java.lang.String name, GoalContainer owner) Create a new goal without container.
GoalContainer	createGoalContainer() Create a new goal container without container.
GoalContainer	createGoalContainer(java.lang.String name, GoalContainer owner) Create a new goal container without container.
KPI	createKPI() Create a new KPI without container.
KPI	createKPI(java.lang.String name, KPI owner) Create a new KPI without container.
KPI	createKPI(java.lang.String name, KPIContainer owner) Create a new KPI without container.
KPIContainer	createKPIContainer() Create a new KPI container without container.
KPIContainer	createKPIContainer(java.lang.String name, KPIContainer owner) Create a new KPI container without container.
PropertyDefinition	createProperty() Create a new property.
PropertyEnumerationLitteral	createPropertyEnumerationLitteral() Create a new enumeration litteral for the enumerated property type.
PropertyTableDefinition	createPropertySet() Create a new property set.
AnalystPropertyTable	createPropertyTable() Create a new property value set.
PropertyType	createPropertyType() Create a new simple property type.
Requirement	createRequirement() Create a new requirement without container.
Requirement	createRequirement(java.lang.String name, Requirement owner) Create a new requirement without container.
Requirement	createRequirement(java.lang.String name, RequirementContainer owner) Create a new requirement without container.
RequirementContainer	createRequirementContainer() Create a new requirement container without container.
RequirementContainer	createRequirementContainer(java.lang.String name, RequirementContainer owner) Create a new requirement container without container.
Risk	createRisk() Create a new risk without container.
Risk	createRisk(java.lang.String name, Risk owner) Create a new risk without container.
Risk	createRisk(java.lang.String name, RiskContainer owner) Create a new risk without container.
RiskContainer	createRiskContainer() Create a new risk container without container.
RiskContainer	createRiskContainer(java.lang.String name, RiskContainer owner) Create a new risk container without container.
Term	createTerm() Create a new term without container.
Term	createTerm(java.lang.String name, Dictionary owner) Create a new term without container.
Test	createTest() Create a new test without container.
Test	createTest(java.lang.String name, Test owner) Create a new test without container.
Test	createTest(java.lang.String name, TestContainer owner) Create a new test without container.
TestContainer	createTestContainer() Create a new test container without container.
TestContainer	createTestContainer(java.lang.String name, TestContainer owner) Create a new test container without container.
java.util.List<PropertyTableDefinition>	getPropertySets() Get the list of known property sets.
java.util.List<PropertyType>	getPropertyTypes() Get the list of known property types.
java.util.List<BusinessRuleContainer>	getRootBusinessRuleContainer() Get the main business rules container that owns the business rules elements.
java.util.List<Dictionary>	getRootDictionary() Get the main dictionary that owns the sub dictionaries and terms.
java.util.List<GoalContainer>	getRootGoalContainer() Get the main goal container that owns the goal elements.
java.util.List<RequirementContainer>	getRootRequirementContainer() Get the main requirement container that owns the requirement elements.
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.

Field Detail

BUSINESS_RULE_CONTAINER_STEREOTYPE

static final java.lang.String BUSINESS_RULE_CONTAINER_STEREOTYPE

The name of the stereotype defining a Business Rule Container.

See Also:

Constant Field Values

BUSINESS_RULE_DIAGRAM_STEREOTYPE

static final java.lang.String BUSINESS_RULE_DIAGRAM_STEREOTYPE

The name of the stereotype defining a Business Rule Diagram.

See Also:

Constant Field Values

BUSINESS_RULE_PropertyTableDefinition_STEREOTYPE

static final java.lang.String BUSINESS_RULE_PropertyTableDefinition_STEREOTYPE

The name of the stereotype defining a Business Rule PropertyTableDefinition.

See Also:

Constant Field Values

BUSINESS_RULE_STEREOTYPE

static final java.lang.String BUSINESS_RULE_STEREOTYPE

The name of the stereotype defining a Business Rule.

See Also:

Constant Field Values

DICTIONARY_DIAGRAM_STEREOTYPE

static final java.lang.String DICTIONARY_DIAGRAM_STEREOTYPE

The name of the stereotype defining a Dictionary Diagram.

See Also:

Constant Field Values

GOAL_CONTAINER_STEREOTYPE

static final java.lang.String GOAL_CONTAINER_STEREOTYPE

The name of the stereotype defining a Goal Container.

See Also:

Constant Field Values

GOAL_DIAGRAM_STEREOTYPE

static final java.lang.String GOAL_DIAGRAM_STEREOTYPE

The name of the stereotype defining a Goal Diagram.

See Also:

Constant Field Values

GOAL_PropertyTableDefinition_STEREOTYPE

static final java.lang.String GOAL_PropertyTableDefinition_STEREOTYPE

The name of the stereotype defining a Goal PropertyTableDefinition.

See Also:

Constant Field Values

GOAL_STEREOTYPE

static final java.lang.String GOAL_STEREOTYPE

The name of the stereotype defining a Goal.

See Also:

Constant Field Values

REQUIREMENT_CONTAINER_STEREOTYPE

static final java.lang.String REQUIREMENT_CONTAINER_STEREOTYPE

The name of the stereotype defining a Requirement Container.

See Also:

Constant Field Values

REQUIREMENT_DIAGRAM_STEREOTYPE

static final java.lang.String REQUIREMENT_DIAGRAM_STEREOTYPE

The name of the stereotype defining a Requirement Diagram.

See Also:

Constant Field Values

REQUIREMENT_PropertyTableDefinition_STEREOTYPE

static final java.lang.String REQUIREMENT_PropertyTableDefinition_STEREOTYPE

The name of the stereotype defining a Requirement PropertyTableDefinition.

See Also:

Constant Field Values

REQUIREMENT_STEREOTYPE

static final java.lang.String REQUIREMENT_STEREOTYPE

The name of the stereotype defining a Requirement.

See Also:

Constant Field Values

Method Detail

addPropertySet

void addPropertySet(PropertyTableDefinition set)

Add a new property set in the requirement administration model.

New property sets can be created, using the createPropertySet() method and can added to this model through the use of this method.

Parameters:

set - property set

See Also:

removePropertySet(PropertyTableDefinition)

addPropertyType

void addPropertyType(PropertyType type)

Add a new property type in the requirement admin model.

New property types can be created, using the createPropertyType() method and can added to this model through the use of this method.

Parameters:

type - property type

See Also:

removePropertyType(PropertyType)

createBusinessRule

BusinessRule createBusinessRule()

Create a new BusinessRule without container.
The returned BusinessRule has to be added in the BusinessRule hierarchy.

Returns:

The created BusinessRule

createBusinessRule

BusinessRule createBusinessRule(java.lang.String name,
                                BusinessRule owner)

Create a new BusinessRule without container.
The returned BusinessRule has to be added in the BusinessRule hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created BusinessRule

createBusinessRule

BusinessRule createBusinessRule(java.lang.String name,
                                BusinessRuleContainer owner)

Create a new BusinessRule without container.
The returned BusinessRule has to be added in the BusinessRule hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created BusinessRule

createBusinessRuleContainer

BusinessRuleContainer createBusinessRuleContainer()

Create a new BusinessRule container without container.
The returned BusinessRule container has to be added in the BusinessRule hierarchy.

Returns:

The created BusinessRule container

createBusinessRuleContainer

BusinessRuleContainer createBusinessRuleContainer(java.lang.String name,
                                                  BusinessRuleContainer owner)

Create a new BusinessRule container without container.
The returned BusinessRule container has to be added in the BusinessRule hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created BusinessRule container

createDictionary

Dictionary createDictionary()

Create a new dictionary without container.
The returned dictionary has to be added in the dictionary hierarchy. The following example shows a creation of a dictionary element directly in the root dictionary.

IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
Dictionary root = model.getRootDictionary();

Dictionary newDictionary = model.createDictionary();
newDictionary.setName ("dic1");
root.addOwned (newDictionary);

Returns:

The created dictionary

createDictionary

Dictionary createDictionary(java.lang.String name,
                            Dictionary owner)

Create a new dictionary without container.
The returned dictionary has to be added in the dictionary hierarchy. The following example shows a creation of a dictionary element directly in the root dictionary.

IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
Dictionary root = model.getRootDictionary();

Dictionary newDictionary = model.createDictionary();
newDictionary.setName ("dic1");
root.addOwned (newDictionary);

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created dictionary

createEnumeratedPropertyType

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.

Returns:

The created enumerated property type

See Also:

addPropertyType(PropertyType)

createGoal

Goal createGoal()

Create a new goal without container.
The returned goal has to be added in the goal hierarchy.

Returns:

The created goal

createGoal

Goal createGoal(java.lang.String name,
                GoalContainer owner)

Create a new goal without container.
The returned goal has to be added in the goal hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created goal

createGoal

Goal createGoal(java.lang.String name,
                Goal owner)

Create a new goal without container.
The returned goal has to be added in the goal hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created goal

createGoalContainer

GoalContainer createGoalContainer()

Create a new goal container without container.
The returned goal container has to be added in the goal hierarchy.

Returns:

The created goal container

createGoalContainer

GoalContainer createGoalContainer(java.lang.String name,
                                  GoalContainer owner)

Create a new goal container without container.
The returned goal container has to be added in the goal hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created goal container

createProperty

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 PropertyTableDefinition.getOwned()

Returns:

The created enumerated property type

See Also:

PropertyTableDefinition.getOwned()

createPropertyEnumerationLitteral

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.

Returns:

The created enumeration litteral

See Also:

EnumeratedPropertyType.getLitteral()

createPropertySet

PropertyTableDefinition createPropertySet()

Create a new property set.
The returned property set has to be added to the admin requirement model, using the addPropertySet(PropertyTableDefinition) method.

Returns:

The created property set

See Also:

addPropertySet(PropertyTableDefinition)

createPropertyTable

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.

Returns:

The created property value set

See Also:

AnalystItem.setAnalystProperties(AnalystPropertyTable)

createPropertyType

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.

Returns:

The created property type

See Also:

addPropertyType(PropertyType)

createRequirement

Requirement createRequirement()

Create a new requirement without container.
The returned requirement has to be added in the requirement container hierarchy. The following example shows the creation of a requirement directly in the root requirement container.

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);


Returns:

The created requirement

createRequirement

Requirement createRequirement(java.lang.String name,
                              Requirement owner)

Create a new requirement without container.
The returned requirement has to be added in the requirement container hierarchy. The following example shows the creation of a requirement directly in the root requirement container.

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);


Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created requirement

createRequirement

Requirement createRequirement(java.lang.String name,
                              RequirementContainer owner)

Create a new requirement without container.
The returned requirement has to be added in the requirement container hierarchy. The following example shows the creation of a requirement directly in the root requirement container.

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);


Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created requirement

createRequirementContainer

RequirementContainer createRequirementContainer()

Create a new requirement container without container.
The returned requirement container has to be added in the requirement container hierarchy. The following example shows the creation of a requirement container directly in the root requirement container.

IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
RequirementContainer root = model.getRootContainer();

RequirementContainer newRequirementContainer = model.createRequirement();
newRequirementContainer.setName ("functional requirements");
root.addOwned (newRequirementContainer);


Returns:

The created requirement container

createRequirementContainer

RequirementContainer createRequirementContainer(java.lang.String name,
                                                RequirementContainer owner)

Create a new requirement container without container.
The returned requirement container has to be added in the requirement container hierarchy. The following example shows the creation of a requirement container directly in the root requirement container.

IModelingSession session = Modelio.getInstance().getModelingSession();
IAnalystModel model = session.getRequirementModel();
RequirementContainer root = model.getRootContainer();

RequirementContainer newRequirementContainer = model.createRequirement();
newRequirementContainer.setName ("functional requirements");
root.addOwned (newRequirementContainer);


Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created requirement container

createTerm

Term createTerm()

Create a new term without container.
The returned term has to be added in the dictionary hierarchy. The following example shows the creation of a term directly in the root dictionary.

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);


Returns:

The created requirement

createTerm

Term createTerm(java.lang.String name,
                Dictionary owner)

Create a new term without container.
The returned term has to be added in the dictionary hierarchy. The following example shows the creation of a term directly in the root dictionary.

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);


Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created requirement

getPropertySets

java.util.List<PropertyTableDefinition> getPropertySets()

Get the list of known property sets.

Default property sets already exist and can be extended by the user. This method permits to return the list of known property sets.

Returns:

The list of known property sets.

getPropertyTypes

java.util.List<PropertyType> getPropertyTypes()

Get the list of known property types.

Default property types already exist and can be extended by the user. This method permits to return the list of known property types.

Returns:

The list of known property types.

getRootBusinessRuleContainer

java.util.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.

Returns:

The root business rules container

getRootDictionary

java.util.List<Dictionary> getRootDictionary()

Get the main dictionary that owns the sub dictionaries and terms.

Returns:

The root dictionary

getRootGoalContainer

java.util.List<GoalContainer> getRootGoalContainer()

Get the main goal container that owns the goal elements.
The requirement elements are the goal containers and goals.

Returns:

The root goal container

getRootRequirementContainer

java.util.List<RequirementContainer> getRootRequirementContainer()

Get the main requirement container that owns the requirement elements.
The requirement elements are the requirement containers and requirements.

Returns:

The root requirement container

removePropertySet

void removePropertySet(PropertyTableDefinition set)

Remove an existing property set from the requirement administration model.

Parameters:

set - property set

See Also:

addPropertySet(PropertyTableDefinition)

removePropertyType

void removePropertyType(PropertyType type)

Remove an existing property type from the requirement administration model.

Parameters:

type - property type

See Also:

addPropertyType(PropertyType)

createRisk

Risk createRisk()

Create a new risk without container.
The returned risk has to be added in the risk container hierarchy.

Returns:

The created risk

createRisk

Risk createRisk(java.lang.String name,
                Risk owner)

Create a new risk without container.
The returned risk has to be added in the risk container hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created risk

createRisk

Risk createRisk(java.lang.String name,
                RiskContainer owner)

Create a new risk without container.
The returned risk has to be added in the risk container hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created risk

createRiskContainer

RiskContainer createRiskContainer()

Create a new risk container without container.
The returned risk container has to be added in the risk container hierarchy.

Returns:

The created risk container

createRiskContainer

RiskContainer createRiskContainer(java.lang.String name,
                                  RiskContainer owner)

Create a new risk container without container.
The returned risk container has to be added in the risk container hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created risk container

createTest

Test createTest()

Create a new test without container.
The returned test has to be added in the test container hierarchy.

Returns:

The created test

createTest

Test createTest(java.lang.String name,
                Test owner)

Create a new test without container.
The returned test has to be added in the test container hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created test

createTest

Test createTest(java.lang.String name,
                TestContainer owner)

Create a new test without container.
The returned test has to be added in the test container hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created test

createTestContainer

TestContainer createTestContainer()

Create a new test container without container.
The returned test container has to be added in the test container hierarchy.

Returns:

The created test container

createTestContainer

TestContainer createTestContainer(java.lang.String name,
                                  TestContainer owner)

Create a new test container without container.
The returned test container has to be added in the test container hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created test container

createKPI

KPI createKPI(java.lang.String name,
              KPI owner)

Create a new KPI without container.
The returned KPI has to be added in the KPI container hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created KPI

createKPI

KPI createKPI(java.lang.String name,
              KPIContainer owner)

Create a new KPI without container.
The returned KPI has to be added in the KPI container hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created KPI

createKPI

KPI createKPI()

Create a new KPI without container.
The returned KPI has to be added in the KPI container hierarchy.

Returns:

The created KPI

createKPIContainer

KPIContainer createKPIContainer(java.lang.String name,
                                KPIContainer owner)

Create a new KPI container without container.
The returned KPI container has to be added in the KPI container hierarchy.

Parameters:

name - the new element's name.

owner - the new element's composition owner.

Returns:

The created KPI container

createKPIContainer

KPIContainer createKPIContainer()

Create a new KPI container without container.
The returned KPI container has to be added in the KPI container hierarchy.

Returns:

The created KPI container