csbase.logic.algorithms.parameters

Class ClientSGAFileParameter

java.lang.Object

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

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

csbase.logic.algorithms.parameters.ClientSGAFileParameter

All Implemented Interfaces:

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

public class ClientSGAFileParameter
extends SimpleParameter<ClientSGAFile>

Parâmetro que encapsula paths de arquivos que estão na máquina em que o SGA está instalado.

Author:

Tecgraf

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientSGAFileParameter(java.lang.String name, java.lang.String label, java.lang.String description, ClientSGAFile defaultValue, boolean isOptional, boolean isVisible, java.lang.String commandLinePattern) Construtor padrão.

Method Summary

Modifier and Type	Method and Description
SimpleParameterValidator<ClientSGAFile>	createParameterValidator() Cria o validador do parâmetro.
protected 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.lang.String	getIDLType() Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.
java.lang.String	getType() Obtém um texto que representa o tipo deste parâmetros.
java.util.List<java.lang.String>	getTypes() Retorna os tipos de arquivos permitidos.
boolean	isInputMode() Define se o usuário escolhe arquivo(s) de entrada.
boolean	isMultipleSelection() Define se o usuário puder escolher multiplos arquivos.
boolean	isShowFiles() Define se o usuário escolhe apenas arquivos.
void	setInputMode(boolean isInputMode) Define se o usuário escolhe arquivo(s) de entrada.
void	setMultipleSelection(boolean isMultipleSelection) Define se o usuário puder escolher multiplos arquivos.
void	setShowFiles(boolean showFiles) Define se o usuário escolhe apenas arquivos.
void	setTypes(java.util.List<java.lang.String> types) Tipos de arquivos usados no filtro do chooser.
void	setValueAsText(java.lang.String parameterValue) Atribui o valor corrente sob a forma de string.

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

addSimpleParameterListener, exportValue, fireValueWasChangedEvent, fireVisiblityWasChangedEvent, getCommandLine, getCommandLinePattern, getDefaultValue, getDescription, getLabel, getParameterValidator, getSimpleParameterListeners, getValue, getValueAsText, ignoreIfDisabled, ignoreIfInvisible, importValue, 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

ClientSGAFileParameter

public ClientSGAFileParameter(java.lang.String name,
                              java.lang.String label,
                              java.lang.String description,
                              ClientSGAFile defaultValue,
                              boolean isOptional,
                              boolean isVisible,
                              java.lang.String commandLinePattern)

Construtor padrão.

Parameters:

name - - nome do parâmetro.

label - - rótulo do parâmetro.

description - - a descrição do parâmetro.

defaultValue - - valor default.

isOptional - - flag que define se é opcional.

isVisible - - flag que define se o parâmetro é 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.

Method Detail

createParameterValidator

public SimpleParameterValidator<ClientSGAFile> createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<ClientSGAFile>

Returns:

O validador.

getExpressionValue

public 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<ClientSGAFile>

Returns:

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

getType

public java.lang.String getType()

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

Specified by:

getType in class SimpleParameter<ClientSGAFile>

Returns:

O tipo.

getIDLType

public java.lang.String getIDLType()

Obtém o identificador do tipo IDL do parâmetro se ele possuium uma interface IDL.

Overrides:

getIDLType in class SimpleParameter<ClientSGAFile>

Returns:

O identificador do tipo IDL ou null se não possuir interface IDL.

setValueAsText

public void setValueAsText(java.lang.String parameterValue)
                    throws ParseException

Atribui o valor corrente sob a forma de string.

Se método é completar ao método SimpleParameter.getValueAsText().

Specified by:

setValueAsText in class SimpleParameter<ClientSGAFile>

Parameters:

parameterValue - O valor corrente sob a forma de string (Aceita null).

Throws:

ParseException - Se o valor passado não estiver em um formato aceito por este parâmetro.

getCommandValue

protected 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<ClientSGAFile>

Parameters:

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

Returns:

O valor ou null se o valor for nulo.

setMultipleSelection

public void setMultipleSelection(boolean isMultipleSelection)

Define se o usuário puder escolher multiplos arquivos.

Parameters:

isMultipleSelection - - true se o usuário puder escolher multiplos arquivos; false caso contrário.

isMultipleSelection

public boolean isMultipleSelection()

Define se o usuário puder escolher multiplos arquivos.

Returns:

true se o usuário puder escolher multiplos arquivos; false caso contrário.

setShowFiles

public void setShowFiles(boolean showFiles)

Define se o usuário escolhe apenas arquivos.

Parameters:

showFiles - - true se o usuário escolhe apenas arquivos; false define o caso em que o usuário escolhe apenas diretórios.

isShowFiles

public boolean isShowFiles()

Define se o usuário escolhe apenas arquivos.

Returns:

true se o usuário escolhe apenas arquivos; false define o caso em que o usuário escolhe apenas diretórios.

setInputMode

public void setInputMode(boolean isInputMode)

Define se o usuário escolhe arquivo(s) de entrada.

Parameters:

isInputMode - - true se o usuário escolhe arquivo(s) de entrada; false define que o usuário escolhe um arquivo de saida.

isInputMode

public boolean isInputMode()

Define se o usuário escolhe arquivo(s) de entrada.

Returns:

true se o usuário escolhe arquivo(s) de entrada; false define que o usuário escolhe um arquivo de saida.

getTypes

public java.util.List<java.lang.String> getTypes()

Retorna os tipos de arquivos permitidos.

Returns:

tipos de arquivos permitidos.

setTypes

public void setTypes(java.util.List<java.lang.String> types)

Tipos de arquivos usados no filtro do chooser.

Parameters:

types - - tipos de arquivos usados no filtro do chooser.