csbase.logic.algorithms.parameters

Class SimpleParameter<V>

java.lang.Object

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

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

Type Parameters:

V - O tipo do valor.

All Implemented Interfaces:

Serializable, Comparable<Parameter<V>>

Direct Known Subclasses:

AbstractFileParameter, BooleanParameter, ClientSGAFileParameter, DoubleParameter, EnumerationParameter, FormulaParameter, IntegerParameter, ListParameter, TableParameter, TextParameter

public abstract class SimpleParameter<V>
extends Parameter<V>

Parâmetro simples.

Author:

lmoreira

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleParameter(String name, String label, String description, V defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern) Cria o parâmetro.

Method Summary

Modifier and Type	Method and Description
void	addSimpleParameterListener(SimpleParameterListener<V> listener) Adiciona um observador.
abstract SimpleParameterValidator<V>	createParameterValidator() Cria o validador do parâmetro.
Map<String,Object>	exportValue() Exporta o valor do parâmetro como um mapa "nome->valor".
protected void	fireValueWasChangedEvent() Dispara o evento SimpleParameterListener.valueWasChanged(SimpleParameter).
protected void	fireVisiblityWasChangedEvent() Dispara o evento SimpleParameterListener.visibilityWasChanged(SimpleParameter).
String	getCommandLine(CommandLineContext context) Monta a linha de comando referente a este parâmetro.
String	getCommandLinePattern() Obtém o padrão da linha de comando.
protected String	getCommandValue(CommandLineContext context) Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.
V	getDefaultValue() Obtém o valor-padrão.
String	getDescription() Obtém a descrição.
abstract Object	getExpressionValue() Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).
String	getLabel() Obtém o rótulo.
SimpleParameterValidator<V>	getParameterValidator() Obtém o validador do parâmetro.
List<SimpleParameterListener<V>>	getSimpleParameterListeners() Obtém os observadores.
abstract String	getType() Obtém um texto que representa o tipo deste parâmetros.
V	getValue() Obtém o valor corrente.
String	getValueAsText() Obtém o valor corrente sob a forma de string.
boolean	ignoreIfDisabled() Retorna verdadeiro se o parâmetro deve ser ignorado se estiver desabilitado ou falso, caso contrário.
boolean	ignoreIfInvisible() Retorna verdadeiro se o parâmetro deve ser ignorado se estiver invisível ou falso, caso contrário.
void	importValue(Map<String,Object> parameterValues) Importa o valor do parâmetro a partir de um mapa "nome->valor".
boolean	isEnabled() Indica se este parâmetro está habilitado ou não.
boolean	isOptional() Indica se o parâmetro é opcional ou obrigatório.
boolean	isSetDefaultValue() Determina se o parâmetro está com o valor padrão.
boolean	isVisible() Determina se o parâmetro está visível no configurador.
boolean	removeSimpleParameterListener(SimpleParameterListener<V> listener) Remove um observador.
void	resetValue() Atribui o valor padrão ao parâmetro.
boolean	setDefaultValue(V defaultValue) Atribui um valor-padrão a este parâmetro.
boolean	setEnabled(boolean isEnabled) Habilita/desabilita este parâmetro.
void	setIgnoreIfDisabled(boolean ignoreIfDisabled) Determina se o parâmetro deve ser ignorado caso esteja desabilitado.
void	setIgnoreIfInvisible(boolean ignoreIfInvisible) Determina se o parâmetro deve ser ignorado caso esteja invisível.
boolean	setLabel(String label) Modifica o rótulo de um parâmetro
boolean	setValue(V value) Atribui um valor corrente a este parâmetro.
abstract void	setValueAsText(String parameterValue) Atribui o valor corrente sob a forma de string.
boolean	setVisible(boolean isVisible) Exibe/oculta este parâmetro.
Validation	validate(ValidationContext context) Verifica se os valores armazenados no parâmetro são válidos.

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

SimpleParameter

protected SimpleParameter(String name,
                          String label,
                          String description,
                          V defaultValue,
                          boolean isOptional,
                          boolean isVisible,
                          String commandLinePattern)

