csbase.logic.algorithms.parameters

Class FileParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.AbstractFileParameter

csbase.logic.algorithms.parameters.FileParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<FileURLValue>>

Direct Known Subclasses:

InputFileParameter, OutputFileParameter

public abstract class FileParameter
extends AbstractFileParameter

Parâmetro do tipo arquivo.

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

Modifier	Constructor and Description
protected	FileParameter(String name, String label, String description, FileURLValue defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern, String[] fileTypes, FileParameterMode mode, FileParameterPipeAcceptance usesPipe, boolean usesFilter, boolean mustExist) Cria um parâmetro do tipo arquivo.

Method Summary

Methods

Modifier and Type	Method and Description
FileParameterValidator	createParameterValidator() Cria o validador do parâmetro.
Map<String,Object>	exportValue() Exporta o valor do parâmetro como um mapa "nome->valor".
String	getCommandValue(CommandLineContext context) Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.
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	setUsesFilter(boolean usesFilter) Determina se um painel de filtro pode ser usado.
void	setValueAsText(String parameterValue) Atribui o valor corrente sob a forma de string.
boolean	usesFilter() Indica se um painel de filtro deve ser exibido.

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

FileParameter

protected FileParameter(String name,
             String label,
             String description,
             FileURLValue defaultValue,
             boolean isOptional,
             boolean isVisible,
             String commandLinePattern,
             String[] fileTypes,
             FileParameterMode mode,
             FileParameterPipeAcceptance usesPipe,
             boolean usesFilter,
             boolean mustExist)

Cria um parâmetro do tipo arquivo.

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.

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

mode - O modo de funcionamento deste 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.

usesFilter - Indica se o painel de filtro deve ser exibido.

mustExist - Indica se o arquivo deve existir.

Method Detail

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.

getCommandValue

public final 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 final 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.

usesFilter

public boolean usesFilter()

Indica se um painel de filtro deve ser exibido. (true), se sim, ( false), caso contrário.

Returns:

true se exibir ou false caso contrário.

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.

setValueAsText

public final 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).

setUsesFilter

public void setUsesFilter(boolean usesFilter)

Determina se um painel de filtro pode ser usado.

Parameters:

usesFilter - True, se o parâmetro pode exibir um painel de filtro ou false, caso contrário.

createParameterValidator

public FileParameterValidator createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<FileURLValue>

Returns:

O validador.