SimpleAlgorithmConfigurator (csbase-common 3.4.1-RC5 API)

java.lang.Object
- csbase.logic.algorithms.AlgorithmConfigurator
- - csbase.logic.algorithms.parameters.SimpleAlgorithmConfigurator

All Implemented Interfaces:

Serializable
```
public final class SimpleAlgorithmConfigurator
extends AlgorithmConfigurator
```
Configurador de algoritmos simples.

Author:

lmoreira

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class csbase.logic.algorithms.AlgorithmConfigurator
  AlgorithmConfigurator.ConfiguratorType

Field Summary
- Fields inherited from class csbase.logic.algorithms.AlgorithmConfigurator
  FILE_LIST_SEPARATOR

Constructor Summary

Constructors
Constructor and Description
`SimpleAlgorithmConfigurator(AlgorithmVersionInfo algorithmVersion, String description, ExecutionType executionType, ExecutionLocation executionLocation, String abbreviation, boolean provideId, String command, String shell, String defaultInputFileParameterName, boolean showOutput, String commandLinePattern)` Cria um configurador de algoritmos simples.
`SimpleAlgorithmConfigurator(AlgorithmVersionInfo algorithmVersion, String description, ExecutionType executionType, ExecutionLocation executionLocation, String abbreviation, boolean provideId, String command, String shell, String defaultInputFileParameterName, boolean showOutput, String commandLinePattern, boolean loadParameters)` Cria um configurador de algoritmos simples.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addExpression(ValidationExpression expression)` Adiciona uma expressão de validação a este configurador.
`boolean`	`addGroup(ParameterGroup group)` Adiciona um grupo a este configurador.
`boolean`	`addHiddenParameter(HiddenParameter hiddenParameter)` Adiciona um parâmetro oculto a este configurador.
`boolean`	`addTrigger(Trigger<?> trigger)` Adiciona um gatilho a este configurador.
`Boolean`	`allowParametersLoad()` Indica se o algoritmo suporta carga e armazenamento de valores de parâmetros em arquivos de projeto.
`Map<Object,Object>`	`exportValues()` Exporta os valores dos parâmetros para um `Map` que contém apenas objetos que são tipos envelopes para tipos primitivos ou coleções padrão do API do Java.
`Set<String>`	`getBinaryDirectories(String platformId, char fileSeparator)` Obtém uma relação de caminhos para os diretórios dos binários deste algoritmo para um determinado `SGAInfo`.
`Set<String[]>`	`getBinaryDirectoriesAsArray(String platformId)` Obtém uma relação de caminhos em forma de array para os diretórios dos binários deste algoritmo para um determinado `SGAInfo`.
`String`	`getCommandBinaryName()` Obtém o nome do executável.
`protected String`	`getCurrentParameterFileVersion()` Obtém a versão atual do arquivo de parâmetros.
`String`	`getDefaultInputFileParameterName()` Obtém o nome do arquivo de entrada padrão.
`Set<ValidationExpression>`	`getExpressions()` Obtém o conjunto de expressões de validação associadas a este configurador.
`List<ParameterGroup>`	`getGroups()` Obtém a lista de grupos associadas a este configurador.
`Set<HiddenParameter>`	`getHiddenParameters()` Obtém o conjunto de parâmetros ocultos associados a este configurador.
`Set<FileURLValue>`	`getInputDirectories()` Obtém o conjunto de diretórios de entrada.
`List<InputFileListParameter>`	`getInputFileListParameters()` Obtém a lista com os parâmetros que aceitam um conjunto de arquivos e/ou diretórios para entrada de dados.
`List<InputFileParameter>`	`getInputFileParameters()` Obtém a lista com os parâmetros que aceitam arquivos e/ou diretórios para entrada de dados.
`Set<FileURLValue>`	`getInputFiles()` Obtém o conjunto de arquivos de entrada.
`List<InputURLListParameter>`	`getInputURLListParameters()` Obtém a lista com os parâmetros que aceitam um conjunto de arquivos e/ou diretórios (URLs) para entrada de dados.
`List<InputURLParameter>`	`getInputURLParameters()` Obtém a lista com os parâmetros do tipo URL que aceitam arquivos e/ou diretórios para entrada de dados.
`Set<FileURLValue>`	`getInputURLs()` Obtém o conjunto de arquivos (URLs) de entrada.
`Set<FileURLValue>`	`getOutputDirectories()` Obtém o conjunto de diretórios de saída.
`List<OutputFileListParameter>`	`getOutputFileListParameters()` Obtém a lista com os parâmetros que aceitam um conjunto de arquivos e/ou diretórios para saída de dados.
`List<OutputFileParameter>`	`getOutputFileParameters()` Obtém a lista com os parâmetros que aceitam arquivos e/ou diretórios para saída de dados.
`Set<FileURLValue>`	`getOutputFiles()` Obtém o conjunto de arquivos de saída.
`List<OutputURLListParameter>`	`getOutputURLListParameters()` Obtém a lista com os parâmetros que aceitam um conjunto de arquivos e/ou diretórios (URLs) para saída de dados.
`List<OutputURLParameter>`	`getOutputURLParameters()` Obtém a lista com os parâmetros que aceitam arquivos e/ou diretórios (URLs) para saída de dados.
`Set<FileURLValue>`	`getOutputURLs()` Obtém o conjunto de arquivos (URLs) de saída.
`String`	`getParameterLabel(String parameterName)` Obtém o rótulo de um parâmetro dado o seu nome.
`Set<String>`	`getParameterNames()` Obtém a relação de nomes dos parâmetros.
`String`	`getParameterType(String parameterName)` Obtém o tipo de um parâmetro dado o seu nome.
`String`	`getParameterValue(String parameterName)` Obtém o valor de um parâmetro dado o seu nome.
`Set<String>`	`getPlatforms()` Obtém uma relação de todas as plataformas suportadas por este configurador de algoritmos.
`String`	`getShell()` Obtém o shell que irá executar o comando deste configurador.
`SimpleParameter<?>`	`getSimpleParameter(String parameterName)` Obtém um parâmetro simples dado o seu nome.
`List<SimpleParameter<?>>`	`getSimpleParameters()` Obtém a lista de todos parâmetros simples associados a este configurador de algoritmos.
`Set<Trigger<?>>`	`getTriggers()` Obtém o conjunto de gatilhos associados a este configurador.
`void`	`importValues(Map<Object,Object> parameterValues)` Importa os valores dos parâmetros de um `Map`.
`boolean`	`isEnabled()` Indica se o configurador está habilitado.
`boolean`	`isSetDefaultValues()` Verifica se os valores deste configurador são iguais aos valores-padrão.
`String`	`makeCommandLine(CommandLineContext context)` Cria a linha de comando.
`protected String`	`makeEnvironmentVariablesDeclaration(CommandLineContext context)` Cria a parte da linha de comando que declara as variáveis de ambiente utilizadas e disponibilizadas pelo comando.
`void`	`resetValues()` Restaura os valores dos parâmetros para os valores-padrão.
`boolean`	`setDefaultInputFile(FileURLValue inputFile)` Atribui um arquivo para ser utilizado com o arquivo de entrada padrão do configurador.
`boolean`	`setEnabled(boolean isEnabled)` Modifica o estado habilitado/desabilitado do configurador de algoritmos.
`void`	`setParameterValue(String parameterName, String parameterValue)` Atribui o valor a um parâmetro.
`void`	`updateTriggers()` Atualiza os gatilhos cujas condições sejam aceitas.
`Validation`	`validate(ValidationContext context)` Verifica se os valores armazenados no parâmetro são válidos.

Methods inherited from class csbase.logic.algorithms.AlgorithmConfigurator
addAlgorithmConfiguratorListener, equals, fireParameterLabelWasChanged, fireParameterValueWasChanged, fireParameterWasSetEnabled, fireParameterWasSetVisible, fireWasSetEnabled, getAbbreviation, getAlgorithmId, getAlgorithmName, getAlgorithmVersion, getAlgorithmVersionId, getCommandDescription, getCommandLinePattern, getConfiguratorType, getCpuAmount, getDescription, getExecutionLocation, getExecutionType, getExitCodeCaptureCommand, getExitCodeLogFile, getExitCodeLogFiles, getFileParameters, getFilePath, getLogFile, getLogFileParameter, getLogFiles, getMemoryAmount, getParameterValuesByName, getRequirements, getStandardOutputFile, getStandardOutputFiles, getWarningsFile, getWarningsFiles, hasExitCode, hashCode, hasParameterThatRequiresPipe, isMultipleExecution, isSimpleExecution, makeCommandLineAsScript, provideId, setCommandDescription, setExecutionLocation, setExecutionType, setExitCodeLogFile, setHasExitCode, setLogFileParameterVisible, setParameterValuesByName, setStandardOutputFile, setWarningsFile, toString, updateAlgorithmVersion

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SimpleAlgorithmConfigurator
```
public SimpleAlgorithmConfigurator(AlgorithmVersionInfo algorithmVersion,
                                   String description,
                                   ExecutionType executionType,
                                   ExecutionLocation executionLocation,
                                   String abbreviation,
                                   boolean provideId,
                                   String command,
                                   String shell,
                                   String defaultInputFileParameterName,
                                   boolean showOutput,
                                   String commandLinePattern)
