csbase.logic.algorithms.parameters

Class URLParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.URLParameter

All Implemented Interfaces:

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

Direct Known Subclasses:

InputURLParameter, OutputURLParameter

public abstract class URLParameter
extends SimpleParameter<URLValue>

Classe base para parâmetro do tipo URL.

Author:

Tecgraf

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
URLParameter(java.lang.String name, java.lang.String label, java.lang.String description, URLValue defaultValue, boolean isOptional, boolean isVisible, java.lang.String commandLinePattern, java.lang.String localization, java.lang.String fileType, FileParameterMode mode, boolean mustExist, java.util.EnumSet<URLProtocol> allowedProtocols) Construtor.

Method Summary

Methods

Modifier and Type	Method and Description
URLParameterValidator	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".
java.util.EnumSet<URLProtocol>	getAllowedProtocols() Obtém o conjunto de protocolos aceitos na URL.
java.lang.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).
java.lang.Object	getExpressionValue() Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).
java.lang.String	getFileType() Obtém o tipo de arquivo que este parâmetro aceita.
java.lang.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.
java.lang.String	getValueAsText() Obtém o valor corrente sob a forma de string.
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".
boolean	mustExist() Indica se o arquivo selecionado precisa existir.
void	setFileType(java.lang.String fileType) Atribui um tipo de arquivo específico a este parâmetro.
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, 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

Constructor Detail

URLParameter

public URLParameter(java.lang.String name,
            java.lang.String label,
            java.lang.String description,
            URLValue defaultValue,
            boolean isOptional,
            boolean isVisible,
            java.lang.String commandLinePattern,
            java.lang.String localization,
            java.lang.String fileType,
            FileParameterMode mode,
            boolean mustExist,
            java.util.EnumSet<URLProtocol> allowedProtocols)

Construtor.

Parameters:

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

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

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

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

fileType - tipo dos arquivos aceitos neste parâmetro (Aceita null).

mode - modo do parâmetro (Não aceita null).

mustExist - indica se o arquivo deve existir.

allowedProtocols - conjunto de protocolos aceitos na URL.

Method Detail

getLocalization

public java.lang.String getLocalization()

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

Returns:

localização.

getFileType

public java.lang.String getFileType()

Obtém o tipo de arquivo que este parâmetro aceita.

Returns:

tipo de arquivo ou null 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:

modo de funcionamento.

setFileType

public void setFileType(java.lang.String fileType)

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

Parameters:

fileType - tipo de arquivo (Aceita null).

mustExist

public boolean mustExist()

Indica se o arquivo selecionado precisa existir.

Returns:

mustExist true se o arquivo precisa existir, false caso contrário.

getAllowedProtocols

public java.util.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.

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

Returns:

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

createParameterValidator

public URLParameterValidator createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<URLValue>

Returns:

O validador.

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

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

Parameters:

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

getCommandValue

public 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<URLValue>

Parameters:

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

Returns:

O valor ou null se o valor for nulo.

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

Returns:

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

setValueAsText

public void setValueAsText(java.lang.String parameterValue)

Atribui o valor corrente sob a forma de string.

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

Specified by:

setValueAsText in class SimpleParameter<URLValue>

Parameters:

parameterValue - O valor corrente sob a forma de string (Aceita null).