com.telelogic.rhapsody.core
Interface IRPMatrixView

All Superinterfaces:
IRPModelElement, IRPUnit

public interface IRPMatrixView
extends IRPUnit

The IRPMatrixView interface represents Matrix View elements in Rhapsody models.


Nested Class Summary
static class IRPMatrixView.ContentFormat
          This class contains values that specify export format
 
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement
IRPModelElement.OSLCLink
 
Method Summary
 java.lang.String getContent(java.lang.String format)
          Retrieves the content of the matrix in the specified format.
 IRPCollection getFromScope()
          method GetFromScope
 java.lang.String getHTMLContent()
          Returns the content of the matrix as HTML.
 IRPCollection getImageCollection(java.lang.String sFolder, java.lang.String sFilename, java.lang.String sExtension)
          method GetImageCollection
 int getIncludeDescendantsFromScope()
          get property includeDescendantsFromScope
 int getIncludeDescendantsToScope()
          get property includeDescendantsToScope
 IRPMatrixLayout getItsMatrixLayout()
          method GetItsMatrixLayout
 IRPCollection getToScope()
          method GetToScope
 void open()
          method open
 void setFromScope(IRPCollection pCollection)
          Specifies the "from" scope to use for this matrix view.
 void setIncludeDescendantsFromScope(int includeDescendantsFromScope)
          set property includeDescendantsFromScope
 void setIncludeDescendantsToScope(int includeDescendantsToScope)
          set property includeDescendantsToScope
 void setItsMatrixLayout(IRPMatrixLayout pVal)
          Specifies the matrix layout to use for this matrix view.
 void setToScope(IRPCollection pCollection)
          Specifies the "to" scope to use for this matrix view.
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPUnit
copyToAnotherProject, getAddToModelMode, getCMHeader, getCMState, getCurrentDirectory, getFilename, getIncludeInNextLoad, getIsStub, getLanguage, getLastModifiedTime, getNestedSaveUnits, getNestedSaveUnitsCount, getStructureDiagrams, isReadOnly, isReferenceUnit, isSeparateSaveUnit, load, moveToAnotherProjectLeaveAReference, referenceToAnotherProject, save, setCMHeader, setFilename, setIncludeInNextLoad, setLanguage, setReadOnly, setSeparateSaveUnit, setUnitPath, unload
 
Methods inherited from interface com.telelogic.rhapsody.core.IRPModelElement
addAssociation, addDependency, addDependencyBetween, addDependencyTo, addLinkToElement, addNewAggr, addProperty, addRedefines, addRemoteDependencyTo, addSpecificStereotype, addStereotype, becomeTemplateInstantiationOf, changeTo, clone, createOSLCLink, deleteDependency, deleteFromProject, deleteOSLCLink, errorMessage, findElementsByFullName, findNestedElement, findNestedElementRecursive, getAllTags, getAnnotations, getAssociationClasses, getBinaryID, getConstraints, getConstraintsByHim, getControlledFiles, getDecorationStyle, getDependencies, getDescription, getDescriptionHTML, getDescriptionPlainText, getDescriptionRTF, getDisplayName, getDisplayNameRTF, getErrorMessage, getFullPathName, getFullPathNameIn, getGUID, getHyperLinks, getIconFileName, getInterfaceName, getIsExternal, getIsOfMetaClass, getIsShowDisplayName, getIsUnresolved, getLocalTags, getMainDiagram, getMetaClass, getName, getNestedElements, getNestedElementsByMetaClass, getNestedElementsRecursive, getNewTermStereotype, getOfTemplate, getOSLCLinks, getOverlayIconFileName, getOverriddenProperties, getOverriddenPropertiesByPattern, getOwnedDependencies, getOwner, getProject, getPropertyValue, getPropertyValueConditional, getPropertyValueConditionalExplicit, getPropertyValueExplicit, getRedefines, getReferences, getRemoteDependencies, getRemoteURI, getRequirementTraceabilityHandle, getSaveUnit, getStereotype, getStereotypes, getTag, getTemplateParameters, getTi, getToolTipHTML, getUserDefinedMetaClass, hasNestedElements, hasPanelWidget, highLightElement, isATemplate, isDescriptionRTF, isDisplayNameRTF, isModified, isRemote, locateInBrowser, lockOnDesignManager, openFeaturesDialog, removeProperty, removeRedefines, removeStereotype, setDecorationStyle, setDescription, setDescriptionAndHyperlinks, setDescriptionHTML, setDescriptionRTF, setDisplayName, setDisplayNameRTF, setGUID, setIsShowDisplayName, setMainDiagram, setName, setOfTemplate, setOwner, setPropertyValue, setRequirementTraceabilityHandle, setStereotype, setTagContextValue, setTagElementValue, setTagValue, setTi, synchronizeTemplateInstantiation, unlockOnDesignManager
 

Method Detail

getContent

java.lang.String getContent(java.lang.String format)
Retrieves the content of the matrix in the specified format. The value of the parameter should be one of the values defined in the class IRPMatrixView.ContentFormat. Note that when you call this method, the matrix is also displayed in Rhapsody.

Parameters:
format - one of the formats defined in the class IRPMatrixView.ContentFormat, for example, IRPMatrixView.ContentFormat.CSV
Returns:
the content of the matrix in the specified format

getFromScope

IRPCollection getFromScope()
method GetFromScope

Throws:
RhapsodyRuntimeException

getHTMLContent

java.lang.String getHTMLContent()
Returns the content of the matrix as HTML. The content returned begins and ends with the "table" tag. Note that when this method is called, the matrix is opened in Rational Rhapsody before the HTML is returned.

Returns:
the content of the matrix as HTML

getImageCollection

IRPCollection getImageCollection(java.lang.String sFolder,
                                 java.lang.String sFilename,
                                 java.lang.String sExtension)
method GetImageCollection

Throws:
RhapsodyRuntimeException

getItsMatrixLayout

IRPMatrixLayout getItsMatrixLayout()
method GetItsMatrixLayout

Throws:
RhapsodyRuntimeException

getToScope

IRPCollection getToScope()
method GetToScope

Throws:
RhapsodyRuntimeException

setFromScope

void setFromScope(IRPCollection pCollection)
Specifies the "from" scope to use for this matrix view.

Parameters:
pCollection - the "from" scope to use for this matrix view. Note that the parameter is a Rhapsody collection, but at the moment, only the first value in the collection is used for the "from" scope.

setItsMatrixLayout

void setItsMatrixLayout(IRPMatrixLayout pVal)
Specifies the matrix layout to use for this matrix view.

Parameters:
pVal - the matrix layout to use for this matrix view

setToScope

void setToScope(IRPCollection pCollection)
Specifies the "to" scope to use for this matrix view.

Parameters:
pCollection - the "to" scope to use for this matrix view. Note that the parameter is a Rhapsody collection, but at the moment, only the first value in the collection is used for the "to" scope.

getIncludeDescendantsFromScope

int getIncludeDescendantsFromScope()
get property includeDescendantsFromScope

Throws:
RhapsodyRuntimeException

getIncludeDescendantsToScope

int getIncludeDescendantsToScope()
get property includeDescendantsToScope

Throws:
RhapsodyRuntimeException

open

void open()
method open

Throws:
RhapsodyRuntimeException

setIncludeDescendantsFromScope

void setIncludeDescendantsFromScope(int includeDescendantsFromScope)
set property includeDescendantsFromScope

Throws:
RhapsodyRuntimeException

setIncludeDescendantsToScope

void setIncludeDescendantsToScope(int includeDescendantsToScope)
set property includeDescendantsToScope

Throws:
RhapsodyRuntimeException