```
    Cria um configurador de algoritmos simples.
    
    Parameters:
    
    algorithmVersion - A versão do algoritmo (Não aceita null).
    
    description - A descrição (Aceita null).
    
    executionType - O tipo de execução (Não aceita null).
    
    executionLocation - O local de execução do comando.
    
    abbreviation - A abreviatura (Aceita null).
    
    provideId - Sinal que indica se é necessário fornecer o identificador do comando na linha de comando.
    
    command - O nome do executável (Não aceita null).
    
    shell - O shell que irá executar o comando (Aceita null).
    
    defaultInputFileParameterName - O arquivo de entrada padrão (Aceita null).
    
    showOutput - Um flag que indica se as saídas padrão e de erro devem ser exibidas.
    
    commandLinePattern - pattern de linha de comando.
  - SimpleAlgorithmConfigurator
```
public SimpleAlgorithmConfigurator(AlgorithmVersionInfo algorithmVersion,
                                   String description,
                                   ExecutionType executionType,
                                   ExecutionLocation executionLocation,
                                   String abbreviation,
                                   boolean provideId,
                                   String command,
                                   String shell,
                                   String defaultInputFileParameterName,
                                   boolean showOutput,
                                   String commandLinePattern,
                                   boolean loadParameters)
```
    Cria um configurador de algoritmos simples.
    
    Parameters:
    
    algorithmVersion - A versão do algoritmo (Não aceita null).
    
    description - A descrição (Aceita null).
    
    executionType - O tipo de execução (Não aceita null).
    
    executionLocation - O local de execução do comando.
    
    abbreviation - A abreviatura (Aceita null).
    
    provideId - Sinal que indica se é necessário fornecer o identificador do comando na linha de comando.
    
    command - O nome do executável (Não aceita null).
    
    shell - O shell que irá executar o comando (Aceita null).
    
    defaultInputFileParameterName - O arquivo de entrada padrão (Aceita null).
    
    showOutput - Um flag que indica se as saídas padrão e de erro devem ser exibidas.
    
    commandLinePattern - pattern de linha de comando.
- Method Detail
  - addExpression
```
public boolean addExpression(ValidationExpression expression)
```
    Adiciona uma expressão de validação a este configurador.
    
    Parameters:
    
    expression - A expressão (Não aceita null).
    
    Returns:
    
    true sucesso ou false se não puder adicionar a expressão, porque existe uma expressão igual a esta já cadastrada.
  - addGroup
```
public boolean addGroup(ParameterGroup group)
```
    Adiciona um grupo a este configurador.
    
    Mantém a ordem de inserção.
    
    Parameters:
    
    group - O grupo (Não aceita null).
    
    Returns:
    
    true sucesso ou false se não puder adicionar o grupo, porque existe um grupo igual a este já cadastrado.
  - addHiddenParameter
```
public boolean addHiddenParameter(HiddenParameter hiddenParameter)
```
    Adiciona um parâmetro oculto a este configurador.
    
    Parameters:
    
    hiddenParameter - O parâmetro oculto (Não aceita null).
    
    Returns:
    
    true sucesso ou false se não puder adicionar o parâmetro oculto, porque existe um parâmetro oculto igual a este já cadastrado.
  - addTrigger
```
public boolean addTrigger(Trigger<?> trigger)
```
    Adiciona um gatilho a este configurador.
    
    Quando o gatilho é adicionado ele é atualizado, para que haja uma sincronia entre o estado do configurador e o funcionamento do gatilho.
    
    Parameters:
    
    trigger - O gatilho (Não aceita null).
    
    Returns:
    
    true sucesso ou false se não puder adicionar o gatilho, porque existe um gatilho igual a este já cadastrado.
  - exportValues
```
public Map<Object,Object> exportValues()
```
    Exporta os valores dos parâmetros para um Map que contém apenas objetos que são tipos envelopes para tipos primitivos ou coleções padrão do API do Java.
    
    Este método cria um Map que pode ser serializado para um arquivo.
    
    O mapa retornado neste método pode ser utilizado pelo método AlgorithmConfigurator.importValues(Map).
    
    Specified by:
    
    exportValues in class AlgorithmConfigurator
    
    Returns:
    
    O Map ou uma mapa vazio se não houver valores ou parâmetros.
  - getBinaryDirectoriesAsArray
```
public Set<String[]> getBinaryDirectoriesAsArray(String platformId)
```
    Obtém uma relação de caminhos em forma de array para os diretórios dos binários deste algoritmo para um determinado SGAInfo.
    
    Specified by:
    
    getBinaryDirectoriesAsArray in class AlgorithmConfigurator
    
    Parameters:
    
    platformId - O nome da plataforma (Não aceita null).
    Obs.: o conjunto de caminhos retornável deve ser imutável (veja Collections.unmodifiableSet(Set)).
    
    Returns:
    
    O conjunto dos caminhos em forma de array.
  - getBinaryDirectories
```
public Set<String> getBinaryDirectories(String platformId,
                                        char fileSeparator)
