csbase.logic.algorithms.parameters

Class DoubleListParameter

java.lang.Object

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

csbase.logic.algorithms.parameters.SimpleParameter<List<E>>

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

csbase.logic.algorithms.parameters.DoubleListParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<List<Double>>>

public final class DoubleListParameter
extends ListParameter<Double>

Parâmetro Lista de reais.

Author:

lmoreira

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE A representação textual do tipo do parâmetro.

Fields inherited from class csbase.logic.algorithms.parameters.ListParameter

acceptDuplicates, mustSort

Constructor Summary

Constructors

Constructor and Description
DoubleListParameter(String name, String label, String description, List<Double> defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern, Double maximum, boolean includeMaximum, Double minimum, boolean includeMinimum) Cria um Validador.

Method Summary

Modifier and Type	Method and Description
void	addDoubleListParameterListener(DoubleListParameterListener listener) Adiciona um observador a este parâmetro.
protected DoubleParameterValidator	createItemValidator() Cria o validador dos itens da lista.
Double	getItemValueFromText(String itemValue) Decodifica um texto criando um elemento.
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.

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

addElement, createParameterValidator, getCommandItemValue, getCommandValue, getExpressionValue, getItemComparator, getItemValueAsText, getValueAsText, mustSort, removeElement, removeElementObj, setElement, setValueAsText

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

addSimpleParameterListener, exportValue, fireValueWasChangedEvent, fireVisiblityWasChangedEvent, getCommandLine, getCommandLinePattern, getDefaultValue, getDescription, getLabel, getParameterValidator, getSimpleParameterListeners, getValue, 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

Constructor Detail

DoubleListParameter

public DoubleListParameter(String name,
                           String label,
                           String description,
                           List<Double> defaultValue,
                           boolean isOptional,
                           boolean isVisible,
                           String commandLinePattern,
                           Double maximum,
                           boolean includeMaximum,
                           Double minimum,
                           boolean includeMinimum)

Cria um Validador.

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

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

minimum - O mínimo (Aceita null).

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

Method Detail

addDoubleListParameterListener

public void addDoubleListParameterListener(DoubleListParameterListener listener)

Adiciona um observador a este parâmetro.

Parameters:

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

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<List<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 DoubleListParameterListener.minimumWasChanged(DoubleListParameter).

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 DoubleListParameterListener.minimumWasChanged(DoubleListParameter).

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.

getItemValueFromText

public Double getItemValueFromText(String itemValue)
                            throws ParseException

Decodifica um texto criando um elemento.

Specified by:

getItemValueFromText in class ListParameter<Double>

Parameters:

itemValue - O valor do elemento codificado (Aceita null).

Returns:

O valor do elemento.

Throws:

ParseException - Se o valor codificado não representar um elemento que possa ser armazenado neste parâmetro.

createItemValidator

protected DoubleParameterValidator createItemValidator()

Cria o validador dos itens da lista.

Specified by:

createItemValidator in class ListParameter<Double>

Returns:

O validador.