csbase.logic.algorithms.parameters

Class IntegerListParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.ListParameter<java.lang.Integer>

csbase.logic.algorithms.parameters.IntegerListParameter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Parameter<java.util.List<java.lang.Integer>>>

public final class IntegerListParameter
extends ListParameter<java.lang.Integer>

Parâmetro do Tipo Lista de Inteiros.

Author:

lmoreira

See Also:

Serialized Form

Field Summary

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

acceptDuplicates, mustSort

Constructor Summary

Constructors

Constructor and Description
IntegerListParameter(java.lang.String name, java.lang.String label, java.lang.String description, java.util.List<java.lang.Integer> defaultValue, boolean isOptional, boolean isVisible, java.lang.String commandLinePattern, java.lang.Integer maximum, java.lang.Integer minimum) Cria um parâmetro.

Method Summary

Methods

Modifier and Type	Method and Description
void	addIntegerListParameterListener(IntegerListParameterListener listener) Adiciona um observador a este parâmetro.
protected IntegerParameterValidator	createItemValidator() Cria o validador dos itens da lista.
java.lang.String	getIDLType() Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.
protected java.lang.Integer	getItemValueFromText(java.lang.String itemValue) Decodifica um texto criando um elemento.
java.lang.Integer	getMaximum() Obtém o valor máximo.
java.lang.Integer	getMinimum() Obtém o valor mínimo.
java.lang.String	getType() Obtém um texto que representa o tipo deste parâmetros.
boolean	setMaximum(java.lang.Integer maximum) Atribui o máximo a este parâmetro.
boolean	setMinimum(java.lang.Integer minimum) Atribui o mínimo a este parâmetro.

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

Constructor Detail

IntegerListParameter

public IntegerListParameter(java.lang.String name,
                    java.lang.String label,
                    java.lang.String description,
                    java.util.List<java.lang.Integer> defaultValue,
                    boolean isOptional,
                    boolean isVisible,
                    java.lang.String commandLinePattern,
                    java.lang.Integer maximum,
                    java.lang.Integer minimum)

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; se o mínimo existir ele tem que ser maior ou igual a ele).

minimum - O mínimo (Aceita null; se o máximo existir ele tem que ser menor ou igual a ele).

Method Detail

addIntegerListParameterListener

public void addIntegerListParameterListener(IntegerListParameterListener listener)

Adiciona um observador a este parâmetro.

Parameters:

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

getMaximum

public java.lang.Integer getMaximum()

Obtém o valor máximo.

Returns:

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

getMinimum

public java.lang.Integer getMinimum()

Obtém o valor mínimo.

Returns:

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

getType

public java.lang.String getType()

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

Specified by:

getType in class SimpleParameter<java.util.List<java.lang.Integer>>

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.util.List<java.lang.Integer>>

Returns:

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

setMaximum

public boolean setMaximum(java.lang.Integer maximum)

Atribui o máximo a este parâmetro.

Parameters:

maximum - O máximo (Aceita null; se o mínimo existir ele tem que ser maior ou igual a ele).

Returns:

true em caso de sucesso ou false se o valor máximo atual for igual ao valor máximo fornecido.

setMinimum

public boolean setMinimum(java.lang.Integer minimum)

Atribui o mínimo a este parâmetro.

Parameters:

minimum - O mínimo (Aceita null; se o máximo existir ele tem que ser menor ou igual a ele).

Returns:

true em caso de sucesso ou false se o valor mínimo atual for igual ao valor mínimo fornecido.

getItemValueFromText

protected java.lang.Integer getItemValueFromText(java.lang.String itemValue)
                                          throws ParseException

Decodifica um texto criando um elemento.

Specified by:

getItemValueFromText in class ListParameter<java.lang.Integer>

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 IntegerParameterValidator createItemValidator()

Cria o validador dos itens da lista.

Specified by:

createItemValidator in class ListParameter<java.lang.Integer>

Returns:

O validador.