```
    Obtém uma relação de caminhos para os diretórios dos binários deste algoritmo para um determinado SGAInfo.
    
    Specified by:
    
    getBinaryDirectories in class AlgorithmConfigurator
    
    Parameters:
    
    platformId - O nome da plataforma (Não aceita null).
    
    fileSeparator - O separador de arquivo (Não aceita null).
    Obs.: o conjunto de caminhos retornável deve ser imutável (veja Collections.unmodifiableSet(Set)).
    
    Returns:
    
    O conjunto dos caminhos.
  - getCommandBinaryName
```
public String getCommandBinaryName()
```
    Obtém o nome do executável.
    
    Returns:
    
    O nome do executável.
  - getDefaultInputFileParameterName
```
public String getDefaultInputFileParameterName()
```
    Obtém o nome do arquivo de entrada padrão.
    
    Returns:
    
    O nome do arquivo de entrada padrão ou null se não houver um.
  - getInputDirectories
```
public Set<FileURLValue> getInputDirectories()
```
    Obtém o conjunto de diretórios de entrada.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Specified by:
    
    getInputDirectories in class AlgorithmConfigurator
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja diretórios como valor de nenhum dos parâmetros.
  - getOutputDirectories
```
public Set<FileURLValue> getOutputDirectories()
```
    Obtém o conjunto de diretórios de saída.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Specified by:
    
    getOutputDirectories in class AlgorithmConfigurator
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja diretórios como valor de nenhum dos parâmetros.
  - getExpressions
```
public Set<ValidationExpression> getExpressions()
```
    Obtém o conjunto de expressões de validação associadas a este configurador.
    
    O conjunto retornado é imutável (veja Collections.unmodifiableSet(Set)).
    
    Returns:
    
    O conjunto de expressões ou um conjunto vazio se não houver expressões.
  - getGroups
```
public List<ParameterGroup> getGroups()
```
    Obtém a lista de grupos associadas a este configurador.
    
    A lista retornada é imutável (veja Collections.unmodifiableList(List)).
    
    Returns:
    
    A lista de grupos ou um conjunto vazio se não houver grupos.
  - getHiddenParameters
```
public Set<HiddenParameter> getHiddenParameters()
```
    Obtém o conjunto de parâmetros ocultos associados a este configurador.
    
    O conjunto retornado é imutável (veja Collections.unmodifiableSet(Set)).
    
    Returns:
    
    O conjunto de parâmetros ocultos ou um conjunto vazio se não houver parâmetros ocultos.
  - getInputFileListParameters
```
public List<InputFileListParameter> getInputFileListParameters()
```
    Obtém a lista com os parâmetros que aceitam um conjunto de arquivos e/ou diretórios para entrada de dados.
    
    Obs.: a relação é imutável (@see Collections.unmodifiableList(List) ).
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem um conjunto de arquivos.
  - getOutputFileListParameters
```
public List<OutputFileListParameter> getOutputFileListParameters()
```
    Obtém a lista com os parâmetros que aceitam um conjunto de arquivos e/ou diretórios para saída de dados.
    
    Obs.: a relação é imutável (@see Collections.unmodifiableList(List) ).
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem um conjunto de arquivos.
  - getInputURLListParameters
```
public List<InputURLListParameter> getInputURLListParameters()
```
    Obtém a lista com os parâmetros que aceitam um conjunto de arquivos e/ou diretórios (URLs) para entrada de dados.
    
    Obs.: a relação é imutável (@see Collections.unmodifiableList(List) ).
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem um conjunto de arquivos.
  - getOutputURLListParameters
```
public List<OutputURLListParameter> getOutputURLListParameters()
```
    Obtém a lista com os parâmetros que aceitam um conjunto de arquivos e/ou diretórios (URLs) para saída de dados.
    
    Obs.: a relação é imutável (@see Collections.unmodifiableList(List) ).
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem um conjunto de arquivos.
  - getInputFileParameters
```
public List<InputFileParameter> getInputFileParameters()
```
    Obtém a lista com os parâmetros que aceitam arquivos e/ou diretórios para entrada de dados.
    
    Obs.: a relação é imutável (veja Collections.unmodifiableList(List) ).
    
    Specified by:
    
    getInputFileParameters in class AlgorithmConfigurator
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem arquivos.
  - getInputFiles
```
public Set<FileURLValue> getInputFiles()
```
    Obtém o conjunto de arquivos de entrada.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Specified by:
    
    getInputFiles in class AlgorithmConfigurator
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja arquivos de entrada como valor de nenhum dos parâmetros.
  - getOutputFileParameters
```
public List<OutputFileParameter> getOutputFileParameters()
```
    Obtém a lista com os parâmetros que aceitam arquivos e/ou diretórios para saída de dados.
    
    Obs.: a relação é imutável (veja Collections.unmodifiableList(List) ).
    
    Specified by:
    
    getOutputFileParameters in class AlgorithmConfigurator
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem arquivos.
  - getOutputFiles
```
public Set<FileURLValue> getOutputFiles()
```
    Obtém o conjunto de arquivos de saída.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Specified by:
    
    getOutputFiles in class AlgorithmConfigurator
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja arquivos de saída como valor de nenhum dos parâmetros.
  - getInputURLParameters
```
public List<InputURLParameter> getInputURLParameters()
```
    Obtém a lista com os parâmetros do tipo URL que aceitam arquivos e/ou diretórios para entrada de dados.
    
    Obs.: a relação é imutável (veja Collections.unmodifiableList(List) ).
    
    Specified by:
    
    getInputURLParameters in class AlgorithmConfigurator
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem arquivos.
  - getInputURLs
```
public Set<FileURLValue> getInputURLs()
```
    Obtém o conjunto de arquivos (URLs) de entrada.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Specified by:
    
    getInputURLs in class AlgorithmConfigurator
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja arquivos de entrada como valor de nenhum dos parâmetros.
  - getOutputURLParameters
```
public List<OutputURLParameter> getOutputURLParameters()
```
    Obtém a lista com os parâmetros que aceitam arquivos e/ou diretórios (URLs) para saída de dados.
    
    Obs.: a relação é imutável (veja Collections.unmodifiableList(List) ).
    
    Specified by:
    
    getOutputURLParameters in class AlgorithmConfigurator
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem arquivos.
  - getOutputURLs
```
public Set<FileURLValue> getOutputURLs()
```
    Obtém o conjunto de arquivos (URLs) de saída.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Specified by:
    
    getOutputURLs in class AlgorithmConfigurator
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja arquivos de saída como valor de nenhum dos parâmetros.
  - getParameterLabel
```
public String getParameterLabel(String parameterName)
                         throws ParameterNotFoundException
