csbase.logic.algorithms.parameters

Class TextListParameter

java.lang.Object

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

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

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

csbase.logic.algorithms.parameters.TextListParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<List<String>>>

public final class TextListParameter
extends ListParameter<String>

Parâmetro do tipo Lista de Texto.

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
TextListParameter(String name, String label, String description, List<String> defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern, Integer maxCharacters) Cria um parâmetro do tipo lista de texto.

Method Summary

Modifier and Type	Method and Description
protected TextParameterValidator	createItemValidator() Cria o validador dos itens da lista.
String	getIDLType() Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.
protected String	getItemValueFromText(String itemValue) Decodifica um texto criando um elemento.
Integer	getMaxCharacters() Obtém o número máximo de caracteres para que o valor de uma célula seja considerado válido.
String	getType() Obtém um texto que representa o tipo deste parâmetros.

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

TextListParameter

public TextListParameter(String name,
                         String label,
                         String description,
                         List<String> defaultValue,
                         boolean isOptional,
                         boolean isVisible,
                         String commandLinePattern,
                         Integer maxCharacters)

Cria um parâmetro do tipo lista de texto.

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

maxCharacters - O número máximo de caracteres para que o valor de uma célula seja considerado válido (Aceita null).

Method Detail

getItemValueFromText

protected String getItemValueFromText(String itemValue)

Decodifica um texto criando um elemento.

Specified by:

getItemValueFromText in class ListParameter<String>

Parameters:

itemValue - O valor do elemento codificado (Aceita null).

Returns:

O valor do elemento.

getType

public String getType()

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

Specified by:

getType in class SimpleParameter<List<String>>

Returns:

O tipo.

getIDLType

public String getIDLType()

Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.

Overrides:

getIDLType in class SimpleParameter<List<String>>

Returns:

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

getMaxCharacters

public Integer getMaxCharacters()

Obtém o número máximo de caracteres para que o valor de uma célula seja considerado válido.

Returns:

O número máximo de caracteres ou null caso não haja um número máximo de caracteres definido.

createItemValidator

protected TextParameterValidator createItemValidator()

Cria o validador dos itens da lista.

Specified by:

createItemValidator in class ListParameter<String>

Returns:

O validador.