java.lang.Object

cruise.umple.compiler.Requirement

public class Requirement
extends java.lang.Object

Represents a requirement, such as those found around classes, methods, attributes, associations, stateMachines, states, etc. If multiple occurrences of a requirement are found, their statements are concatenated and a single instance is created. If the language of two occurrences differs (and neither is blank) the the latter occurrences is ignored with warning 401 All instances of this class are tracked in the instance of Model with the map allRequirements, whose key is the identifier

Constructor Summary

Constructors
Constructor	Description
`Requirement(Requirement aReq)`	deep copy constructor
`Requirement(java.lang.String aIdentifier, java.lang.String aStatement, java.lang.String aWho, java.lang.String aWhen, java.lang.String aWhat, java.lang.String aWhy, java.lang.String aLanguage)`

Method Summary

Modifier and Type	Method	Description
`boolean`	`addOrMoveQualityClassAt(QualityClass aQualityClass, int index)`
`boolean`	`addOrMoveReqImplementationAt(ReqImplementation aReqImplementation, int index)`
`boolean`	`addOrMoveReqTokenAt(Token aReqToken, int index)`
`boolean`	`addOrMoveUseCaseStepAt(UseCaseStep aUseCaseStep, int index)`
`boolean`	`addQualityClass(QualityClass aQualityClass)`
`QualityClass`	`addQualityClass(java.lang.String aName, java.lang.String aContent)`
`boolean`	`addQualityClassAt(QualityClass aQualityClass, int index)`
`boolean`	`addReqImplementation(ReqImplementation aReqImplementation)`
`boolean`	`addReqImplementationAt(ReqImplementation aReqImplementation, int index)`
`boolean`	`addReqToken(Token aReqToken)`
`boolean`	`addReqTokenAt(Token aReqToken, int index)`
`boolean`	`addUseCaseStep(UseCaseStep aUseCaseStep)`
`UseCaseStep`	`addUseCaseStep(java.lang.String aId, UseCaseStep.UseCaseStepType aStepType, java.lang.String aContent)`
`boolean`	`addUseCaseStepAt(UseCaseStep aUseCaseStep, int index)`
`static java.util.List<Comment>`	`convertToComment(java.util.List<ReqImplementation> reqSelected, UmpleModel aModel)`
`void`	`delete()`
`static java.lang.String`	`format(java.lang.String type, java.util.List<ReqImplementation> reqSelected, UmpleModel aModel)`
`java.lang.String`	`getBodyDisplayText(java.lang.String separator)`	Returns the requirement body text so renderers can output body and quality separately.
`java.lang.String`	`getDisplayStatement()`
`java.lang.String`	`getIdentifier()`	A unique identifier for this requirement Alphanumeric, with -, .
`java.lang.String`	`getLanguage()`	The requirements language used to express this requirement can be blank, then 'text' is assumed Other languages can be added e.g.
`QualityClass`	`getQualityClass(int index)`
`java.util.List<QualityClass>`	`getQualityClasses()`	Quality classes defined within this requirement format: `req [quality\|Quality] {({...})*}`
`java.lang.String`	`getQualityClassNamesSummary()`
`ReqImplementation`	`getReqImplementation(int index)`
`java.util.List<ReqImplementation>`	`getReqImplementations()`
`java.util.List<Token>`	`getReqToken()`	List of tokens where the requirement was found Used when reporting errors regarding missing implementations and when reporting where a requirement is located in the code
`Token`	`getReqToken(int index)`
`java.lang.String`	`getStatement()`	The content of the requirement, expressed in the language
`UseCaseStep`	`getUseCaseStep(int index)`
`java.util.List<UseCaseStep>`	`getUseCaseSteps()`	Ordered structured use case steps such as userStep/systemResponse
`java.lang.String`	`getUserStoryDisplayText(java.lang.String separator)`	format logic moved from cruise.umple/src/generators/Generator_CodePlainRequirementsDoc.ump:generator()
`java.lang.String`	`getWhat()`
`java.lang.String`	`getWhen()`
`java.lang.String`	`getWho()`	Structured user story elements
`java.lang.String`	`getWhy()`
`boolean`	`hasQualityClasses()`
`boolean`	`hasReqImplementations()`
`boolean`	`hasReqToken()`
`boolean`	`hasStructuredUserStoryFields()`
`boolean`	`hasUseCaseSteps()`
`int`	`indexOfQualityClass(QualityClass aQualityClass)`
`int`	`indexOfReqImplementation(ReqImplementation aReqImplementation)`
`int`	`indexOfReqToken(Token aReqToken)`
`int`	`indexOfUseCaseStep(UseCaseStep aUseCaseStep)`
`static int`	`minimumNumberOfQualityClasses()`
`static int`	`minimumNumberOfReqImplementations()`
`static int`	`minimumNumberOfReqToken()`
`static int`	`minimumNumberOfUseCaseSteps()`
`int`	`numberOfQualityClasses()`
`int`	`numberOfReqImplementations()`
`int`	`numberOfReqToken()`
`int`	`numberOfUseCaseSteps()`
`boolean`	`removeQualityClass(QualityClass aQualityClass)`
`boolean`	`removeReqImplementation(ReqImplementation aReqImplementation)`
`boolean`	`removeReqToken(Token aReqToken)`
`boolean`	`removeUseCaseStep(UseCaseStep aUseCaseStep)`
`boolean`	`setIdentifier(java.lang.String aIdentifier)`
`boolean`	`setLanguage(java.lang.String aLanguage)`
`boolean`	`setStatement(java.lang.String aStatement)`
`boolean`	`setWhat(java.lang.String aWhat)`
`boolean`	`setWhen(java.lang.String aWhen)`
`boolean`	`setWho(java.lang.String aWho)`
`boolean`	`setWhy(java.lang.String aWhy)`
`java.lang.String`	`toString()`
`static java.lang.String`	`translateToHTML(java.lang.String content, java.lang.String lang)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- Requirement
  
  public Requirement(java.lang.String aIdentifier, java.lang.String aStatement, java.lang.String aWho, java.lang.String aWhen, java.lang.String aWhat, java.lang.String aWhy, java.lang.String aLanguage)
- Requirement
  
  public Requirement(Requirement aReq)
  
  deep copy constructor
Method Details
- setIdentifier
  
  public boolean setIdentifier(java.lang.String aIdentifier)
- setStatement
  
  public boolean setStatement(java.lang.String aStatement)
- setWho
  
  public boolean setWho(java.lang.String aWho)
- setWhen
  
  public boolean setWhen(java.lang.String aWhen)
- setWhat
  
  public boolean setWhat(java.lang.String aWhat)
- setWhy
  
  public boolean setWhy(java.lang.String aWhy)
- setLanguage
  
  public boolean setLanguage(java.lang.String aLanguage)
- getIdentifier
  
  public java.lang.String getIdentifier()
  
  A unique identifier for this requirement Alphanumeric, with -, . and _ allowed TODO: add an Umple 'key' statement for this.
- getStatement
  
  public java.lang.String getStatement()
  
  The content of the requirement, expressed in the language
- getWho
  
  public java.lang.String getWho()
  
  Structured user story elements
- getWhen
  
  public java.lang.String getWhen()
- getWhat
  
  public java.lang.String getWhat()
- getWhy
  
  public java.lang.String getWhy()
- getLanguage
  
  public java.lang.String getLanguage()
  
  The requirements language used to express this requirement can be blank, then 'text' is assumed Other languages can be added e.g. GRL = Goal Requirement Language
- getReqToken
  
  public Token getReqToken(int index)
- getReqToken
  
  public java.util.List<Token> getReqToken()
  
  List of tokens where the requirement was found Used when reporting errors regarding missing implementations and when reporting where a requirement is located in the code
- numberOfReqToken
  
  public int numberOfReqToken()
- hasReqToken
  
  public boolean hasReqToken()
- indexOfReqToken
  
  public int indexOfReqToken(Token aReqToken)
- getUseCaseStep
  
  public UseCaseStep getUseCaseStep(int index)
- getUseCaseSteps
  
  public java.util.List<UseCaseStep> getUseCaseSteps()
  
  Ordered structured use case steps such as userStep/systemResponse
- numberOfUseCaseSteps
  
  public int numberOfUseCaseSteps()
- hasUseCaseSteps
  
  public boolean hasUseCaseSteps()
- indexOfUseCaseStep
  
  public int indexOfUseCaseStep(UseCaseStep aUseCaseStep)
- getQualityClass
  
  public QualityClass getQualityClass(int index)
- getQualityClasses
  
  public java.util.List<QualityClass> getQualityClasses()
  
  Quality classes defined within this requirement format: `req [quality|Quality] {({...})*}`
- numberOfQualityClasses
  
  public int numberOfQualityClasses()
- hasQualityClasses
  
  public boolean hasQualityClasses()
- indexOfQualityClass
  
  public int indexOfQualityClass(QualityClass aQualityClass)
- getReqImplementation
  
  public ReqImplementation getReqImplementation(int index)
- getReqImplementations
  
  public java.util.List<ReqImplementation> getReqImplementations()
- numberOfReqImplementations
  
  public int numberOfReqImplementations()
- hasReqImplementations
  
  public boolean hasReqImplementations()
- indexOfReqImplementation
  
  public int indexOfReqImplementation(ReqImplementation aReqImplementation)
- minimumNumberOfReqToken
  
  public static int minimumNumberOfReqToken()
- addReqToken
  
  public boolean addReqToken(Token aReqToken)
- removeReqToken
  
  public boolean removeReqToken(Token aReqToken)
- addReqTokenAt
  
  public boolean addReqTokenAt(Token aReqToken, int index)
- addOrMoveReqTokenAt
  
  public boolean addOrMoveReqTokenAt(Token aReqToken, int index)
- minimumNumberOfUseCaseSteps
  
  public static int minimumNumberOfUseCaseSteps()
- addUseCaseStep
  
  public UseCaseStep addUseCaseStep(java.lang.String aId, UseCaseStep.UseCaseStepType aStepType, java.lang.String aContent)
- addUseCaseStep
  
  public boolean addUseCaseStep(UseCaseStep aUseCaseStep)
- removeUseCaseStep
  
  public boolean removeUseCaseStep(UseCaseStep aUseCaseStep)
- addUseCaseStepAt
  
  public boolean addUseCaseStepAt(UseCaseStep aUseCaseStep, int index)
- addOrMoveUseCaseStepAt
  
  public boolean addOrMoveUseCaseStepAt(UseCaseStep aUseCaseStep, int index)
- minimumNumberOfQualityClasses
  
  public static int minimumNumberOfQualityClasses()
- addQualityClass
  
  public QualityClass addQualityClass(java.lang.String aName, java.lang.String aContent)
- addQualityClass
  
  public boolean addQualityClass(QualityClass aQualityClass)
- removeQualityClass
  
  public boolean removeQualityClass(QualityClass aQualityClass)
- addQualityClassAt
  
  public boolean addQualityClassAt(QualityClass aQualityClass, int index)
- addOrMoveQualityClassAt
  
  public boolean addOrMoveQualityClassAt(QualityClass aQualityClass, int index)
- minimumNumberOfReqImplementations
  
  public static int minimumNumberOfReqImplementations()
- addReqImplementation
  
  public boolean addReqImplementation(ReqImplementation aReqImplementation)
- removeReqImplementation
  
  public boolean removeReqImplementation(ReqImplementation aReqImplementation)
- addReqImplementationAt
  
  public boolean addReqImplementationAt(ReqImplementation aReqImplementation, int index)
- addOrMoveReqImplementationAt
  
  public boolean addOrMoveReqImplementationAt(ReqImplementation aReqImplementation, int index)
- delete
  
  public void delete()
- hasStructuredUserStoryFields
  
  public boolean hasStructuredUserStoryFields()
- getUserStoryDisplayText
  
  public java.lang.String getUserStoryDisplayText(java.lang.String separator)
  
  format logic moved from cruise.umple/src/generators/Generator_CodePlainRequirementsDoc.ump:generator()
- getBodyDisplayText
  
  public java.lang.String getBodyDisplayText(java.lang.String separator)
  
  Returns the requirement body text so renderers can output body and quality separately.
- getQualityClassNamesSummary
  
  public java.lang.String getQualityClassNamesSummary()
- getDisplayStatement
  
  public java.lang.String getDisplayStatement()
- convertToComment
  
  public static java.util.List<Comment> convertToComment(java.util.List<ReqImplementation> reqSelected, UmpleModel aModel)
- format
  
  public static java.lang.String format(java.lang.String type, java.util.List<ReqImplementation> reqSelected, UmpleModel aModel)
- translateToHTML
  
  public static java.lang.String translateToHTML(java.lang.String content, java.lang.String lang)
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class Requirement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details