csbase.logic.algorithms.parameters

Class EnumerationListParameter

java.lang.Object

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

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

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

csbase.logic.algorithms.parameters.EnumerationListParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<List<EnumerationItem>>>

public final class EnumerationListParameter
extends ListParameter<EnumerationItem>

Enumeração para seleção múltipla.

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
EnumerationListParameter(String name, String label, String description, List<EnumerationItem> defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern) TODO Este construtor será removido numa reestruturação dos testes.
EnumerationListParameter(String name, String label, String description, List<EnumerationItem> defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern, boolean mustSortItems) Cria uma enumeração para seleção múltipla.

Method Summary

Modifier and Type	Method and Description
void	addEnumerationListParameterListener(EnumerationListParameterListener listener) Adiciona um observador de parâmetros.
protected SimpleParameterValidator<EnumerationItem>	createItemValidator() Cria o validador dos itens da lista.
protected String	getCommandItemValue(CommandLineContext context, EnumerationItem itemValue) Obtém o valor de um ítem da lista pronto para ser utilizado na linha de comando.
List<EnumerationItem>	getItems() Obtém os ítens desta enumeração.
EnumerationItem	getItemValueFromText(String itemValue) Decodifica um texto criando um elemento.
String	getType() Obtém um texto que representa o tipo deste parâmetros.
String	getValueAsText() Obtém o valor corrente sob a forma de string.
boolean	mustSortItems() Indica se a enumeração deve ser ordenada.
void	setItems(List<EnumerationItem> items) Modifica os itens da enumeração.
boolean	setValue(List<EnumerationItem> value) Atribui um valor corrente a este parâmetro.
void	setValueAsText(String parameterValue) Atribui o valor corrente sob a forma de string.

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

addElement, createParameterValidator, getCommandValue, getExpressionValue, getItemComparator, getItemValueAsText, mustSort, removeElement, removeElementObj, setElement

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

EnumerationListParameter

public EnumerationListParameter(String name,
                                String label,
                                String description,
                                List<EnumerationItem> defaultValue,
                                boolean isOptional,
                                boolean isVisible,
                                String commandLinePattern)

TODO Este construtor será removido numa reestruturação dos testes. Cria uma enumeração para seleção múltipla.

Parameters:

name - O nome do parâmetro (Não aceita null).

label - O rótulo do parâmetro (Não aceita null).

description - A descrição do parâmetro (Não aceita null).

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

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

EnumerationListParameter

public EnumerationListParameter(String name,
                                String label,
                                String description,
                                List<EnumerationItem> defaultValue,
                                boolean isOptional,
                                boolean isVisible,
                                String commandLinePattern,
                                boolean mustSortItems)

Cria uma enumeração para seleção múltipla.

Parameters:

name - O nome do parâmetro (Não aceita null).

label - O rótulo do parâmetro (Não aceita null).

description - A descrição do parâmetro (Não aceita null).

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

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

mustSortItems - indica se a enumeração deve ficar ordenada.

Method Detail

addEnumerationListParameterListener

public final void addEnumerationListParameterListener(EnumerationListParameterListener listener)

Adiciona um observador de parâmetros.

Parameters:

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

getItems

public List<EnumerationItem> getItems()

Obtém os ítens desta enumeração.

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

Returns:

A lista de ítens (se não houver ítens a lista estará vazio).

getType

public String getType()

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

Specified by:

getType in class SimpleParameter<List<EnumerationItem>>

Returns:

O tipo.

setItems

public void setItems(List<EnumerationItem> items)

Modifica os itens da enumeração. Remove os itens anteriores.

Parameters:

items - Os ítens (Não aceita null).

setValue

public boolean setValue(List<EnumerationItem> value)

Atribui um valor corrente a este parâmetro.

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

Overrides:

setValue in class SimpleParameter<List<EnumerationItem>>

Parameters:

value - O valor (Aceita null).

Returns:

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

getValueAsText

public String getValueAsText()

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

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

Overrides:

getValueAsText in class ListParameter<EnumerationItem>

Returns:

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

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

Overrides:

setValueAsText in class ListParameter<EnumerationItem>

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.

getCommandItemValue

protected String getCommandItemValue(CommandLineContext context,
                                     EnumerationItem itemValue)

Obtém o valor de um ítem da lista pronto para ser utilizado na linha de comando.

Overrides:

getCommandItemValue in class ListParameter<EnumerationItem>

Parameters:

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

itemValue - O valor (Não aceita null).

Returns:

O valor convertido.

getItemValueFromText

public EnumerationItem getItemValueFromText(String itemValue)
                                     throws ParseException

Decodifica um texto criando um elemento.

Specified by:

getItemValueFromText in class ListParameter<EnumerationItem>

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.

mustSortItems

public boolean mustSortItems()

Indica se a enumeração deve ser ordenada.

Returns:

true caso a enumeração esteja ordenada ou false caso contrário.

createItemValidator

protected SimpleParameterValidator<EnumerationItem> createItemValidator()

Cria o validador dos itens da lista.

Specified by:

createItemValidator in class ListParameter<EnumerationItem>

Returns:

O validador.