csbase.logic.algorithms.parameters

Class ListParameter<E>

java.lang.Object

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

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

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

Type Parameters:

E - O tipo do elemento armazenado na lista.

All Implemented Interfaces:

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

Direct Known Subclasses:

DoubleListParameter, EnumerationListParameter, FileListParameter, IntegerListParameter, TextListParameter, URLListParameter

public abstract class ListParameter<E>
extends SimpleParameter<java.util.List<E>>

Parâmetro do Tipo Lista.

Author:

lmoreira

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	acceptDuplicates Indica se o parâmetro aceita elementos repetidos,
protected boolean	mustSort Indica se os elementos precisam ser ordenados.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListParameter(java.lang.String name, java.lang.String label, java.lang.String description, java.util.List<E> defaultValue, boolean isOptional, boolean isVisible, boolean mustSort, boolean acceptDuplicates, java.lang.String commandLinePattern) Cria o parâmetro.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addElement(E element) Adiciona um elemento ao valor deste parâmetro.
protected abstract SimpleParameterValidator<E>	createItemValidator() Cria o validador dos itens da lista.
ListParameterValidator<E>	createParameterValidator() Cria o validador do parâmetro.
protected java.lang.String	getCommandItemValue(CommandLineContext context, E itemValue) Obtém o valor de um ítem da lista pronto para ser utilizado na linha de comando.
protected java.lang.String	getCommandValue(CommandLineContext context) Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.
java.lang.Object	getExpressionValue() Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).
protected java.util.Comparator<E>	getItemComparator() Cria um comparador de itens da lista.
protected java.lang.String	getItemValueAsText(E element) Codifica um elemento criando um texto.
protected abstract E	getItemValueFromText(java.lang.String elementAsText) Decodifica um texto criando um elemento.
java.lang.String	getValueAsText() Obtém o valor corrente sob a forma de string.
boolean	mustSort() Indica se precisa ordenar a lista de valores.
boolean	removeElement(int index) Remove um elemento específico.
boolean	removeElementObj(E element) Remove elemento específico.
boolean	setElement(int index, E newElement) Troca um elemento por outro.
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, getDefaultValue, getDescription, getIDLType, getLabel, getParameterValidator, getSimpleParameterListeners, getType, 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

mustSort

protected boolean mustSort

Indica se os elementos precisam ser ordenados.

acceptDuplicates

protected boolean acceptDuplicates

Indica se o parâmetro aceita elementos repetidos,

Constructor Detail

ListParameter

protected ListParameter(java.lang.String name,
             java.lang.String label,
             java.lang.String description,
             java.util.List<E> defaultValue,
             boolean isOptional,
             boolean isVisible,
             boolean mustSort,
             boolean acceptDuplicates,
             java.lang.String commandLinePattern)

Cria o 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 parâmetro é opcional.

isVisible - Indica se o parâmetro deve ficar visível.

mustSort - Indica se os caminhos para os arquivos precisam ser ordenados.

acceptDuplicates - Indica se o parâmetro aceita elementos repetidos.

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.

Method Detail

addElement

public final boolean addElement(E element)

Adiciona um elemento ao valor deste parâmetro.

Gera o evento ParameterListener.valueWasChanged(Parameter).

Parameters:

element - O elemento (Não aceita null).

Returns:

true se o elemento foi adicionado com sucesso.

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.util.List<E>>

Returns:

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

getValueAsText

public java.lang.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 SimpleParameter<java.util.List<E>>

Returns:

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

removeElementObj

public final boolean removeElementObj(E element)

Remove elemento específico.

Parameters:

element - elemento

Returns:

indicativo conforme removeElement(int);

removeElement

public final boolean removeElement(int index)

Remove um elemento específico.

Gera o evento ParameterListener.valueWasChanged(Parameter).

Parameters:

index - O índice do elemento (A faixa aceita é de 0 a quantidade de elementos - 1).

Returns:

true se o elemento foi removido com sucesso.

setElement

public final boolean setElement(int index,
                 E newElement)

Troca um elemento por outro.

Gera o evento ParameterListener.valueWasChanged(Parameter).

Parameters:

index - O índice do elemento (A faixa aceita é de 0 a quantidade de elementos - 1).

newElement - O novo elemento (Aceita null).

Returns:

true em caso de sucesso ou false se o elemento que estava armazenado na posição informada é igual ao elemento fornecido.

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.util.List<E>>

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.

getItemValueFromText

protected abstract E getItemValueFromText(java.lang.String elementAsText)
                                   throws ParseException

Decodifica um texto criando um elemento.

Parameters:

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

getItemValueAsText

protected java.lang.String getItemValueAsText(E element)

Codifica um elemento criando um texto.

Parameters:

element - O elemento a ser codificado (Aceita null).

Returns:

O texto codificado (null se o valor do elemento for null).

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

Parameters:

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

Returns:

O valor ou null se o valor for nulo.

getCommandItemValue

protected java.lang.String getCommandItemValue(CommandLineContext context,
                                   E itemValue)

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

Parameters:

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

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

Returns:

O valor convertido.

createParameterValidator

public ListParameterValidator<E> createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<java.util.List<E>>

Returns:

O validador.

createItemValidator

protected abstract SimpleParameterValidator<E> createItemValidator()

Cria o validador dos itens da lista.

Returns:

O validador.

mustSort

public boolean mustSort()

Indica se precisa ordenar a lista de valores.

Returns:

true se precisa e false caso contrário.

getItemComparator

protected java.util.Comparator<E> getItemComparator()

Cria um comparador de itens da lista.

Returns:

o comparador.