TableParameter (csbase-common 3.1.3-DBG3 API)

java.lang.Object
- csbase.logic.algorithms.parameters.Parameter<V>
- - csbase.logic.algorithms.parameters.SimpleParameter<List<RowValue>>
  - - csbase.logic.algorithms.parameters.TableParameter

All Implemented Interfaces:

RowValueListener, Serializable, Comparable<Parameter<List<RowValue>>>
```
public final class TableParameter
extends SimpleParameter<List<RowValue>>
implements RowValueListener
```
Parâmetro do Tipo Tabela.

Author:

lmoreira

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`TableParameter(String name, String label, String description, boolean isOptional, boolean isVisible, String commandLinePattern, List<? extends TableColumn<?>> columns, boolean delimitTable, boolean delimitRows, Integer fixedRowCount, Integer visibleRowCount, Integer minRowCount, Integer maxRowCount)` Cria um parâmetro do tipo tabela.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRow(RowValue rowValue)` Adição de linha
`void`	`addTableParameterListener(TableParameterListener listener)` Adiciona um observador.
`TableParameterValidator`	`createParameterValidator()` Cria o validador do parâmetro.
`void`	`createRow()` Cria uma linha.
`boolean`	`delimitRows()` Indica se deve delimitar as linhas da tabela na linha de comando gerada.
`boolean`	`delimitTable()` Indica se deve delimitar a tabela na linha de comando gerada.
`Map<String,Object>`	`exportValue()` Exporta o valor do parâmetro como um mapa "nome`->`valor".
`TableColumn<?>`	`getColumnById(String columnId)` Obtém uma coluna dado o seu identificador.
`int`	`getColumnCount()` Obtém a quantidade de colunas.
`List<TableColumn<?>>`	`getColumns()` Obtém a lista de colunas.
`String`	`getCommandValue(CommandLineContext context)` Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.
`Object`	`getExpressionValue()` Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (`Expression`).
`String`	`getIDLType()` Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.
`Object`	`getItemValue(int rowIndex, int columnIndex)` Obtém o valor de uma célula.
`Integer`	`getMaxRowCount()` Obtém a quantidade máxima de linhas.
`Integer`	`getMinRowCount()` Obtém a quantidade mínima de linhas.
`int`	`getRowCount()` Obtém a quantidade de linhas da tabela.
`List<RowValue>`	`getRowValues()` Obtém a linha de valores das linhas.
`List<TableParameterListener>`	`getTableParameterListeners()` Obtém os observadores.
`String`	`getType()` Obtém um texto que representa o tipo deste parâmetros.
`String`	`getValueAsText()` Obtém o valor corrente sob a forma de string.
`Integer`	`getVisibleRowCount()` Obtém a quantidade de linhas que deve estar visível.
`boolean`	`hasFixedRowCount()` Indica se a quantidade de linhas é fixa.
`void`	`importValue(Map<String,Object> parameterValues)` Importa o valor do parâmetro a partir de um mapa "nome`->`valor".
`void`	`removeRow(int rowIndex)` Remove uma linha específica.
`void`	`resetValue()` Atribui o valor padrão ao parâmetro.
`boolean`	`setItemValue(Object value, int rowIndex, int columnIndex)` Atribui um valor a uma célula.
`void`	`setValueAsText(String parameterValue)` Atribui o valor corrente sob a forma de string.
`void`	`valueWasChanged(Object newValue, int columnIndex)` Avisa ao observador sobre uma mudança no valor da linha da tabela.

Methods inherited from class csbase.logic.algorithms.parameters.SimpleParameter
addSimpleParameterListener, fireValueWasChangedEvent, fireVisiblityWasChangedEvent, getCommandLine, getCommandLinePattern, getDefaultValue, getDescription, getLabel, getParameterValidator, getSimpleParameterListeners, getValue, ignoreIfDisabled, ignoreIfInvisible, isEnabled, isOptional, isSetDefaultValue, isVisible, removeSimpleParameterListener, setDefaultValue, setEnabled, setIgnoreIfDisabled, setIgnoreIfInvisible, setLabel, setValue, setVisible, validate

Methods inherited from class csbase.logic.algorithms.parameters.Parameter
compareTo, equals, getName, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TableParameter
```
public TableParameter(String name,
                      String label,
                      String description,
                      boolean isOptional,
                      boolean isVisible,
                      String commandLinePattern,
                      List<? extends TableColumn<?>> columns,
                      boolean delimitTable,
                      boolean delimitRows,
                      Integer fixedRowCount,
                      Integer visibleRowCount,
                      Integer minRowCount,
                      Integer maxRowCount)