Cria o parâmetro.

Parameters:

name - O nome (Não aceita null).

label - O rótulo (Não aceita null).

description - A descrição (Não aceita null).

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

isOptional - Indica se o valor do 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.

Method Detail

addSimpleParameterListener

public final void addSimpleParameterListener(SimpleParameterListener<V> listener)

Adiciona um observador.

Parameters:

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

exportValue

public Map<String,Object> exportValue()

Exporta o valor do parâmetro como um mapa "nome->valor".

Specified by:

exportValue in class Parameter<V>

Returns:

O valor do parâmetro como um mapa.

getCommandLine

public final String getCommandLine(CommandLineContext context)

Monta a linha de comando referente a este parâmetro.

Specified by:

getCommandLine in class Parameter<V>

Parameters:

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

Returns:

a linha de comando.

getCommandLinePattern

public String getCommandLinePattern()

Obtém o padrão da linha de comando.

Returns:

.

getDefaultValue

public V getDefaultValue()

Obtém o valor-padrão.

Returns:

O valor-padrão ou null se ele não existir.

getDescription

public final String getDescription()

Obtém a descrição.

Returns:

A descrição.

getExpressionValue

public abstract Object getExpressionValue()

Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).

Returns:

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

getLabel

public final String getLabel()

Obtém o rótulo.

Returns:

O rótulo.

getSimpleParameterListeners

public final List<SimpleParameterListener<V>> getSimpleParameterListeners()

Obtém os observadores.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Returns:

A lista de observadores (a lista estará vazia se não houver observadores).

getType

public abstract String getType()

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

Returns:

O tipo.

getValue

public final V getValue()

Obtém o valor corrente.

Returns:

O valor corrente ou null se ele não existir.

getValueAsText

public String getValueAsText()

Obtém o valor corrente sob a forma de string.

Se método é completar ao método setValueAsText(String).

Returns:

O valor corrente sob a forma de string ou null se ele não existir.

importValue

public void importValue(Map<String,Object> parameterValues)

Importa o valor do parâmetro a partir de um mapa "nome->valor".

Specified by:

importValue in class Parameter<V>

Parameters:

parameterValues - O mapa com o valor do parâmetro.

isEnabled

public final boolean isEnabled()

Indica se este parâmetro está habilitado ou não.

Returns:

true se o parâmetro estive habilitado ou false caso contrário.

isOptional

public final boolean isOptional()

Indica se o parâmetro é opcional ou obrigatório.

Um parâmetro é obrigatório se ele precisa ter um valor corrente para estar válido.

Returns:

true - opcional ou false - obrigatório.

isSetDefaultValue

public boolean isSetDefaultValue()

Determina se o parâmetro está com o valor padrão.

Specified by:

isSetDefaultValue in class Parameter<V>

Returns:

verdadeiro se o parâmetro está com o valor padrão ou falso, caso contrário.

isVisible

public boolean isVisible()

Determina se o parâmetro está visível no configurador.

Specified by:

isVisible in class Parameter<V>

Returns:

verdadeiro se o parâmetro está visível ou falso, caso contrário.

removeSimpleParameterListener

public final boolean removeSimpleParameterListener(SimpleParameterListener<V> listener)

Remove um observador.

Parameters:

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

Returns:

true se puder remover o listener ou false se o observador não existia.

resetValue

public void resetValue()

Atribui o valor padrão ao parâmetro.

Specified by:

resetValue in class Parameter<V>

setDefaultValue

public final boolean setDefaultValue(V defaultValue)

Atribui um valor-padrão a este parâmetro.

Se o valor-padrão for modificado, ele irá gerar o evento SimpleParameterListener.defaultValueWasChanged(SimpleParameter).

Parameters:

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

Returns:

true se ele for modificado ou false se o valor-padrão atual for igual ao valor fornecido.

setEnabled

public final boolean setEnabled(boolean isEnabled)

Habilita/desabilita este parâmetro.

Se o estado mudar, ele irá gerar o evento SimpleParameterListener.capabilityWasChanged(SimpleParameter)