```
    Obtém o rótulo de um parâmetro dado o seu nome.
    
    Specified by:
    
    getParameterLabel in class AlgorithmConfigurator
    
    Parameters:
    
    parameterName - O nome do parâmetro (Não aceita null).
    
    Returns:
    
    O rótulo.
    
    Throws:
    
    ParameterNotFoundException - Se não existir um parâmetro com o nome fornecido.
  - getParameterNames
```
public Set<String> getParameterNames()
```
    Obtém a relação de nomes dos parâmetros.
    
    A relação é imutável (veja Collections.unmodifiableSet(Set)).
    
    Specified by:
    
    getParameterNames in class AlgorithmConfigurator
    
    Returns:
    
    A relação de nomes ou uma relação vazia caso não haja parâmetros.
  - getParameterType
```
public String getParameterType(String parameterName)
                        throws ParameterNotFoundException
```
    Obtém o tipo de um parâmetro dado o seu nome.
    
    Specified by:
    
    getParameterType in class AlgorithmConfigurator
    
    Parameters:
    
    parameterName - O nome do parâmetro (Não aceita null).
    
    Returns:
    
    O tipo.
    
    Throws:
    
    ParameterNotFoundException - Se não existir um parâmetro com o nome fornecido.
  - getParameterValue
```
public String getParameterValue(String parameterName)
                         throws ParameterNotFoundException
