csbase.logic.algorithms.parameters

Class OutputURLParameter

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

csbase.logic.algorithms.parameters.OutputURLParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<FileURLValue>>

public class OutputURLParameter
extends URLParameter

Parâmetro que define uma URL de saída.

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

Method Summary

Modifier and Type	Method and Description
String	getType() Obtém um texto que representa o tipo deste parâmetros.
boolean	isOuput()

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

createParameterValidator, exportValue, getAllowedProtocols, getCommandValue, getDefaultProtocol, getLocalization, getValueAsText, importValue, setValueAsText

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

addParameterListener, getExpressionValue, getFileParameterListeners, getFileTypes, getMode, hasLink, 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, 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

OutputURLParameter

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

allowedProtocols - conjunto de protocolos aceitos na URL.

Method Detail

getType

public String getType()

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

Specified by:

getType in class SimpleParameter<FileURLValue>

Returns:

O tipo.

isOuput

public boolean isOuput()

Specified by:

isOuput in class AbstractFileParameter

Returns:

Indica se este parâmetro é de output