csbase.logic.algorithms.parameters

Class URLParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.AbstractFileParameter

csbase.logic.algorithms.parameters.URLParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<FileURLValue>>

Direct Known Subclasses:

InputURLParameter, OutputURLParameter

public abstract class URLParameter
extends AbstractFileParameter

Classe base para parâmetro do tipo URL.

Author:

Tecgraf

See Also:

Serialized Form

Field Summary

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

fileTypes, hasLink, listeners, mode, mustExist, PATH, TYPE, usesPipe

Constructor Summary

Constructors

Constructor and Description
URLParameter(String name, String label, String description, FileURLValue defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern, String localization, String[] fileTypes, FileParameterMode mode, FileParameterPipeAcceptance usesPipe, boolean mustExist, EnumSet<URLProtocol> allowedProtocols) Construtor.

Method Summary

Modifier and Type	Method and Description
URLParameterValidator	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	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).
String	getLocalization() Define o argumento na linha de comando informando o protoloco usado pelo usuário.
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	setValueAsText(String parameterValue) Atribui o valor corrente sob a forma de string.

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

addParameterListener, getExpressionValue, getFileParameterListeners, getFileTypes, getMode, hasLink, isOuput, mustExist, removeFileParameterListener, setFileTypes, setHasLink, setMode, setUsesPipe, usesPipe

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(String name,
                    String label,
                    String description,
                    FileURLValue defaultValue,
                    boolean isOptional,
                    boolean isVisible,
                    String commandLinePattern,
                    String localization,
                    String[] fileTypes,
                    FileParameterMode mode,
                    FileParameterPipeAcceptance usesPipe,
                    boolean mustExist,
                    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.

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

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

usesPipe - Indica se este parâmetro pode aceitar pipe FileParameterPipeAcceptance.TRUE, não aceita pipe FileParameterPipeAcceptance.FALSE ou *só* aceita pipe FileParameterPipeAcceptance.ALWAYS.

mustExist - indica se o arquivo deve existir.

allowedProtocols - conjunto de protocolos aceitos na URL.

Method Detail

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 URLParameterValidator createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<FileURLValue>

Returns:

O validador.

exportValue

public Map<String,Object> exportValue()

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

Overrides:

exportValue in class SimpleParameter<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<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 SimpleParameter<FileURLValue>

Parameters:

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

Returns:

O valor ou null se o valor for nulo.

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

Returns:

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

setValueAsText

public void setValueAsText(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<FileURLValue>

Parameters:

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