csbase.logic.algorithms.parameters

Class TextParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.TextParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<String>>

public final class TextParameter
extends SimpleParameter<String>

Parâmetro do tipo Texto.

Author:

lmoreira

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextParameter(String name, String label, String description, String defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern, Integer maxCharacters) Cria um parâmetro do tipo texto.

Method Summary

Modifier and Type	Method and Description
void	addTextParameterListener(TextParameterListener listener) Adiciona um observador a lista de observadores deste parâmetro do tipo texto.
TextParameterValidator	createParameterValidator() Cria o validador do parâmetro.
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.
Integer	getMaxCharacters() Obtém o número máximo de caracteres para que o valor de uma célula seja considerado válido.
String	getType() Obtém um texto que representa o tipo deste parâmetros.
boolean	isEditable() Indica se o parâmetro é editável ou não.
void	setEditable(boolean isEditable) Permite/Proibe a edição do parâmetro.
void	setValueAsText(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, getCommandValue, 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

TextParameter

public TextParameter(String name,
                     String label,
                     String description,
                     String defaultValue,
                     boolean isOptional,
                     boolean isVisible,
                     String commandLinePattern,
                     Integer maxCharacters)

Cria um parâmetro do tipo texto.

Parameters:

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

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

description - A descrição do parâmetro (Não aceita null).

defaultValue - O valor-padrão (Aceita null).

isOptional - Indica se é 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.

maxCharacters - O número máximo de caracteres para que o valor de uma célula seja considerado válido (Aceita null).

Method Detail

addTextParameterListener

public void addTextParameterListener(TextParameterListener listener)

Adiciona um observador a lista de observadores deste parâmetro do tipo texto.

Parameters:

listener - O observador (Não aceita null).

getExpressionValue

public 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<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.

getMaxCharacters

public Integer getMaxCharacters()

Obtém o número máximo de caracteres para que o valor de uma célula seja considerado válido.

Returns:

O número máximo de caracteres ou null caso não haja um número máximo de caracteres definido.

getType

public String getType()

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

Specified by:

getType in class SimpleParameter<String>

Returns:

O tipo.

getIDLType

public String getIDLType()

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

Overrides:

getIDLType in class SimpleParameter<String>

Returns:

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

isEditable

public boolean isEditable()

Indica se o parâmetro é editável ou não.

Returns:

.

setEditable

public void setEditable(boolean isEditable)

Permite/Proibe a edição do parâmetro.

Parameters:

isEditable - .

setValueAsText

public void setValueAsText(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<String>

Parameters:

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

createParameterValidator

public TextParameterValidator createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<String>

Returns:

O validador.