Package com.nomagic.reportwizard.tools.generictable

Class Table

java.lang.Object
com.nomagic.reportwizard.tools.generictable.Table
@OpenApiAll public class Table extends Object
Class for getting row elements, column name and cell value.
Since:
Jan 25, 2012

  • Constructor Details

    • Table

      public Table(com.nomagic.diagramtable.Table table, Diagram diagram)
      Constructor.
      Parameters:
      table - generic table instance

  • Method Details

    • getTable

      public com.nomagic.diagramtable.Table getTable()
      Get diagram table

    • getDiagram

      public Diagram getDiagram()
      Get diagram
      Returns:
      diagram

    • getDiagramTool

      public com.nomagic.reportwizard.tools.DiagramTableTool getDiagramTool()
      Get DiagramTableTool
      Returns:
      DiagramTableTool

    • isFilteredRows

      public boolean isFilteredRows()
      True for filtered rows
      Returns:

    • setFilteredRows

      public void setFilteredRows(boolean isFilteredRows)
      True for filtered rows
      Parameters:
      isFilteredRows -

    • resetFilteredRows

      public void resetFilteredRows()
      Reset isFilteredRows value by state from getRow

    • getDiagramTableRows

      public List<? extends com.nomagic.diagramtable.rows.DiagramTableRow> getDiagramTableRows()

    • getRows

      public List<Element> getRows()
      Get all row elements.
      Returns:
      value is list of element

    • getAllRows

      public List<Element> getAllRows()
      Get all row elements including collapsed
      Returns:
      value is list of element

    • getAllDiagramTableRow

      public List<? extends com.nomagic.diagramtable.rows.DiagramTableRow> getAllDiagramTableRow()

    • getDiagramTableRow

      public com.nomagic.diagramtable.rows.DiagramTableRow getDiagramTableRow(int rowNumber)

    • getRow

      public Element getRow(int rowNumber)
      Get row element specific row number.
      Parameters:
      rowNumber - row number starts with 0
      Returns:
      value is row element

    • getFilteredDiagramTableRows

      public List<? extends com.nomagic.diagramtable.rows.DiagramTableRow> getFilteredDiagramTableRows()

    • getFilteredRows

      public List<Element> getFilteredRows()
      Get filtered row elements.
      Returns:
      value is list of element

    • getFilteredDiagramTableRow

      public com.nomagic.diagramtable.rows.DiagramTableRow getFilteredDiagramTableRow(int rowNumber)

    • getFilteredRow

      public Element getFilteredRow(int rowNumber)
      Get filtered row element specific row number.
      Parameters:
      rowNumber - row number starts with 0
      Returns:
      value is row element

    • getColumn

      public String getColumn(String columnId)
      Get column name from column ID.
      Parameters:
      columnId - the id of column. Using column id for benefiting of consistency between different languages e.g. French and English. The column ID can be retrieved by method getColumnIds().
      Returns:
      value is name of column

    • getColumn

      public String getColumn(int columnNumber)
      Get column name by column number as if the column is not visible.
      Parameters:
      columnNumber - column number starts with 1. The column number 0 is row number.
      Returns:
      value is name of column

    • getColumnNames

      public List<String> getColumnNames()
      Get all column names.
      Returns:
      value is the list of column name

    • getColumnIds

      public List<String> getColumnIds()
      Get all column IDs.
      Returns:
      value is the list of column id

    • getValue

      public Object getValue(Element rowElement, String columnIdOrName)
      Get value from row element and column ID or column name.
      Parameters:
      rowElement - row element
      columnIdOrName - column id or column name
      Returns:
      value is the value at cell. If cell contains element, the value is Element.

    • getValue

      public Object getValue(Element rowElement, int columnNumber)
      Get value from row element and column number.
      Parameters:
      rowElement - row element
      columnNumber - column number starts with 0
      Returns:
      value is the value at cell. If cell contains element, the value is Element.

    • getValue

      public Object getValue(int rowNumber, int columnNumber)
      Get value from row number and column number.
      Parameters:
      rowNumber - row number start with 0
      columnNumber - column number start with 1. The column number 0 is row number.
      Returns:
      value is the value at cell. If cell contains element, the value is Element.

    • getValueAsString

      public String getValueAsString(Element rowElement, String columnIdOrName)
      Get value from row element and column Id or column name as String.
      Parameters:
      rowElement - row element
      columnIdOrName - column id or column name
      Returns:
      value is the value at cell and converts into String. The String value is created by MagicDraw representation text API.

    • getValueAsString

      public String getValueAsString(Element rowElement, String columnIdOrName, boolean useFullType)
      Get value from row element and column Id or column name as String.
      Parameters:
      rowElement - row element
      columnIdOrName - column id or column name
      useFullType - true to use full type when convert element to string using Representation Text api of MagicDraw
      Returns:
      value is the value at cell and converts into String. The String value is created by MagicDraw representation text API.

    • getValueAsString

      public String getValueAsString(Element rowElement, int columnNumber)
      Get value from row element and column number as String.
      Parameters:
      rowElement - row element
      columnNumber - column number start with 0.
      Returns:
      value is the value at cell and converts into String. The String value is created by MagicDraw representation text API.

    • getValueAsString

      public String getValueAsString(Element rowElement, int columnNumber, boolean useFullType)
      Get value from row element and column number as String.
      Parameters:
      rowElement - row element
      columnNumber - column number start with 0.
      useFullType - true to use full type when convert element to string using Representation Text api of MagicDraw
      Returns:
      value is the value at cell and converts into String. The String value is created by MagicDraw representation text API.

    • getValueAsString

      public String getValueAsString(int rowNumber, int columnNumber)
      Get value from row number and column Id or column name as String.
      Parameters:
      rowNumber - row number start with 0
      columnNumber - column number start with 1. The column number 0 is row number
      Returns:
      value is the value at cell and converts into String. The String value is created by MagicDraw representation text API.

    • getValueAsString

      public String getValueAsString(int rowNumber, int columnNumber, boolean useFullType)
      Get value from row number and column Id or column name as String.
      Parameters:
      rowNumber - row number start with 0
      columnNumber - column number start with 1. The column number 0 is row number
      useFullType - true to use full type when convert element to string using Representation Text api of MagicDraw
      Returns:
      value is the value at cell and converts into String. The String value is created by MagicDraw representation text API.

    • getVisibleColumnIds

      public List<String> getVisibleColumnIds()
      Get list of visible column id.
      Returns:
      list of visible column id.

    • getVisibleColumn

      public String getVisibleColumn(int columnNumber)
      Get only visible column name by column number.
      Parameters:
      columnNumber - column number
      Returns:
      visible column name

    • getVisibleValue

      public Object getVisibleValue(Element rowElement, int columnNumber)
      Get visible value from row element and column number.
      Parameters:
      rowElement - row element
      columnNumber - column number starts with 0
      Returns:
      value is the value at visible cell. If cell contains element, the value is Element.

    • getVisibleValue

      public Object getVisibleValue(int rowNumber, int columnNumber)
      Get value from row number and column number.
      Parameters:
      rowNumber - row number start with 0
      columnNumber - column number start with 1. The column number 0 is row number.
      Returns:
      value is the value at cell. If cell contains element, the value is Element.

    • getVisibleValueAsString

      public String getVisibleValueAsString(Element rowElement, int columnNumber)
      Get visible value from row element and column number as String.
      Parameters:
      rowElement - row element
      columnNumber - column number start with 0.
      Returns:
      value is the value at cell and converts into String. The String value is created by MagicDraw representation text API.

    • getVisibleValueAsString

      public String getVisibleValueAsString(Element rowElement, int columnNumber, boolean useFullType)
      Get visible value from row element and column number as String.
      Parameters:
      rowElement - row element
      columnNumber - column number start with 0.
      useFullType - true to use full type when convert element to string using Representation Text api of MagicDraw
      Returns:
      value is the value at cell and converts into String. The String value is created by MagicDraw representation text API.

    • getVisibleValueAsString

      public String getVisibleValueAsString(int rowNumber, int columnNumber)
      Get value from row number and column Id or column name as String.
      Parameters:
      rowNumber - row number start with 0
      columnNumber - column number start with 1. The column number 0 is row number
      Returns:
      value is the value at cell and converts into String. The String value is created by MagicDraw representation text API.

    • getVisibleValueAsString

      public String getVisibleValueAsString(int rowNumber, int columnNumber, boolean useFullType)
      Get value from row number and column Id or column name as String.
      Parameters:
      rowNumber - row number start with 0
      columnNumber - column number start with 1. The column number 0 is row number
      useFullType - true to use full type when convert element to string using Representation Text api of MagicDraw
      Returns:
      value is the value at cell and converts into String. The String value is created by MagicDraw representation text API.

    • getCellValue

      public Object getCellValue(com.nomagic.diagramtable.rows.DiagramTableRow diagramTableRow, String columnId)
      Get cell value by rowElement and column property.
      Parameters:
      diagramTableRow - diagram table row element
      columnId - column id
      Returns:
      object of cell value

    • getCellValueAsString

      public String getCellValueAsString(Object cellValue, boolean useFullType)
      Get cell value as string by cellValue.
      Parameters:
      cellValue - value at specified cell
      useFullType - true to create representation as full type
      Returns:
      string of cell value

    • getCellValueAsString

      public String getCellValueAsString(Object cellValue)
      Get cell value as string by cellValue.
      Parameters:
      cellValue - value at specified cell
      Returns:
      string of cell value