csbase.logic.algorithms.parameters

Class EnumerationParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.EnumerationParameter

All Implemented Interfaces:

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

public final class EnumerationParameter
extends SimpleParameter<EnumerationItem>

Parâmetro enumeração

O parâmetro enumeração é utilizado para parâmetros que aceitem um conjunto pequeno e discreto de dados. Exemplo: dias da semana.

Um parâmetro enumeração possui 1 ou mais ítems de enumeração ( EnumerationItem), porém apenas 1 único item está selecionado por vez. O item selecionado pode ser obtido utilizando o método SimpleParameter.getValue() e pode ser modificado utilizando o método #setValue(EnumerationItem).

Author:

lmoreira

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EnumerationParameter(java.lang.String name, java.lang.String label, java.lang.String description, EnumerationItem defaultValue, boolean isVisible, java.lang.String commandLinePattern, java.util.List<EnumerationItem> items, boolean mustSortItems) Cria um parâmetro enumeração.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEnumerationParameterListener(EnumerationParameterListener listener) Adiciona um observador a este parâmetro.
EnumerationParameterValidator	createParameterValidator() Cria o validador do parâmetro.
java.util.Map<java.lang.String,java.lang.Object>	exportValue() Exporta o valor do parâmetro como um mapa "nome->valor".
protected java.lang.String	getCommandValue(CommandLineContext context) Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.
EnumerationItem	getDefaultValue() Obtém o valor-padrão.
java.lang.Object	getExpressionValue() Um item de enumeração não pode ser utilizado em expressões.
java.lang.String	getIDLType() Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.
EnumerationItem	getItem(java.lang.String id) Obtém um item de enumeração dado um identificador.
java.util.List<EnumerationItem>	getItems() Obtém uma lista de itens de enumeração.
java.lang.String	getType() Obtém um texto que representa o tipo deste parâmetros.
java.lang.String	getValueAsText() O valor retornado é o identificador do item que está selecionado no momento.
void	importValue(java.util.Map<java.lang.String,java.lang.Object> parameterValues) Importa o valor do parâmetro a partir de um mapa "nome->valor".
void	setValueAsText(java.lang.String parameterValue) O valor utilizado é o identificador de um item de enumeração.
boolean	setVisibleItem(java.lang.String itemId, boolean isVisible) Exibe/Oculta um item de enumeração.

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

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

EnumerationParameter

public EnumerationParameter(java.lang.String name,
                    java.lang.String label,
                    java.lang.String description,
                    EnumerationItem defaultValue,
                    boolean isVisible,
                    java.lang.String commandLinePattern,
                    java.util.List<EnumerationItem> items,
                    boolean mustSortItems)

Cria um parâmetro enumeração.

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 do parâmetro (Não aceita null).

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.

items - Os itens da enumeração (Não aceita null), o valor-padrão deve ser um dos itens.

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

Method Detail

addEnumerationParameterListener

public void addEnumerationParameterListener(EnumerationParameterListener listener)

Adiciona um observador a este parâmetro.

Parameters:

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

exportValue

public java.util.Map<java.lang.String,java.lang.Object> exportValue()

Exporta o valor do parâmetro como um mapa "nome->valor".

Overrides:

exportValue in class SimpleParameter<EnumerationItem>

Returns:

O valor do parâmetro como um mapa.

importValue

public void importValue(java.util.Map<java.lang.String,java.lang.Object> parameterValues)

Importa o valor do parâmetro a partir de um mapa "nome->valor".

Overrides:

importValue in class SimpleParameter<EnumerationItem>

Parameters:

parameterValues - O mapa com o valor do parâmetro.

getDefaultValue

public EnumerationItem getDefaultValue()

Obtém o valor-padrão.

Overrides:

getDefaultValue in class SimpleParameter<EnumerationItem>

Returns:

O valor-padrão ou null se ele não existir.

getExpressionValue

public java.lang.Object getExpressionValue()

Um item de enumeração não pode ser utilizado em expressões. Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).

Specified by:

getExpressionValue in class SimpleParameter<EnumerationItem>

Returns:

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

getItem

public EnumerationItem getItem(java.lang.String id)

Obtém um item de enumeração dado um identificador.

Parameters:

id - O identificador (Não aceita null).

Returns:

O item de enumeração ou null se não houver um item de enumeração com o identificador fornecido.

getItems

public java.util.List<EnumerationItem> getItems()

Obtém uma lista de itens de enumeração.

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

Returns:

A lista de itens.

getType

public java.lang.String getType()

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

Specified by:

getType in class SimpleParameter<EnumerationItem>

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

Returns:

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

getValueAsText

public java.lang.String getValueAsText()

O valor retornado é o identificador do item que está selecionado no momento.

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

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

Overrides:

getValueAsText in class SimpleParameter<EnumerationItem>

Returns:

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

setVisibleItem

public boolean setVisibleItem(java.lang.String itemId,
                     boolean isVisible)

Exibe/Oculta um item de enumeração.

Se bem sucedido, gera o evento EnumerationParameterListener.enumerationItemWasSetVisible(EnumerationParameter, EnumerationItem) .

Gera o evento SimpleParameterListener.valueWasChanged(SimpleParameter) o item de item que está selecionado no momento for o item desejado e está tentando desabilitar o item.

Parameters:

itemId - O identificador do item (Não aceita null).

isVisible - Indica se deve habilitar (true) ou desabilitar ( null) o item.

Returns:

false se o item não existir ou se ele não mudar de estado.

setValueAsText

public void setValueAsText(java.lang.String parameterValue)
                    throws ParseException

O valor utilizado é o identificador de um item de enumeração.

Atribui o valor corrente sob a forma de string.

Se método é completar ao método SimpleParameter.getValueAsText().

Specified by:

setValueAsText in class SimpleParameter<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.

getCommandValue

protected java.lang.String getCommandValue(CommandLineContext context)

Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.

Overrides:

getCommandValue in class SimpleParameter<EnumerationItem>

Parameters:

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

Returns:

O valor ou null se o valor for nulo.

createParameterValidator

public EnumerationParameterValidator createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<EnumerationItem>

Returns:

O validador.