Traceability

ttm
Interface Project

All Superinterfaces:
AttributeOwner, Element, EObject, IdentifiedElement, Notifier
All Known Implementing Classes:
ProjectImpl

public interface Project
extends IdentifiedElement

A representation of the model object 'Project'.

The following features are supported:

See Also:
TtmPackage.getProject()
** Generated **
Model:

Method Summary
 void addCachedElement(java.lang.Integer key, java.lang.Object elt)
          add converted elements by classifier IDs
 void addCoverageResult(Document fromDoc, CoverPoint fromCoverPoint, Document to, float ratio)
          add Coverage Result between a document/coverPoint and another document
 void addRuleDefinition(Rule aRule)
          add new Rule to the project
 void cleanCachedElements()
          clean the converted elements map
 java.util.List<CoverageResult> getCoverageResults()
          Returns the value of the 'Coverage Result' containment reference list.
 java.util.List<Document> getDocuments()
          Returns the value of the 'Document' containment reference list.
 java.util.List<java.lang.Object> getRequirements()
          gets the list of requirements in the project
 java.util.Set<Document> getRootDocumentsFromProjectElements()
          returns the documents of the projet which do not cover any other document The set contents are of type DataDescription.Document
 java.util.List<Rule> getRules()
          Returns the value of the 'Rule' containment reference list.
 java.lang.String getTtmFilename()
          gets the ttm filename.
 boolean isAnyDocumentCovered()
          Returns the value of the 'Any Document Covered' attribute
 void setAnyDocumentCovered(boolean value)
          Sets the value of the 'Any Document Covered' attribute
 
Methods inherited from interface ttm.IdentifiedElement
getIdent, getShortDescription, getTexts, setIdent, setShortDescription
 
Methods inherited from interface ttm.AttributeOwner
getAttributes
 
Methods inherited from interface ttm.Element
getActivatedRules, getDocument
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getRules

java.util.List<Rule> getRules()
Returns the value of the 'Rule' containment reference list. The list contents are of type Rule.

If the meaning of the 'Rule' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Rule' containment reference list.
See Also:
ttm.TtmPackage#getProject_Rule()
** Generated **
NOT
Model:
type="ttm.Rule" containment="true"

getDocuments

java.util.List<Document> getDocuments()
Returns the value of the 'Document' containment reference list. The list contents are of type Document. It is bidirectional and its opposite is 'Project'.

If the meaning of the 'Document' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Documents' containment reference list.
See Also:
ttm.TtmPackage#getProject_Document(), Document.getProject()
** Generated **
NOT
Model:
type="ttm.Document" opposite="project" containment="true"

getCoverageResults

java.util.List<CoverageResult> getCoverageResults()
Returns the value of the 'Coverage Result' containment reference list. The list contents are of type CoverageResult. It is bidirectional and its opposite is 'Project'.

If the meaning of the 'Coverage Result' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Coverage Result' containment reference list.
See Also:
ttm.TtmPackage#getProject_CoverageResult(), CoverageResult.getProject()
** Generated **
NOT
Model:
type="ttm.CoverageResult" opposite="project" containment="true"

isAnyDocumentCovered

boolean isAnyDocumentCovered()
Returns the value of the 'Any Document Covered' attribute.

If the meaning of the 'Any Document Covered' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Any Document Covered' attribute.
See Also:
setAnyDocumentCovered(boolean), TtmPackage.getProject_AnyDocumentCovered()
** Generated **
Model:
dataType="org.eclipse.emf.ecore.xml.type.Boolean"

setAnyDocumentCovered

void setAnyDocumentCovered(boolean value)
Sets the value of the 'Any Document Covered' attribute.

Parameters:
value - the new value of the 'Any Document Covered' attribute.
See Also:
isAnyDocumentCovered()
** Generated **

getRootDocumentsFromProjectElements

java.util.Set<Document> getRootDocumentsFromProjectElements()
returns the documents of the projet which do not cover any other document The set contents are of type DataDescription.Document. TNI Addition

Returns:
a set of documents which do not cover any other document
** Generated **
NOT

addCoverageResult

void addCoverageResult(Document fromDoc,
                       CoverPoint fromCoverPoint,
                       Document to,
                       float ratio)
add Coverage Result between a document/coverPoint and another document TNI Addition

Parameters:
the - document that covers, can be null
the - coverpoint taht covers, can be null
the - document that is covered
the - coverage ratio
** Generated **
NOT

addRuleDefinition

void addRuleDefinition(Rule aRule)
add new Rule to the project TNI Addition

Parameters:
rule - that will be checked during processing
** Generated **
NOT

addCachedElement

void addCachedElement(java.lang.Integer key,
                      java.lang.Object elt)
add converted elements by classifier IDs

Parameters:
key - is the object.eClass.classifierID
elt - is a list of object in project which class id is key

cleanCachedElements

void cleanCachedElements()
clean the converted elements map


getRequirements

java.util.List<java.lang.Object> getRequirements()
gets the list of requirements in the project

Returns:
list of 'Requirement' class elements

getTtmFilename

java.lang.String getTtmFilename()
gets the ttm filename.

Returns:
the ttm filename.

Traceability

Copyright (c) 2005 TOPCASED Contributors 2005 - 2007. All rights reserved.