```
    Obtém o valor de um parâmetro dado o seu nome.
    
    Specified by:
    
    getParameterValue in class AlgorithmConfigurator
    
    Parameters:
    
    parameterName - O nome do parâmetro (Não aceita null).
    
    Returns:
    
    O valor ou null caso não haja um valor para o parâmetro.
    
    Throws:
    
    ParameterNotFoundException - Se não existir um parâmetro com o nome fornecido.
  - getPlatforms
```
public Set<String> getPlatforms()
```
    Obtém uma relação de todas as plataformas suportadas por este configurador de algoritmos.
    
    A relação é imutável (veja Collections.unmodifiableSet(Set)).
    
    Specified by:
    
    getPlatforms in class AlgorithmConfigurator
    
    Returns:
    
    A relação de plataformas.
  - getShell
```
public String getShell()
```
    Obtém o shell que irá executar o comando deste configurador.
    
    Returns:
    
    O shell ou null se ele não for informado.
  - getSimpleParameter
```
public SimpleParameter<?> getSimpleParameter(String parameterName)
```
    Obtém um parâmetro simples dado o seu nome.
    
    Parameters:
    
    parameterName - O nome do parâmetro (Não aceita null).
    
    Returns:
    
    O parâmetro ou null se o parâmetro não for encontrado.
  - getSimpleParameters
```
public List<SimpleParameter<?>> getSimpleParameters()
```
    Obtém a lista de todos parâmetros simples associados a este configurador de algoritmos.
    
    A lista retornada é imutável (veja Collections.unmodifiableList(List)).
    
    Returns:
    
    A lista de parâmetros ou uma lista vazia se não houver parâmetros.
  - getTriggers
```
public Set<Trigger<?>> getTriggers()
```
    Obtém o conjunto de gatilhos associados a este configurador.
    
    O conjunto retornado é imutável (veja Collections.unmodifiableSet(Set)).
    
    Returns:
    
    O conjunto de gatilhos ou um conjunto vazio se não houver gatilhos associados a este configurador.
  - isEnabled
```
public boolean isEnabled()
```
    Indica se o configurador está habilitado.
    
    Specified by:
    
    isEnabled in class AlgorithmConfigurator
    
    Returns:
    
    true se estiver habilitado ou false caso contrário.
  - isSetDefaultValues
```
public boolean isSetDefaultValues()
```
    Verifica se os valores deste configurador são iguais aos valores-padrão.
    
    Specified by:
    
    isSetDefaultValues in class AlgorithmConfigurator
    
    Returns:
    
    true se todos os valores são iguais aos valores-padrão ou false caso contrário.
  - importValues
```
public void importValues(Map<Object,Object> parameterValues)
```
    Importa os valores dos parâmetros de um Map.
    
    Specified by:
    
    importValues in class AlgorithmConfigurator
    
    Parameters:
    
    parameterValues - O mapa de valores de parâmetros (Não aceita null).
  - makeCommandLine
```
public String makeCommandLine(CommandLineContext context)
```
    Cria a linha de comando.
    
    Specified by:
    
    makeCommandLine in class AlgorithmConfigurator
    
    Parameters:
    
    context - contexto para criação da linha de comando.
    
    Returns:
    
    A linha de comando compatível com o shell Korn Shell (ksh).
  - makeEnvironmentVariablesDeclaration
```
protected String makeEnvironmentVariablesDeclaration(CommandLineContext context)
```
    Cria a parte da linha de comando que declara as variáveis de ambiente utilizadas e disponibilizadas pelo comando.
    
    Parameters:
    
    context - Contexto de execução do comando.
    
    Returns:
    
    A declaração de variáveis de ambiente para a linha de comando.
  - resetValues
```
public void resetValues()
```
    Restaura os valores dos parâmetros para os valores-padrão.
    
    Specified by:
    
    resetValues in class AlgorithmConfigurator
  - setDefaultInputFile
```
public boolean setDefaultInputFile(FileURLValue inputFile)
```
    Atribui um arquivo para ser utilizado com o arquivo de entrada padrão do configurador.
    
    O arquivo de entrada padrão é o arquivo que é atribuido a um dos parâmetros do tipo arquivo de entrada (veja InputFileParameter) tipicamente uma operação de duplo-clique na árvore de projetos.
    
    Por exemplo: em um algoritmo para descomprimir dados, o arquivo de entrada padrão poderia ser o arquivo a ser expandido.
    
    Specified by:
    
    setDefaultInputFile in class AlgorithmConfigurator
    
    Parameters:
    
    inputFile - O arquivo de entrada (Aceita null).
    
    Returns:
    
    true se a operação foi realizada com sucesso ou false se o configurador não aceita arquivo de entrada padrão ou este tipo de arquivo de entrada padrão.
  - setEnabled
```
public boolean setEnabled(boolean isEnabled)
```
    Modifica o estado habilitado/desabilitado do configurador de algoritmos.
    
    Dispara o evento AlgorithmConfiguratorListener.wasSetEnabled(AlgorithmConfigurator).
    
    Specified by:
    
    setEnabled in class AlgorithmConfigurator
    
    Parameters:
    
    isEnabled - Indica se o configurador se tornará habilitado ou desabilitado.
    
    Returns:
    
    true em caso de sucesso ou false se não houver mudança de estado.
  - setParameterValue
```
public void setParameterValue(String parameterName,
                              String parameterValue)
                       throws ParseException,
                              ParameterNotFoundException
