csbase.logic.algorithms.parameters

Class FileParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.FileParameter

All Implemented Interfaces:

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

Direct Known Subclasses:

InputFileParameter, OutputFileParameter

public abstract class FileParameter
extends SimpleParameter<FileParameterValue>

Parâmetro do tipo arquivo.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PATH Chave utilizada para informar o caminho do arquivo no mapa de parâmetros dos métodos de importação (importValue(Map)) e exportação (exportValue()).
static java.lang.String	TYPE Chave utilizada para informar o tipo do arquivo no mapa de parâmetros dos métodos de importação (importValue(Map)) e exportação (exportValue()).

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addFileParameterListener(FileParameterListener listener) Adiciona um observador de parâmetros do tipo arquivo a este parâmetro.
FileParameterValidator	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.lang.String	getCommandValue(CommandLineContext context) Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.
java.lang.Object	getExpressionValue() Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).
java.util.List<FileParameterListener>	getFileParameterListeners() Obtém a lista de observadores deste parâmetro.
java.lang.String	getFileType() Obtém o tipo de arquivo que este parâmetro aceita.
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.
boolean	hasLink() Indica se este parâmetro participa de uma conexão entre nós de um fluxo de algoritmos.
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.
boolean	removeFileParameterListener(FileParameterListener listener) Remove um observador deste parâmetro.
void	setFileType(java.lang.String fileType) Atribui um tipo de arquivo específico a este parâmetro.
void	setHasLink(boolean hasLink) Marca se este arquivo está ou não participando de uma conexão entre nós de algoritmos em um fluxo de algoritmos.
void	setUsesFilter(boolean usesFilter) Determina se um painel de filtro pode ser usado.
void	setValueAsText(java.lang.String parameterValue) Atribui o valor corrente sob a forma de string.
boolean	usesFilter() Indica se um painel de filtro deve ser exibido.
FileParameterPipeAcceptance	usesPipe() Indica se este arquivo pode utilizar pipes.

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

PATH

public static final java.lang.String PATH

Chave utilizada para informar o caminho do arquivo no mapa de parâmetros dos métodos de importação (importValue(Map)) e exportação (exportValue()).

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

Chave utilizada para informar o tipo do arquivo no mapa de parâmetros dos métodos de importação (importValue(Map)) e exportação (exportValue()).

See Also:

Constant Field Values

Constructor Detail

FileParameter

protected FileParameter(java.lang.String name,
             java.lang.String label,
             java.lang.String description,
             FileParameterValue defaultValue,
             boolean isOptional,
             boolean isVisible,
             java.lang.String commandLinePattern,
             java.lang.String fileType,
             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.

fileType - 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 , não aceita pipe ou *só* aceita pipe .

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

mustExist - Indica se o arquivo deve existir.

Method Detail

addFileParameterListener

public final void addFileParameterListener(FileParameterListener listener)

Adiciona um observador de parâmetros do tipo arquivo a este parâmetro.

Parameters:

listener - O observador (Não aceita null).

usesPipe

public final FileParameterPipeAcceptance usesPipe()

Indica se este arquivo pode utilizar pipes.

Returns:

se este parâmetro pode aceitar pipe, se não aceita pipe, ou se *só* aceita pipe.

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

Returns:

O valor do parâmetro como um mapa.

getCommandValue

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

Parameters:

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

Returns:

O valor ou null se o valor for nulo.

getExpressionValue

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

Returns:

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

getFileParameterListeners

public final java.util.List<FileParameterListener> getFileParameterListeners()

Obtém a lista de observadores deste parâmetro.

A lista retornada é imutável (veja Collections.unmodifiableList(List)).

Se não houver observadores a lista retornada estará vazia.

Returns:

A lista de observadores.

getFileType

public final java.lang.String getFileType()

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

Returns:

O tipo de arquivo ou null se ele não se importar com um tipo específico.

getMode

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

Returns:

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

hasLink

public final boolean hasLink()

Indica se este parâmetro participa de uma conexão entre nós de um fluxo de algoritmos.

Returns:

true se participar ou false caso contrário.

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(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<FileParameterValue>

Parameters:

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

removeFileParameterListener

public final boolean removeFileParameterListener(FileParameterListener listener)

Remove um observador deste parâmetro.

Parameters:

listener - O observador (Não aceita null).

Returns:

true se ele removeu o observador ou false se o observador não estiver neste parâmetro.

setFileType

public final void setFileType(java.lang.String fileType)

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

Parameters:

fileType - O tipo de arquivo (Aceita null).

setHasLink

public final void setHasLink(boolean hasLink)

Marca se este arquivo está ou não participando de uma conexão entre nós de algoritmos em um fluxo de algoritmos.

Parameters:

hasLink - true se estiver ou false caso contrário.

setValueAsText

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

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

Returns:

O validador.

mustExist

public boolean mustExist()

Indica se o arquivo selecionado precisa existir.

Returns:

mustExist verdadeiro se o arquivo precisa existir, ou falso, caso contrário.