csbase.logic.algorithms.parameters

Class DoubleParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.DoubleParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<Double>>

public final class DoubleParameter
extends SimpleParameter<Double>

Parâmetro do tipo real.

Author:

lmoreira

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static double	ERROR_VALUE Valor indicativo de erro.
static String	TYPE A representação textual do tipo do parâmetro.

Constructor Summary

Constructors

Constructor and Description
DoubleParameter(String name, String label, String description, Double defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern, Double maximum, boolean isMaximumIncluded, Double minimum, boolean isMinimumIncluded) Cria um parâmetro.

Method Summary

Modifier and Type	Method and Description
void	addDoubleParameterListener(DoubleParameterListener listener) Adiciona o observador a este parâmetro.
DoubleParameterValidator	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).
Double	getMaximum() Obtém o máximo.
Double	getMinimum() Obtém o mínimo.
String	getType() Obtém um texto que representa o tipo deste parâmetros.
boolean	isMaximumIncluded() Indica se o valor máximo está entre os valores válidos.
boolean	isMinimumIncluded() Indica se o valor mínimo está entre os valores válidos.
boolean	setMaximum(Double maximum, boolean maximumIncluded) Atribui o máximo e se o máximo é incluído.
boolean	setMinimum(Double minimum, boolean minimumIncluded) Atribui o mínimo e se o minimo é incluído.
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

Field Detail

TYPE

public static final String TYPE

A representação textual do tipo do parâmetro.

See Also:

Constant Field Values

ERROR_VALUE

public static final double ERROR_VALUE

Valor indicativo de erro.

See Also:

Constant Field Values

Constructor Detail

DoubleParameter

public DoubleParameter(String name,
                       String label,
                       String description,
                       Double defaultValue,
                       boolean isOptional,
                       boolean isVisible,
                       String commandLinePattern,
                       Double maximum,
                       boolean isMaximumIncluded,
                       Double minimum,
                       boolean isMinimumIncluded)

Cria um 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 é 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.

maximum - O máximo (Aceita null).

isMaximumIncluded - Indica se o valor máximo está entre os valores válidos.

minimum - O mínimo (Aceita null).

isMinimumIncluded - Indica se o valor mínimo está entre os valores válidos.

Method Detail

addDoubleParameterListener

public void addDoubleParameterListener(DoubleParameterListener listener)

Adiciona o observador a este parâmetro.

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<Double>

Returns:

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

getMaximum

public Double getMaximum()

Obtém o máximo.

Returns:

O máximo ou null se ele não existir.

getMinimum

public Double getMinimum()

Obtém o mínimo.

Returns:

O mínimo ou null se ele não existir.

getType

public String getType()

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

Specified by:

getType in class SimpleParameter<Double>

Returns:

O tipo.

isMaximumIncluded

public boolean isMaximumIncluded()

Indica se o valor máximo está entre os valores válidos.

Returns:

.

isMinimumIncluded

public boolean isMinimumIncluded()

Indica se o valor mínimo está entre os valores válidos.

Returns:

.

setMaximum

public boolean setMaximum(Double maximum,
                          boolean maximumIncluded)

Atribui o máximo e se o máximo é incluído.

Gera o evento DoubleParameterListener.minimumWasChanged(DoubleParameter).

Parameters:

maximum - O máximo (Aceita null).

maximumIncluded - Indica se o máximo deve ou não ser considerado um valor válido.

Returns:

true em caso de sucesso ou false se o máximo informado é igual ao máximo anterior.

setMinimum

public boolean setMinimum(Double minimum,
                          boolean minimumIncluded)

Atribui o mínimo e se o minimo é incluído.

Gera o evento DoubleParameterListener.minimumWasChanged(DoubleParameter).

Parameters:

minimum - O mínimo (Aceita null).

minimumIncluded - Indica se o mínimo deve ou não ser considerado um valor válido.

Returns:

true em caso de sucesso ou false se o mínimo informado é igual ao mpinimo anterior.

setValueAsText

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

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.

createParameterValidator

public DoubleParameterValidator createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<Double>

Returns:

O validador.