csbase.logic.algorithms.parameters

Class FormulaParameter

java.lang.Object

csbase.logic.algorithms.parameters.Parameter<V>

csbase.logic.algorithms.parameters.SimpleParameter<java.lang.String>

csbase.logic.algorithms.parameters.FormulaParameter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Parameter<java.lang.String>>

public final class FormulaParameter
extends SimpleParameter<java.lang.String>

Parâmetro do Tipo Fórmula: este parâmetro permite que o usuário escreva fórmulas matemáticas.

Este tipo de parâmetro gera uma linha de comando codificada para que o shell que executa o comando não tenha problemas com caracteres especiais. O usuário pode informar uma expressão como: x + (y - 3). E o parâmetro irá gerar uma linha de comando que não gera problemas no shell. Por exemplo, o valor para o comando para x + (y - 3) é x__PlusSign__OpenRoundBracket__y__MinusSign__3__CloseRoundBracket__.

O arquivo de configuração desta classe no seu arquivo de properties (FormulaParameter.properties) precisa definir uma tabela com as substituições. A tabela é formada por 2 vetores de strings. O caractere de usuário é o caractere especial que o usuário pode digitar, mas que é substituido ao gerar a linha de comando. O texto de comando é o texto que substitui o caractere de usuário. O vetor com prefixo é o vetor de caracteres de usuários. O vetor com prefixo é o vetor de textos de comandos.

Um trecho do arquivo de configuração: user_text.1 = <(> cmd_text.1 = OpenRoundBracket user_text.2 = <)> cmd_text.2 = CloseRoundBracket user_text.3 = <[> cmd_text.3 = OpenSquareBracket user_text.4 = <]> cmd_text.4 = CloseSquareBracket Este trecho indica que se o usuário digitar "(", ")", "[", "]" o valor gerado na linha de comando será, respectivamente, OpenRoundBracket, CloseRoundBracket, OpenSquareBracket e CloseSquareBracket.

Os caracteres "<" e ">" são utilizados para delimitar o caractere que irá ser utilizado na substituição, portanto apenas o que está dentro deles é utilizado na substituição.

Apenas letras, dígitos, underline e os caracteres de usuário que estão no arquivo de configuração podem ser utilizados pelo usuário. O caracter underline é um caractere de usuário e o seu texto de comando é Underline.

Apenas letras e dígitos podem ser utilizados no texto de comando.

Para cada caracter trocado, o parâmetro colocará 2 underlines ("_") antes e um depois para demarcar a região que foi substituída. Assim, se o usuário digitar "[", a linha referente a ele será "__OpenSquareBracket__".

Author:

lmoreira

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FormulaParameter(java.lang.String name, java.lang.String label, java.lang.String description, boolean isOptional, boolean isVisible, java.lang.String commandLinePattern) Cria o parâmetro.

Method Summary

Methods

Modifier and Type	Method and Description
FormulaParameterValidator	createParameterValidator() Cria o validador do parâmetro.
java.lang.String	getCommandValue() Obtém o valor da linha de comando para o valor corrente.
protected java.lang.String	getCommandValue(CommandLineContext context) Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.
java.lang.String	getEncodedValue(java.lang.String value) Obtém o valor codificado da fórmula (sem o uso de caracteres que possam gerar problemas ao serem passados na linha de comando).
java.lang.Object	getExpressionValue() Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).
java.lang.String	getIDLType() Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.
java.lang.String	getType() Obtém um texto que representa o tipo deste parâmetros.
void	setValueAsText(java.lang.String parameterValue) Atribui o valor corrente sob a forma de string.

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

addSimpleParameterListener, exportValue, fireValueWasChangedEvent, fireVisiblityWasChangedEvent, getCommandLine, getCommandLinePattern, getDefaultValue, getDescription, getLabel, getParameterValidator, getSimpleParameterListeners, getValue, getValueAsText, ignoreIfDisabled, ignoreIfInvisible, importValue, isEnabled, isOptional, isSetDefaultValue, isVisible, removeSimpleParameterListener, resetValue, 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

FormulaParameter

public FormulaParameter(java.lang.String name,
                java.lang.String label,
                java.lang.String description,
                boolean isOptional,
                boolean isVisible,
                java.lang.String commandLinePattern)

Cria o parâmetro.

Parameters:

name - Nome do parâmetro (Não aceita null).

label - Rótulo do parâmetro (Não aceita null).

description - Descrição do parâmetro (Aceita null).

isOptional - Indica se o parâmetro é opcional/obrigatório.

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.

Method Detail

getCommandValue

public java.lang.String getCommandValue()

Obtém o valor da linha de comando para o valor corrente.

Returns:

O valor da linha de comando (null caso não haja um valor).

getEncodedValue

public java.lang.String getEncodedValue(java.lang.String value)

Obtém o valor codificado da fórmula (sem o uso de caracteres que possam gerar problemas ao serem passados na linha de comando).

Parameters:

value - o valor original.

Returns:

o valor codificado.

getExpressionValue

public java.lang.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<java.lang.String>

Returns:

O valor corrente ou null se não tiver valor corrente ou se este parâmetro não pode participar de expressões.

getType

public java.lang.String getType()

Obtém um texto que representa o tipo deste parâmetros.

Specified by:

getType in class SimpleParameter<java.lang.String>

Returns:

O tipo.

getIDLType

public java.lang.String getIDLType()

Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.

Overrides:

getIDLType in class SimpleParameter<java.lang.String>

Returns:

O identificador do tipo IDL ou null se não possuir interface IDL.

setValueAsText

public void setValueAsText(java.lang.String parameterValue)

Atribui o valor corrente sob a forma de string.

Se método é completar ao método SimpleParameter.getValueAsText().

Specified by:

setValueAsText in class SimpleParameter<java.lang.String>

Parameters:

parameterValue - O valor corrente sob a forma de string (Aceita null).

getCommandValue

protected java.lang.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<java.lang.String>

Parameters:

context - Contexto para geração da linha de comando.

Returns:

O valor ou null se o valor for nulo.

createParameterValidator

public FormulaParameterValidator createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<java.lang.String>

Returns:

O validador.