csbase.logic.algorithms.parameters

Class AbstractFileParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.AbstractFileParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<FileURLValue>>

Direct Known Subclasses:

FileParameter, URLParameter

public abstract class AbstractFileParameter
extends SimpleParameter<FileURLValue>

Parâmetro que representa um arquivo e pode ter representação de pipe

Author:

Tecgraf/PUC-Rio

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	fileTypes O tipo de arquivo que este parâmetro filtra.
protected boolean	hasLink Indica se este parâmetro está (true) ou não (false) está participando de uma conexão entre nós de um fluxo de algoritmos.
protected List<FileParameterListener>	listeners Associação com os observador do parâmetro do tipo arquivo.
protected FileParameterMode	mode O modo de funcionamento atual (apenas arquivos, apenas diretórios ou ambos).
protected boolean	mustExist Indica se o arquivo deve existir.
static String	PATH Chave utilizada para informar o caminho do arquivo no mapa de parâmetros dos métodos de importação (SimpleParameter.importValue(Map)) e exportação (SimpleParameter.exportValue()).
static String	TYPE Chave utilizada para informar o tipo do arquivo no mapa de parâmetros dos métodos de importação (SimpleParameter.importValue(Map)) e exportação (SimpleParameter.exportValue()).
protected FileParameterPipeAcceptance	usesPipe Indica se este parâmetro pode aceitar pipe FileParameterPipeAcceptance.TRUE, não aceita pipe FileParameterPipeAcceptance.FALSE ou *só* aceita pipe FileParameterPipeAcceptance.ALWAYS.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameterListener(FileParameterListener listener) Adiciona um observador de parâmetros do tipo arquivo a este parâmetro.
Object	getExpressionValue() Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).
List<FileParameterListener>	getFileParameterListeners() Obtém a lista de observadores deste parâmetro.
String[]	getFileTypes() 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.
boolean	hasLink() Indica se este parâmetro participa de uma conexão entre nós de um fluxo de algoritmos.
abstract boolean	isOuput()
boolean	mustExist() Indica se o arquivo selecionado precisa existir.
boolean	removeFileParameterListener(FileParameterListener listener) Remove um observador deste parâmetro.
void	setFileTypes(String[] fileTypes) Atribui os tipos de arquivo associados 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.
protected void	setMode(FileParameterMode mode) Atribui o modo de funcionamento (apenas arquivo, apenas diretório ou ambos) deste parâmetro.
protected void	setUsesPipe(FileParameterPipeAcceptance usesPipe) Determina se este arquivo pode utilizar pipes.
FileParameterPipeAcceptance	usesPipe() Indica se este arquivo pode utilizar pipes.

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

addSimpleParameterListener, createParameterValidator, exportValue, fireValueWasChangedEvent, fireVisiblityWasChangedEvent, getCommandLine, getCommandLinePattern, getCommandValue, getDefaultValue, getDescription, getIDLType, getLabel, getParameterValidator, getSimpleParameterListeners, getType, getValue, getValueAsText, ignoreIfDisabled, ignoreIfInvisible, importValue, isEnabled, isOptional, isSetDefaultValue, isVisible, removeSimpleParameterListener, resetValue, setDefaultValue, setEnabled, setIgnoreIfDisabled, setIgnoreIfInvisible, setLabel, setValue, setValueAsText, 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 String PATH

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

See Also:

Constant Field Values

TYPE

public static final String TYPE

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

See Also:

Constant Field Values

usesPipe

protected FileParameterPipeAcceptance usesPipe

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

fileTypes

protected String[] fileTypes

O tipo de arquivo que este parâmetro filtra. Se ele se importa com o tipo do arquivo, ele valerá null.

hasLink

protected boolean hasLink

Indica se este parâmetro está (true) ou não (false) está participando de uma conexão entre nós de um fluxo de algoritmos.

listeners

protected transient List<FileParameterListener> listeners

Associação com os observador do parâmetro do tipo arquivo.

mode

protected FileParameterMode mode

O modo de funcionamento atual (apenas arquivos, apenas diretórios ou ambos).

mustExist

protected final boolean mustExist

Indica se o arquivo deve existir.

Constructor Detail

AbstractFileParameter

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

mustExist - Indica se o arquivo deve existir.

Method Detail

usesPipe

public final FileParameterPipeAcceptance usesPipe()

Indica se este arquivo pode utilizar pipes.

Returns:

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

addParameterListener

public final void addParameterListener(FileParameterListener listener)

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

Parameters:

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

getExpressionValue

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

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

getFileTypes

public final String[] getFileTypes()

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.

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.

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.

setFileTypes

public final void setFileTypes(String[] fileTypes)

Atribui os tipos de arquivo associados a este parâmetro.

Parameters:

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

setMode

protected void setMode(FileParameterMode mode)

Atribui o modo de funcionamento (apenas arquivo, apenas diretório ou ambos) deste parâmetro.

Parameters:

mode - O modo de funcionamento (Não aceita null).

setUsesPipe

protected void setUsesPipe(FileParameterPipeAcceptance usesPipe)

Determina se este arquivo pode utilizar pipes.

Parameters:

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

mustExist

public boolean mustExist()

Indica se o arquivo selecionado precisa existir.

Returns:

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

isOuput

public abstract boolean isOuput()

Returns:

Indica se este parâmetro é de output