GenericTableTool diagram.Class GenericTableTool: Methods: - +getTable( diagram : Diagram) : Table
- +getTable( diagramName : String) : Table
- +closeTables() : Void
- +closeTable(diagram : Diagram) : Void
- +closeTable(diagramName : String) : Void
Class Table: Methods: Getting generic table dataA Generic Table is a special diagram. You can retrieve it by using the variable $Diagram. Thus, every method must accept the diagram instance or diagram name. Use the following method to get the Generic Table instance. We use Generic Table instances to retrieve table information such as row elements and column names. Getting generic table instances from diagram elementsTo get a Generic Table instance from a specified diagram element, use the following code. getTable( diagram : Diagram) : Table #set($table = $generic.getTable($diagram)) |
Where the parameter is: - diagram – the diagram element.
Return the instance of a Generic Table. Example code: #foreach($diagram in $project.getDiagrams("Generic Table"))
#set($table = $generic.getTable($diagram))
#end |
Getting generic table instances from diagram namesTo get a Generic Table instance from a specific diagram name, use the following code. getTable( diagramName : String) : Table #set($table = $generic.getTable($diagram)) |
Where the parameter is: - diagram – the diagram name.
Return the instance of a Generic Table. Example code: #set($diagram = "diagram name")
#set($table = $generic.getTable($diagram)) |
Closing tablesUse the following method to close a table diagram. Closing all diagram tablesCloseTables() : Void Closing a specific table diagramcloseTable(diagram: Diagram) : Void $generic.closeTable($diagram) |
Where the parameter is: - diagram – a table diagram you want to close.
Closing a table diagram with a specific diagram namecloseTable(diagramName: String) : Void $generic.closeTable($diagramName) |
Where the parameter is: - diagramName – the name of a table diagram you want to close.
Getting row elementsThe Generic Table consists of a series of row elements and column names. Use the following methods to retrieve a list of row elements. Getting all row elementsgetRows() : List<Element> The returned value is a list of Elements. The following shows an example of how to print all row element names. #foreach($row in $table.rows)
$row.name
#end |
Getting all filtered row elements getFilteredRows() : List<Element> The returned value is a list of Elements that have been filtered by the Filter field. #foreach($row in $table.getFilteredRows())
$row.name
#end |
The figure below shows the rows returned after applying the filter. Rows returned after filtering.
Getting row elements in specific row numbersgetRow( rowNumber : int ) : Element $table.getRow($rowNumber) |
Where the parameter is: - rowNumber – the row number starts with 0.
The returned value is an Element. Getting column namesColumn names are referred by column IDs. A column is a MagicDraw QProperty ID that is not readable or accessible by the user. We need to create other methods that provide better usability than using QProperty ID. Use the following methods to retrieve column names. The methods in this section retrieves column names from the list returned by Show Columns menu item from generic table diagram. The methods in the preceding section, however, retrieves column names from the diagram itself and not from the list returned by Show Columns menu item. |
Getting column names from column IDgetColumn( columnId : String) : String $table.getColumn($columnId) |
Where the parameter is: - columnId – the ID of a column. Using column IDs has a benefit of consistency between different languages, for example, French and English. The column ID can be retrieved by the method getColumnIds().
The returned value is the name of a column. Getting column names from column numbersgetColumn(columnNumber : int) : String $table.getColumn($columnNumber) |
Where the parameter is: - columnNumber – a column number starts with 1. The column number 0 is the row number.
The returned value is the name of a column. Getting all column namesgetColumnNames() : List<String> The returned value is a list of column names. Example code: Prints all column names. #foreach($colname in $table.getColumnNames())
$colname
#end |
Getting all column IDsgetColumnIds() : List<String> The returned value is a list of column IDs. Example code: Print all columns IDs #foreach($colid in $table.getColumnIds())
$table.getColumn($colid)
#end |
Getting cell valuesA cell value is the value in a row element with a column name. To get a cell value, you need to provide both the row element and column. A cell value is an Element or row number. Use the following methods to retrieve a cell value. Getting values from row element and column IDgetValue( rowElement : Element, columnIdOrName : String ) : Object $table.getValue($rowElement, $columnId) |
Where the parameters are: - rowElement – a row element.
- columnId – a column ID.
The returned value is the value in a cell. If the cell contains an element, the value is the Element. Example code: Prints the row, column, and value. #foreach($diagram in $project.getDiagrams("Generic Table"))
#set($table = $generic.getTable($diagram))
#foreach($row in $table.getRows())
<h1>$row.name</h1>
#foreach($col in $table.getColumnIds())
$table.getColumn$col) : $table.getValue($row, $col)
#end
#end
#end |
Getting values from row element and column namegetValue( rowElement : Element, columnIdOrName : String ) : Object $table.getValue($rowElement, $columnName) |
Where the parameters are: - rowElement – a row element.
- columnName – a column name.
The returned value is the value in a cell. If the cell contains an element, the value is the Element. Getting values from row element and column numbergetValue( rowElement : Element, columnNumber : int ) : Object $table.getValue($rowElement, $columnNumber) |
Where the parameters are: - rowElement – a row element.
- columnName – a column number starts with 1. The column number 0 is the row number.
The returned value is the value in a cell. If the cell contains an element, the value is the Element. Getting values from row and column numbersgetValue( rowNumber : int, columnNumber : int ) : Object $table.getValue($rowNumber, $columnNumber) |
Where the parameters are: - rowNumber – a row number starts with 0.
- columnNumber – a column number starts with 1. The column number 0 is the row number.
The returned value is the value in a cell. If the cell contains an element, the value is the Element. Getting values from row element and column IDs as stringgetValueAsString( rowElement : Element, columnIdOrName : String ) : String $table.getValueAsString($rowElement, $columnId) |
Where the parameters are: - rowElement – a row element.
- columnId – a column ID.
The returned value is the value in a cell and is converted into String. The String value is created by MagicDraw text representation API. Getting values from row element and column name as stringgetValueAsString( rowElement : Element, columnIdOrName : String ) : String $table.getValueAsString($rowElement, $columnName) |
Where the parameters are: - rowElement – a row element
- columnName – a column name
The returned value is the value in a cell and is converted into String. The String value is created by MagicDraw text representation API. Getting values from row element and column number as stringgetValueAsString( rowElement : Element, columnNumber : int ) : String $table.getValueAsString($rowElement, $columnNumber) |
Where the parameters are: - rowElement – a row element.
- columnName – a column number starts with 1. The column number 0 is the row number.
The returned value is the value in a cell and is converted into String. The String value is created by MagicDraw text representation API. Getting values from row and column numbers as stringgetValueAsString( rowNumber : int, columnNumber : int ) : String $table.getValueAsString($rowNumber, $columnNumber) |
Where the parameters are: - rowNumber – a row number starts with 0.
- columnNumber – a column number starts with 1. The column number 0 is the row number.
The returned value is the value in a cell and is converted into String. The String value is created by MagicDraw text representation API. Getting values from row and column numbers as string with a full type of element in a propertygetValueAsString( rowNumber : int, columnNumber : int, showFullType : boolean ) : String $table.getValueAsString($rowNumber, $columnNumber, showFullType) |
Where the parameters are: - rowNumber – a row number starts with 0.
- columnNumber – a column number starts with 1. The column number 0 is the row number.
- showFullType – the default value is true for showing a full type of element in a cell in String form.
The returned value is the value in a cell, converted into String, and shown in a full type or normal form. Getting cell value from returned object as stringgetCellValueAsString( object : Object ) : String
$table.getCellValueAsString($object) |
Where the parameter is: The returned value is the object in cell value converted into String. For example: #set($result = $table.getValue($row, $id))
#if($list.isArray($result))
#foreach($r in $result)
- $table.getCellValueAsString($r)
#end
#else
$table.getCellValueAsString($result)
#end |
Getting visible column and cell valuesA visible cell value is the column which is visible on a diagram. Unlike the methods described in section 23.1.5 Getting Cell Values, the following methods will retrieve only the value which is visible on a diagram. Getting all visible column IDsgetVisibleColumnIds() : List<String> $table.getVisibleColumnIds() |
The returned value is a list of visible column IDs. Getting visible column names from column numbersgetVisibleColumn( columnNumber : int) : String $table.getVisibleColumn($columnNumber) |
Where the parameter is: - columnNumber – a column number starts with 1. The column number 0 is the row number.
The returned value is the name of a visible column. Getting visible values from row elements and column numbergetVisibleValue( rowElement : Element, columnNumber : int ) : Object $table.getVisibleValue($rowElement, $columnNumber) |
Where the parameters are: - rowElement – a row element.
- columnNumber – a column number starts with 1. The column number 0 is the row number.
The returned value is the value in a visible cell. If the cell contains an element, the value is the Element. Getting visible values from row number and column numbergetVisibleValue( rowNumber : int, columnNumber : int ) : Object $table.getVisibleValue($rowNumber, $columnNumber) |
Where the parameters are: - rowNumber – a row number starts with 0.
- columnNumber – a column number starts with 1. The column number 0 is the row number.
The returned value is the value in a visible cell. If the cell contains an element, the value is the Element. Getting visible values from row element and column number as stringgetVisibleValueAsString( rowElement : Element, columnNumber : int ) : String $table.getVisibleValueAsString($rowElement, $columnNumber) |
Where the parameters are: - rowElement – a row element.
- columnNumber – a column number starts with 1. The column number 0 is the row number.
The returned value is the value in a visible cell and is converted into String. The String value is created by MagicDraw text representation API. Getting visible values from row and column numbers as stringgetVisibleValueAsString( rowNumber : int, columnNumber : int ) : String $table.getVisibleValueAsString($rowNumber, $columnNumber) |
Where the parameters are: - rowNumber – a row number starts with 0.
- columnNumber – a column number starts with 1. The column number 0 is the row number.
The returned value is the value in a visible cell and is converted into String. The String value is created by MagicDraw text representation API. |