csbase.logic.algorithms.parameters

Class OutputFileParameter

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

csbase.logic.algorithms.parameters.OutputFileParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<FileURLValue>>

public final class OutputFileParameter
extends FileParameter

A classe OutputFileParameter representa um parâmetro que é um arquivo de saída.

Author:

lmoreira

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_FILE_PARAMETER_NAME O nome do parâmetro arquivo de log.
static String	TYPE Texto que representa o tipo desse parâmetro

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

fileTypes, hasLink, listeners, mode, mustExist, PATH, usesPipe

Constructor Summary

Constructors

Constructor and Description
OutputFileParameter(String name, String label, String description, FileURLValue defaultValue, boolean isOptional, boolean isVisible, String commandLinePattern, String[] fileTypes, FileParameterMode mode, FileParameterPipeAcceptance usesPipe, boolean mustForceExtension, boolean usesFilter, boolean allowMultipleOutput) Cria um parâmetro do tipo Arquivo de Saída.

Method Summary

Modifier and Type	Method and Description
boolean	allowMultipleOutput() Retorna se o algoritmo permite saídas múltiplas
static OutputFileParameter	createLogFile(String commandLinePattern) Cria um parâmetro que é um arquivo de log.
String	getType() (non-Javadoc)
boolean	isLogFile() Indica se este parâmetro é um parâmetro do tipo arquivo de log.
boolean	isOuput()
boolean	mustForceExtension() Indica se deve forçar a extensão do arquivo.
boolean	mustWarnOverwrite() Indica se deve avisar em caso de sobrescrita
boolean	setValue(FileURLValue file) Atribui um valor corrente a este parâmetro.

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

createParameterValidator, exportValue, getCommandValue, getValueAsText, importValue, setUsesFilter, setValueAsText, usesFilter

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

LOG_FILE_PARAMETER_NAME

public static final String LOG_FILE_PARAMETER_NAME

O nome do parâmetro arquivo de log.

See Also:

Constant Field Values

Constructor Detail

OutputFileParameter

public OutputFileParameter(String name,
                           String label,
                           String description,
                           FileURLValue defaultValue,
                           boolean isOptional,
                           boolean isVisible,
                           String commandLinePattern,
                           String[] fileTypes,
                           FileParameterMode mode,
                           FileParameterPipeAcceptance usesPipe,
                           boolean mustForceExtension,
                           boolean usesFilter,
                           boolean allowMultipleOutput)

Cria um parâmetro do tipo Arquivo de Saída.

Parameters:

name - O nome do parâmetro (Não aceita null).

label - O rótulo do parâmetro (Não aceita null).

description - A descrição do parâmetro (Não aceita null).

defaultValue - O valor-padrão (Aceita null).

isOptional - Indica se é 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 de arquivo que este parâmetro filtra. Se ele se importa com o tipo do arquivo, ele valerá null.

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

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

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 filtro para filtro deve ser exibido.

allowMultipleOutput - Indica se o algoritmo permite saídas múltiplas.

Method Detail

mustWarnOverwrite

public boolean mustWarnOverwrite()

Indica se deve avisar em caso de sobrescrita

Overrides:

mustWarnOverwrite in class FileParameter

Returns:

truen

createLogFile

public static OutputFileParameter createLogFile(String commandLinePattern)

Cria um parâmetro que é um arquivo de log.

Parameters:

commandLinePattern - o padrão da linha de comando.

Returns:

um parâmetro que é um arquivo de log.

getType

public String getType()

(non-Javadoc)

Specified by:

getType in class SimpleParameter<FileURLValue>

Returns:

O tipo.

See Also:

SimpleParameter.getType()

mustForceExtension

public boolean mustForceExtension()

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

Returns:

.

isLogFile

public boolean isLogFile()

Indica se este parâmetro é um parâmetro do tipo arquivo de log.

Returns:

.

setValue

public boolean setValue(FileURLValue file)

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

Parameters:

file - O valor (Aceita null).

Returns:

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

isOuput

public boolean isOuput()

Specified by:

isOuput in class AbstractFileParameter

Returns:

Indica se este parâmetro é de output

allowMultipleOutput

public boolean allowMultipleOutput()

Retorna se o algoritmo permite saídas múltiplas

Returns:

Indicativo.