```
    Atribui o valor a um parâmetro.
    
    Specified by:
    
    setParameterValue in class AlgorithmConfigurator
    
    Parameters:
    
    parameterName - O nome do parâmetro (Não aceita null).
    
    parameterValue - O valor do parâmetro (Aceita null)
    
    Throws:
    
    ParseException - Se pelo menos um dos valores não estiver em um formato que não pode ser aceito pelo seu parâmetro.
    
    ParameterNotFoundException - Caso não exista um parâmetro com o nome fornecido.
  - updateTriggers
```
public void updateTriggers()
```
    Atualiza os gatilhos cujas condições sejam aceitas.
  - getCurrentParameterFileVersion
```
protected String getCurrentParameterFileVersion()
```
    Obtém a versão atual do arquivo de parâmetros.
    
    Specified by:
    
    getCurrentParameterFileVersion in class AlgorithmConfigurator
    
    Returns:
    
    .
  - validate
```
public Validation validate(ValidationContext context)
                    throws RemoteException
```
    Verifica se os valores armazenados no parâmetro são válidos.
    
    Specified by:
    
    validate in class AlgorithmConfigurator
    
    Parameters:
    
    context - contexto da validação.
    
    Returns:
    
    O resultado da validação.
    
    Throws:
    
    RemoteException - em caso de erro na comunicação com servidor.
  - allowParametersLoad
```
public Boolean allowParametersLoad()
```
    Indica se o algoritmo suporta carga e armazenamento de valores de parâmetros em arquivos de projeto.
    
    Returns:
    
    true se o usuário pode selecionar um arquivo para recuperar e salvar valores dos parâmetros exibidos na interface.

Class SimpleAlgorithmConfigurator

Nested Class Summary

Nested classes/interfaces inherited from class csbase.logic.algorithms.AlgorithmConfigurator

Field Summary

Fields inherited from class csbase.logic.algorithms.AlgorithmConfigurator

Constructor Summary

Method Summary

Methods inherited from class csbase.logic.algorithms.AlgorithmConfigurator

Methods inherited from class java.lang.Object

Constructor Detail

SimpleAlgorithmConfigurator

SimpleAlgorithmConfigurator

Method Detail

addExpression

addGroup

addHiddenParameter

addTrigger

exportValues

getBinaryDirectoriesAsArray

getBinaryDirectories

getCommandBinaryName

getDefaultInputFileParameterName

getInputDirectories

getOutputDirectories

getExpressions

getGroups

getHiddenParameters

getInputFileListParameters

getOutputFileListParameters

getInputURLListParameters

getOutputURLListParameters

getInputFileParameters

getInputFiles

getOutputFileParameters

getOutputFiles

getInputURLParameters

getInputURLs

getOutputURLParameters

getOutputURLs

getParameterLabel

getParameterNames

getParameterType

getParameterValue

getPlatforms

getShell

getSimpleParameter

getSimpleParameters

getTriggers

isEnabled

isSetDefaultValues

importValues

makeCommandLine

makeEnvironmentVariablesDeclaration

resetValues

setDefaultInputFile

setEnabled

setParameterValue

updateTriggers

getCurrentParameterFileVersion

validate

allowParametersLoad