```
    Cria um parâmetro do tipo tabela.
    
    Parameters:
    
    name - O nome (Não aceita null).
    
    label - O rótulo (Não aceita null).
    
    description - A descrição (Não aceita null).
    
    isOptional - Indica se o parâmetro é opcional.
    
    isVisible - Indica se o parâmetro deve ficar visível.
    
    commandLinePattern - O padrão para construção da linha de comando. O padrão será utilizado para escrever o trecho da linha do comando referente ao parâmetro. Esta string será passada para o método MessageFormat.format(String,Object...). O primeiro formato ({0}) é referente ao nome e o segundo formato ({1}) é referente ao valor. Se null o parâmetro não produzirá saída na linha de comando.
    
    columns - As colunas (Não aceita null e não pode estar vazia).
    
    delimitTable - Indica se deve delimitar a tabela na linha de comando a ser gerada.
    
    delimitRows - Indica se deve delimitar as linhas da tabela na linha de comando a ser gerada.
    
    fixedRowCount - A quantidade de linhas da tabela (Aceita null - tem que ser um número positivo).
    
    visibleRowCount - O número de linhas da tabela que devem estar visíveis.
    
    maxRowCount - número máximo de linhas.
    
    minRowCount - número mínimo de linhas.
- Method Detail
  - addTableParameterListener
```
public final void addTableParameterListener(TableParameterListener listener)
```
    Adiciona um observador.
    
    Parameters:
    
    listener - O observador (Não aceita null).
  - addRow
```
public final void addRow(RowValue rowValue)
```
    Adição de linha
    
    Parameters:
    
    rowValue - a linha
  - createRow
```
public final void createRow()
```
    Cria uma linha.
  - hasFixedRowCount
```
public final boolean hasFixedRowCount()
```
    Indica se a quantidade de linhas é fixa.
    
    Returns:
    
    indicativo
  - removeRow
```
public final void removeRow(int rowIndex)
```
    Remove uma linha específica.
    
    Parameters:
    
    rowIndex - O índice da linha (De 0 a quantidade de linhas - 1).
  - delimitRows
```
public final boolean delimitRows()
```
    Indica se deve delimitar as linhas da tabela na linha de comando gerada.
    
    Returns:
    
    indicativo.
  - delimitTable
```
public final boolean delimitTable()
```
    Indica se deve delimitar a tabela na linha de comando gerada.
    
    Returns:
    
    indicativo
  - getColumnCount
```
public final int getColumnCount()
```
    Obtém a quantidade de colunas.
    
    Returns:
    
    a quantidade
  - getVisibleRowCount
```
public final Integer getVisibleRowCount()
```
    Obtém a quantidade de linhas que deve estar visível.
    
    Returns:
    
    a quantidade.
  - getMaxRowCount
```
public final Integer getMaxRowCount()
```
    Obtém a quantidade máxima de linhas.
    
    Returns:
    
    a quantidade.
  - getMinRowCount
```
public final Integer getMinRowCount()
```
    Obtém a quantidade mínima de linhas.
    
    Returns:
    
    a quantidade.
  - getColumns
```
public final List<TableColumn<?>> getColumns()
```
    Obtém a lista de colunas.
    
    A lista retornada é imutável (veja Collections.unmodifiableList(List)).
    
    Returns:
    
    .
  - getColumnById
```
public final TableColumn<?> getColumnById(String columnId)
```
    Obtém uma coluna dado o seu identificador.
    
    Parameters:
    
    columnId - O identificador da coluna (Não aceita null).
    
    Returns:
    
    A coluna ou null se ela não existir.
  - getCommandValue
```
public final String getCommandValue(CommandLineContext context)
```
    Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.
    
    Overrides:
    
    getCommandValue in class SimpleParameter<List<RowValue>>
    
    Parameters:
    
    context - Contexto para geração da linha de comando.
    
    Returns:
    
    O valor ou null se o valor for nulo.
  - getExpressionValue
```
public final Object getExpressionValue()
```
    Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).
    
    Specified by:
    
    getExpressionValue in class SimpleParameter<List<RowValue>>
    
    Returns:
    
    O valor corrente ou null se não tiver valor corrente ou se este parâmetro não pode participar de expressões.
  - getItemValue
```
public final Object getItemValue(int rowIndex,
                                 int columnIndex)