Parameters:

isEnabled - true para habilitar ou false para desabilitar.

Returns:

true se houver mudança de estado ou false se o estado atual foi igual ao estado esperado (exemplo: habilitar um parâmetro já habilitado).

setLabel

public final boolean setLabel(String label)

Modifica o rótulo de um parâmetro

.

Se o valor corrente for modificado, ele irá gerar o evento SimpleParameterListener.labelWasChanged(SimpleParameter).

Parameters:

label - O rótulo (Não aceita null).

Returns:

true se ele for modificado ou false se o rótulo corrente for igual ao rótulo fornecido.

setValue

public boolean setValue(V value)

Atribui um valor corrente a este parâmetro.

Se o valor corrente for modificado, ele irá gerar o evento SimpleParameterListener.valueWasChanged(SimpleParameter).

Parameters:

value - O valor (Aceita null).

Returns:

true se ele for modificado ou false se o valor corrente for igual ao valor fornecido.

setValueAsText

public abstract void setValueAsText(String parameterValue)
                             throws ParseException

Atribui o valor corrente sob a forma de string.

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

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.

setVisible

public final boolean setVisible(boolean isVisible)

Exibe/oculta este parâmetro.

Se o estado mudar, ele irá gerar o evento SimpleParameterListener.visibilityWasChanged(SimpleParameter)

Specified by:

setVisible in class Parameter<V>

Parameters:

isVisible - true para exibir ou false para ocultar.

Returns:

true se houver mudança de estado ou false se o estado atual foi igual ao estado esperado (exemplo: exibir um parâmetro já visível).

fireValueWasChangedEvent

protected void fireValueWasChangedEvent()

Dispara o evento SimpleParameterListener.valueWasChanged(SimpleParameter).

fireVisiblityWasChangedEvent

protected final void fireVisiblityWasChangedEvent()

Dispara o evento SimpleParameterListener.visibilityWasChanged(SimpleParameter).

getCommandValue

protected String getCommandValue(CommandLineContext context)

Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.

Parameters:

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

Returns:

O valor ou null se o valor for nulo.

ignoreIfInvisible

public boolean ignoreIfInvisible()

Retorna verdadeiro se o parâmetro deve ser ignorado se estiver invisível ou falso, caso contrário.

Returns:

ignoreIfInvisible verdadeiro se o parâmetro deve ser ignorado se estiver invisível ou falso, caso contrário.

setIgnoreIfInvisible

public void setIgnoreIfInvisible(boolean ignoreIfInvisible)

Determina se o parâmetro deve ser ignorado caso esteja invisível.

Parameters:

ignoreIfInvisible - verdadeiro se o parâmetro deve ser ignorado se estiver invisível ou falso, caso contrário.

ignoreIfDisabled

public boolean ignoreIfDisabled()

Retorna verdadeiro se o parâmetro deve ser ignorado se estiver desabilitado ou falso, caso contrário.

Returns:

ignoreIfDisabled verdadeiro se o parâmetro deve ser ignorado se estiver desabilitado ou falso, caso contrário.

setIgnoreIfDisabled

public void setIgnoreIfDisabled(boolean ignoreIfDisabled)

Determina se o parâmetro deve ser ignorado caso esteja desabilitado.

Parameters:

ignoreIfDisabled - verdadeiro se o parâmetro deve ser ignorado se estiver desabilitado ou falso, caso contrário.

validate

public final Validation validate(ValidationContext context)
                          throws RemoteException

Verifica se os valores armazenados no parâmetro são válidos.

Specified by:

validate in class Parameter<V>

Parameters:

context - contexto usado na validação.

Returns:

O resultado da validação.

Throws:

RemoteException - em caso de erro na comunicação com servidor.

getParameterValidator

public SimpleParameterValidator<V> getParameterValidator()

Obtém o validador do parâmetro.

Returns:

O validador.

createParameterValidator

public abstract SimpleParameterValidator<V> createParameterValidator()

Cria o validador do parâmetro.

Returns:

O validador.