csbase.logic.algorithms.parameters

Class OutputFileListParameter

java.lang.Object

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

csbase.logic.algorithms.parameters.SimpleParameter<List<E>>

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

csbase.logic.algorithms.parameters.FileListParameter

csbase.logic.algorithms.parameters.OutputFileListParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<List<FileURLValue>>>

public class OutputFileListParameter
extends FileListParameter

Parâmetro do tipo lista de arquivo de saída.

Ele possui 3 modos de funcionamento: aceitar apenas arquivos regulares, aceitar apenas diretórios ou aceitar arquivos regulares e diretórios (veja FileParameterMode).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE Texto que representa o tipo desse parâmetro

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

fileTypes, listeners, usesFilter

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

acceptDuplicates, mustSort

Constructor Summary

Constructors

Constructor and Description
OutputFileListParameter(String name, String label, String description, List<FileURLValue> defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern, String[] fileTypes, FileParameterMode mode, boolean mustSort, boolean usesFilter, boolean mustForceExtension) Cria um parâmetro do tipo arquivo.

Method Summary

Modifier and Type	Method and Description
String	getType() Obtém um texto que representa o tipo deste parâmetros.
boolean	mustForceExtension() Indica se deve forçar a extensão do arquivo.
boolean	mustWarnOverwrite() Indica se deve avisar em caso de sobrescrita
boolean	setValue(List<FileURLValue> files) Atribui um valor corrente a este parâmetro.

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

addListener, createItemValidator, createParameterValidator, exportValue, getCommandItemValue, getExpressionValue, getFileTypes, getItemValueFromText, getMode, getValueAsText, importValue, moveDown, moveUp, mustExist, removeListener, setFileTypes, setMode, setUsesFilter, setValueAsText, usesFilter

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

addElement, getCommandValue, getItemComparator, getItemValueAsText, mustSort, removeElement, removeElementObj, setElement

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

addSimpleParameterListener, fireValueWasChangedEvent, fireVisiblityWasChangedEvent, getCommandLine, getCommandLinePattern, getDefaultValue, getDescription, getLabel, getParameterValidator, getSimpleParameterListeners, getValue, ignoreIfDisabled, ignoreIfInvisible, isEnabled, isOptional, isSetDefaultValue, isVisible, removeSimpleParameterListener, resetValue, setDefaultValue, setEnabled, setIgnoreIfDisabled, setIgnoreIfInvisible, setLabel, 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

TYPE

public static final String TYPE

Texto que representa o tipo desse parâmetro

See Also:

Constant Field Values

Constructor Detail

OutputFileListParameter

public OutputFileListParameter(String name,
                               String label,
                               String description,
                               List<FileURLValue> defaultValue,
                               boolean isOptional,
                               boolean isVisible,
                               String commandLinePattern,
                               String[] fileTypes,
                               FileParameterMode mode,
                               boolean mustSort,
                               boolean usesFilter,
                               boolean mustForceExtension)

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 - Os tipos dos arquivos aceitos neste parâmetro (Aceita null).

mode - O modo de funcionamento deste parâmetro (Não aceita null).

mustSort - Indica se os caminhos para os arquivos precisam ser ordenados.

mustForceExtension - Indica se o parâmetro deve forçar o uso da extensão no arquivo (Se ele não tiver, ele colocará a extensão).

usesFilter - Indica se um painel de filtro pode ser usado.

Method Detail

mustWarnOverwrite

public boolean mustWarnOverwrite()

Indica se deve avisar em caso de sobrescrita

Overrides:

mustWarnOverwrite in class FileListParameter

Returns:

verdadeiro

getType

public String getType()

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

Specified by:

getType in class SimpleParameter<List<FileURLValue>>

Returns:

O tipo.

mustForceExtension

public boolean mustForceExtension()

Indica se deve forçar a extensão do arquivo.

Returns:

.

setValue

public boolean setValue(List<FileURLValue> files)

Atribui um valor corrente a este parâmetro.

Se o valor corrente for modificado, ele irá gerar o evento SimpleParameterListener.valueWasChanged(SimpleParameter).

Overrides:

setValue in class SimpleParameter<List<FileURLValue>>

Parameters:

files - O valor (Aceita null).

Returns:

true se ele for modificado ou false se o valor corrente for igual ao valor fornecido.