csbase.logic.algorithms.parameters

Class URLListParameter

java.lang.Object

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

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

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

csbase.logic.algorithms.parameters.URLListParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<List<FileURLValue>>>

Direct Known Subclasses:

InputURLListParameter, OutputURLListParameter

public abstract class URLListParameter
extends ListParameter<FileURLValue>

Parâmetro do tipo lista de URLs.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	fileTypes Os tipos de arquivo que este parâmetro aceita.

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

acceptDuplicates, mustSort

Constructor Summary

Constructors

Constructor and Description
URLListParameter(String name, String label, String description, List<FileURLValue> defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern, String localization, String[] fileTypes, FileParameterMode mode, boolean mustSort, boolean mustExist, EnumSet<URLProtocol> allowedProtocols) Cria um parâmetro do tipo lista de arquivos.

Method Summary

Modifier and Type	Method and Description
protected URLParameterValidator	createItemValidator() Cria o validador dos itens da lista.
URLListParameterValidator	createParameterValidator() Cria o validador do parâmetro.
Map<String,Object>	exportValue() Exporta o valor do parâmetro como um mapa "nome->valor".
EnumSet<URLProtocol>	getAllowedProtocols() Obtém o conjunto de protocolos aceitos na URL.
String	getCommandItemValue(CommandLineContext context, FileURLValue url) Obtém o valor de um ítem da lista pronto para ser utilizado na linha de comando.
String	getCommandValue(CommandLineContext context) Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.
URLProtocol	getDefaultProtocol() Obtém o protocolo padrão do parâmetro (caso não tenha sido especificado nenhum).
Object	getExpressionValue() Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).
String[]	getFileTypes() Obtém os tipos de arquivo que este parâmetro aceita.
FileURLValue	getItemValueFromText(String elementAsText) Decodifica um texto criando um elemento.
String	getLocalization() Define o argumento na linha de comando informando o protoloco usado pelo usuário.
FileParameterMode	getMode() Obtém o modo de funcionamento (apenas arquivos, apenas diretórios ou ambos) deste parâmetro.
String	getValueAsText() Obtém o valor corrente sob a forma de string.
void	importValue(Map<String,Object> parameterValues) Importa o valor do parâmetro a partir de um mapa "nome->valor".
void	moveDown(int index) Move para cima o elemento do índice
void	moveUp(int index) Move para cima o elemento do índice
boolean	mustExist() Indica se os arquivos selecionados precisam existir.
void	setFileTypes(String[] fileTypes) Atribui um tipo de arquivo específico a este parâmetro.
protected void	setMode(FileParameterMode mode) Atribui o modo de funcionamento (apenas arquivo, apenas diretório ou ambos) deste 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, getItemComparator, getItemValueAsText, mustSort, removeElement, removeElementObj, setElement

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

addSimpleParameterListener, fireValueWasChangedEvent, fireVisiblityWasChangedEvent, getCommandLine, getCommandLinePattern, getDefaultValue, getDescription, getIDLType, getLabel, getParameterValidator, getSimpleParameterListeners, getType, 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

Field Detail

fileTypes

protected String[] fileTypes

Os tipos de arquivo que este parâmetro aceita. Se ele se não se importa com o tipo do arquivo, ele será um array vazio.

Constructor Detail

URLListParameter

public URLListParameter(String name,
                        String label,
                        String description,
                        List<FileURLValue> defaultValue,
                        boolean isOptional,
                        boolean isVisible,
                        String commandLinePattern,
                        String localization,
                        String[] fileTypes,
                        FileParameterMode mode,
                        boolean mustSort,
                        boolean mustExist,
                        EnumSet<URLProtocol> allowedProtocols)

Cria um parâmetro do tipo lista de arquivos.

Parameters:

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

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

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

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

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

localization - define o argumento na linha de comando informando o protoloco usado pelo usuário.

fileTypes - Os tipos dos arquivos aceitos neste parâmetro (Aceita null).

mode - O modo de funcionamento deste parâmetro (Não aceita null).

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

mustExist - Indica se os arquivso devem existir.

allowedProtocols - conjunto de protocolos aceitos na URL.

Method Detail

exportValue

public Map<String,Object> exportValue()

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

Overrides:

exportValue in class SimpleParameter<List<FileURLValue>>

Returns:

O valor do parâmetro como um mapa.

importValue

public void importValue(Map<String,Object> parameterValues)

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

Overrides:

importValue in class SimpleParameter<List<FileURLValue>>

Parameters:

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

getCommandValue

public 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 ListParameter<FileURLValue>

Parameters:

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

Returns:

O valor ou null se o valor for nulo.

getCommandItemValue

public String getCommandItemValue(CommandLineContext context,
                                  FileURLValue url)

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

Overrides:

getCommandItemValue in class ListParameter<FileURLValue>

Parameters:

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

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

Returns:

O valor convertido.

getFileTypes

public String[] getFileTypes()

Obtém os tipos de arquivo que este parâmetro aceita.

Returns:

Os tipos de arquivo ou um array vazio se ele não se importar com um tipo específico.

getMode

public FileParameterMode getMode()

Obtém o modo de funcionamento (apenas arquivos, apenas diretórios ou ambos) deste parâmetro.

Returns:

O modo de funcionamento.

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

Returns:

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

getItemValueFromText

public FileURLValue getItemValueFromText(String elementAsText)
                                  throws ParseException

Decodifica um texto criando um elemento.

Specified by:

getItemValueFromText in class ListParameter<FileURLValue>

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.

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

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.

moveUp

public void moveUp(int index)

Move para cima o elemento do índice

Parameters:

index - índice

moveDown

public void moveDown(int index)

Move para cima o elemento do índice

Parameters:

index - índice

setFileTypes

public void setFileTypes(String[] fileTypes)

Atribui um tipo de arquivo específico a este parâmetro.

Parameters:

fileTypes - Os tipos de arquivo (Aceita null).

setMode

protected void setMode(FileParameterMode mode)

Atribui o modo de funcionamento (apenas arquivo, apenas diretório ou ambos) deste parâmetro.

Parameters:

mode - O modo de funcionamento (Não aceita null).

getExpressionValue

public Object getExpressionValue()

Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).

Overrides:

getExpressionValue in class ListParameter<FileURLValue>

Returns:

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

getLocalization

public String getLocalization()

Define o argumento na linha de comando informando o protoloco usado pelo usuário.

Returns:

localização.

getAllowedProtocols

public EnumSet<URLProtocol> getAllowedProtocols()

Obtém o conjunto de protocolos aceitos na URL.

Returns:

conjunto de protocolos.

getDefaultProtocol

public URLProtocol getDefaultProtocol()

Obtém o protocolo padrão do parâmetro (caso não tenha sido especificado nenhum).

Returns:

protocolo padrão.

createParameterValidator

public URLListParameterValidator createParameterValidator()

Cria o validador do parâmetro.

Overrides:

createParameterValidator in class ListParameter<FileURLValue>

Returns:

O validador.

createItemValidator

protected URLParameterValidator createItemValidator()

Cria o validador dos itens da lista.

Specified by:

createItemValidator in class ListParameter<FileURLValue>

Returns:

O validador.

mustExist

public boolean mustExist()

Indica se os arquivos selecionados precisam existir.

Returns:

mustExist verdadeiro se os arquivos precisam existir, ou falso, caso contrário.