```
    Obtém o valor de uma célula.
    
    Parameters:
    
    rowIndex - O índice da linha (De 0 a quantidade de linhas - 1).
    
    columnIndex - O índice da coluna (De 0 a quantidade de colunas - 1).
    
    Returns:
    
    O valor ou null se a célula não estiver preenchida.
  - getRowCount
```
public final int getRowCount()
```
    Obtém a quantidade de linhas da tabela.
    
    Returns:
    
    A quantidade de linhas.
  - getRowValues
```
public final List<RowValue> getRowValues()
```
    Obtém a linha de valores das linhas.
    
    A lista retornada é imutável (veja Collections.unmodifiableList(List)).
    
    Returns:
    
    A lista (Estará vazia se não houver linhas).
  - getTableParameterListeners
```
public final List<TableParameterListener> getTableParameterListeners()
```
    Obtém os observadores.
    
    A lista retornada é imutável (veja Collections.unmodifiableList(List)).
    
    Returns:
    
    Os observador (A lista retornada está vazia se não houver observadores).
  - getType
```
public final String getType()
```
    Obtém um texto que representa o tipo deste parâmetros.
    
    Specified by:
    
    getType in class SimpleParameter<List<RowValue>>
    
    Returns:
    
    O tipo.
  - getIDLType
```
public final String getIDLType()
```
    Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.
    
    Overrides:
    
    getIDLType in class SimpleParameter<List<RowValue>>
    
    Returns:
    
    O identificador do tipo IDL ou null se não possuir interface IDL.
  - getValueAsText
```
public final String getValueAsText()
```
    Obtém o valor corrente sob a forma de string.
    
    Se método é completar ao método SimpleParameter.setValueAsText(String).
    
    Overrides:
    
    getValueAsText in class SimpleParameter<List<RowValue>>
    
    Returns:
    
    O valor corrente sob a forma de string ou null se ele não existir.
  - exportValue
```
public final Map<String,Object> exportValue()
```
    Exporta o valor do parâmetro como um mapa "nome->valor".
    
    Overrides:
    
    exportValue in class SimpleParameter<List<RowValue>>
    
    Returns:
    
    O valor do parâmetro como um mapa.
  - importValue
```
public final void importValue(Map<String,Object> parameterValues)
```
    Importa o valor do parâmetro a partir de um mapa "nome->valor".
    
    Overrides:
    
    importValue in class SimpleParameter<List<RowValue>>
    
    Parameters:
    
    parameterValues - O mapa com o valor do parâmetro.
  - resetValue
```
public final void resetValue()
```
    Atribui o valor padrão ao parâmetro.
    
    Overrides:
    
    resetValue in class SimpleParameter<List<RowValue>>
  - setItemValue
```
public final boolean setItemValue(Object value,
                                  int rowIndex,
                                  int columnIndex)
```
    Atribui um valor a uma célula.
    
    Gera o evento ParameterListener.valueWasChanged(Parameter).
    
    Parameters:
    
    value - O valor (Aceita null).
    
    rowIndex - O índice da linha (De 0 a quantidade de linhas - 1).
    
    columnIndex - O índice da coluna (De 0 a quantidade de colunas - 1).
    
    Returns:
    
    true em caso de sucesso ou false se o valor informado for igual ao valor armazenado na célula.
  - setValueAsText
```
public final void setValueAsText(String parameterValue)
                          throws ParseException
```
    Atribui o valor corrente sob a forma de string.
    
    Se método é completar ao método SimpleParameter.getValueAsText().
    
    Specified by:
    
    setValueAsText in class SimpleParameter<List<RowValue>>
    
    Parameters:
    
    parameterValue - O valor corrente sob a forma de string (Aceita null).
    
    Throws:
    
    ParseException - Se o valor passado não estiver em um formato aceito por este parâmetro.
  - valueWasChanged
```
public final void valueWasChanged(Object newValue,
                                  int columnIndex)
```
    Avisa ao observador sobre uma mudança no valor da linha da tabela.
    
    Specified by:
    
    valueWasChanged in interface RowValueListener
    
    Parameters:
    
    newValue - o novo valor.
    
    columnIndex - o índice da coluna que teve o valor alterado.
  - createParameterValidator
```
public final TableParameterValidator createParameterValidator()
```
    Cria o validador do parâmetro.
    
    Specified by:
    
    createParameterValidator in class SimpleParameter<List<RowValue>>
    
    Returns:
    
    O validador.

Class TableParameter

Constructor Summary

Method Summary

Methods inherited from class csbase.logic.algorithms.parameters.SimpleParameter

Methods inherited from class csbase.logic.algorithms.parameters.Parameter

Methods inherited from class java.lang.Object

Constructor Detail

TableParameter

Method Detail

addTableParameterListener

addRow

createRow

hasFixedRowCount

removeRow

delimitRows

delimitTable

getColumnCount

getVisibleRowCount

getMaxRowCount

getMinRowCount

getColumns

getColumnById

getCommandValue

getExpressionValue

getItemValue

getRowCount

getRowValues

getTableParameterListeners

getType

getIDLType

getValueAsText

exportValue

importValue

resetValue

setItemValue

setValueAsText

valueWasChanged

createParameterValidator