csbase.logic.algorithms.parameters

Class IntegerParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.IntegerParameter

All Implemented Interfaces:

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

public final class IntegerParameter
extends SimpleParameter<java.lang.Integer>

Parâmetro do Tipo Inteiro.

Author:

lmoreira

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_VALUE Valor indicativo de erro.

Constructor Summary

Constructors

Constructor and Description
IntegerParameter(java.lang.String name, java.lang.String label, java.lang.String description, 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	addIntegerParameterListener(IntegerParameterListener listener) Adiciona um observador a este parâmetro.
IntegerParameterValidator	createParameterValidator() Cria o validador do parâmetro.
java.lang.Object	getExpressionValue() Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).
java.lang.String	getIDLType() Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.
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.
void	setValueAsText(java.lang.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

ERROR_VALUE

public static final int ERROR_VALUE

Valor indicativo de erro.

See Also:

Constant Field Values

Constructor Detail

IntegerParameter

public IntegerParameter(java.lang.String name,
                java.lang.String label,
                java.lang.String description,
                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

addIntegerParameterListener

public void addIntegerParameterListener(IntegerParameterListener listener)

Adiciona um observador a este parâmetro.

Parameters:

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

getExpressionValue

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

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 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.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.lang.Integer>

Returns:

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

setValueAsText

public void setValueAsText(java.lang.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<java.lang.Integer>

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.

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.

createParameterValidator

public IntegerParameterValidator createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<java.lang.Integer>

Returns:

O validador.