AlgorithmConfigurator (csbase-common 3.1.3-DBG API)

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FlowAlgorithmConfigurator, SimpleAlgorithmConfigurator
```
public abstract class AlgorithmConfigurator
extends Object
implements Serializable
```
O modelo de um configurador de algoritmos.

O configurador de algoritmos é responsável por implementar praticamente todas as responsabilidades relacionadas à montagem da linha de comando utilizada para executar algoritmos em um SGAInfo. Entre essas responsabilidades pode-se destacar:
- Importar e exportar parâmetros com importValues(java.util.Map) e exportValues());
- Receber os valores dos parâmetros fornecidos pelo usuário (método: setParameterValuesByName(Map));
- Montar a linha de comando (método: makeCommandLine(CommandLineContext));
Alguns métodos podem gerar eventos observáveis por instâncias da classe AlgorithmConfiguratorListener.
Author:

lmoreira

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AlgorithmConfigurator.ConfiguratorType
Enumera os tipos de configuradores disponíveis

Nested Classes
Modifier and Type	Class and Description
`static class`	`AlgorithmConfigurator.ConfiguratorType` Enumera os tipos de configuradores disponíveis

Field Summary

Fields
Modifier and Type Field and Description

static String FILE_LIST_SEPARATOR
Caractere separador de lista de arquivos na linha de comando.

Fields
Modifier and Type	Field and Description
`static String`	`FILE_LIST_SEPARATOR` Caractere separador de lista de arquivos na linha de comando.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AlgorithmConfigurator(AlgorithmConfigurator.ConfiguratorType type, String description, ExecutionType executionType, ExecutionLocation executionLocation, String abbreviation, boolean provideId, String commandLinePattern)` Cria um configurador de algoritmos.
`protected`	`AlgorithmConfigurator(AlgorithmConfigurator.ConfiguratorType type, String filePath, String description, ExecutionType executionType, ExecutionLocation executionLocation, String abbreviation, boolean provideId, String commandLinePattern)` Cria um configurador de algoritmos.
`protected`	`AlgorithmConfigurator(AlgorithmVersionInfo algorithmVersion, String description, ExecutionType executionType, ExecutionLocation executionLocation, String abbreviation, boolean provideId, String commandLinePattern)` Cria um configurador de algoritmos.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlgorithmConfiguratorListener(AlgorithmConfiguratorListener listener)` Adiciona um observador de configurador de algoritmos a esta instância.
`boolean`	`equals(Object obj)`
`abstract 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.
`protected void`	`fireParameterLabelWasChanged(String parameterName, String parameterLabel)` Dispara o evento `AlgorithmConfiguratorListener.parameterLabelWasChanged(AlgorithmConfigurator, String, String)`
`protected <V> void`	`fireParameterValueWasChanged(String parameterName, V parameterValue)` Dispara o evento `AlgorithmConfiguratorListener.parameterValueWasChanged(AlgorithmConfigurator, String, Object)`
`protected void`	`fireParameterWasSetEnabled(String parameterName, boolean parameterIsEnabled)` Dispara o evento `AlgorithmConfiguratorListener.parameterWasSetEnabled(AlgorithmConfigurator, String, boolean)` .
`protected void`	`fireParameterWasSetVisible(String parameterName, boolean parameterIsVisible)` Dispara o evento `AlgorithmConfiguratorListener.parameterWasSetVisible(AlgorithmConfigurator, String, boolean)` .
`protected void`	`fireWasSetEnabled()` Dispara o evento `AlgorithmConfiguratorListener.wasSetEnabled(AlgorithmConfigurator)`.
`String`	`getAbbreviation()` Obtém a abreviatura do algoritmo.
`String`	`getAlgorithmName()` Obtém o nome do algoritmo.
`AlgorithmVersionInfo`	`getAlgorithmVersion()` Obtém a versão do algoritmo deste configurador.
`AlgorithmVersionId`	`getAlgorithmVersionId()` Obtém o identificador da versão do algoritmo.
`abstract Set<String>`	`getBinaryDirectories(String platformName, char fileSeparator)` Obtém uma relação de caminhos para os diretórios dos binários deste algoritmo para um determinado `SGAInfo`.
`abstract Set<String[]>`	`getBinaryDirectoriesAsArray(String platformName)` 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`	`getCommandDescription()` Obtém a descrição default do comando a ser gerado pelo algoritmo.
`String`	`getCommandLinePattern()`
`AlgorithmConfigurator.ConfiguratorType`	`getConfiguratorType()` Retorna
`float`	`getCpuAmount()` Obtém a quantidade de CPU solicitada pelo algoritmo.
`protected abstract String`	`getCurrentParameterFileVersion()` Obtém a versão atual do arquivo de parâmetros.
`String`	`getDescription()` Obtém a descrição deste configurador.
`ExecutionLocation`	`getExecutionLocation()` Obtém o local de execução do algoritmo.
`ExecutionType`	`getExecutionType()` Obtém o tipo de execução.
`protected String`	`getExitCodeCaptureCommand(CommandLineContext context)` Retorna a linha de comando necessária para fazer a captura do código de saída de execução do algoritmo.
`FileURLValue`	`getExitCodeLogFile()` Retorna o arquivo que armazena o código de saída do algoritmo.
`Set<FileURLValue>`	`getExitCodeLogFiles()` Retorna os arquivos que armazenam os códigos de saída dos algoritmos (são vários, no caso de fluxo).
`SortedSet<AbstractFileParameter>`	`getFileParameters()` Obtém a relação com os parâmetros que aceitam arquivos e/ou diretórios.
`String`	`getFilePath()` Obtém o caminho para o arquivo que descreve este configurador.
`abstract Set<FileURLValue>`	`getInputDirectories()` Obtém o conjunto de diretórios de entrada.
`abstract List<InputFileParameter>`	`getInputFileParameters()` Obtém a lista com os parâmetros que aceitam arquivos e/ou diretórios para entrada de dados.
`abstract Set<FileURLValue>`	`getInputFiles()` Obtém o conjunto de arquivos de entrada.
`abstract 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.
`abstract Set<FileURLValue>`	`getInputURLs()` Obtém o conjunto de arquivos (URLs) de entrada.
`FileURLValue`	`getLogFile()` Obtém o descritor do arquivo de log.
`OutputFileParameter`	`getLogFileParameter()` Obtém o parâmetro de log.
`Set<FileURLValue>`	`getLogFiles()` Obtém todos os arquivos de log.
`float`	`getMemoryAmount()` Obtém a quantidade de memória solicitada pelo algoritmo.
`abstract Set<FileURLValue>`	`getOutputDirectories()` Obtém o conjunto de diretórios de saída.
`abstract List<OutputFileParameter>`	`getOutputFileParameters()` Obtém a lista com os parâmetros que aceitam arquivos e/ou diretórios para saída de dados.
`abstract Set<FileURLValue>`	`getOutputFiles()` Obtém o conjunto de arquivos de saída.
`abstract List<OutputURLParameter>`	`getOutputURLParameters()` Obtém a lista com os parâmetros que aceitam arquivos e/ou diretórios (URLs) para saída de dados.
`abstract Set<FileURLValue>`	`getOutputURLs()` Obtém o conjunto de arquivos (URLs) de saída.
`abstract String`	`getParameterLabel(String parameterName)` Obtém o rótulo de um parâmetro dado o seu nome.
`abstract Set<String>`	`getParameterNames()` Obtém a relação de nomes dos parâmetros.
`abstract String`	`getParameterType(String parameterName)` Obtém o tipo de um parâmetro dado o seu nome.
`abstract String`	`getParameterValue(String parameterName)` Obtém o valor de um parâmetro dado o seu nome.
`Map<String,String>`	`getParameterValuesByName()` Retorna um mapa com os valores dos parâmetros indexado pelos nomes.
`abstract Set<String>`	`getPlatforms()` Obtém uma relação de todas as plataformas suportadas por este configurador de algoritmos.
`Set<String>`	`getRequirements()` Obtém os requisitos necessários ao algoritmo.
`FileURLValue`	`getStandardOutputFile()` Obtém a saída padrão que será utilizada durante a execução de um algorítmo representado por este configurador.
`Set<FileURLValue>`	`getStandardOutputFiles()` Obtém um conjunto imutável contendo os arquivos de saída padrão.
`FileURLValue`	`getWarningsFile()` Retorna o arquivo que armazena os alertas do algoritmo.
`Set<FileURLValue>`	`getWarningsFiles()` Retorna os arquivos que armazenam os alertas dos algoritmos (são vários, no caso de fluxo).
`boolean`	`hasExitCode()` Indica se o algoritmo provê um código de saída durante sua execução.
`int`	`hashCode()`
`boolean`	`hasParameterThatRequiresPipe()` Retorna verdadeiro se algum dos parâmetros do algoritmo somente podem ser utilizados via pipe.
`abstract void`	`importValues(Map<Object,Object> values)` Importa os valores dos parâmetros de um `Map`.
`abstract boolean`	`isEnabled()` Indica se o configurador está habilitado.
`boolean`	`isMultipleExecution()` Indica se este configurador utiliza o tipo de execução `ExecutionType.MULTIPLE`.
`abstract boolean`	`isSetDefaultValues()` Verifica se os valores deste configurador são iguais aos valores-padrão.
`boolean`	`isSimpleExecution()` Indica se este configurador utiliza o tipo de execução `ExecutionType.SIMPLE`.
`abstract String`	`makeCommandLine(CommandLineContext context)` Cria a linha de comando.
`CommandScript[]`	`makeCommandLineAsScript(CommandLineContext context)` Cria a linha de comando e a salva em um arquivo de script.
`boolean`	`provideId()` Indica se irá fornecer o identificador do comando na linha de comando.
`abstract void`	`resetValues()` Restaura os valores dos parâmetros para os valores-padrão.
`void`	`setCommandDescription(String commandDescription)` Estabelece a descrição default do comando a ser gerado pelo algoritmo.
`abstract boolean`	`setDefaultInputFile(FileURLValue inputFile)` Atribui um arquivo para ser utilizado com o arquivo de entrada padrão do configurador.
`abstract boolean`	`setEnabled(boolean isEnabled)` Modifica o estado habilitado/desabilitado do configurador de algoritmos.
`void`	`setExecutionLocation(ExecutionLocation executionLocation)` Atribui o local e execução do algoritmo.
`void`	`setExecutionType(ExecutionType executionType)` Atribui o tipo de execução a este configurador.
`void`	`setExitCodeLogFile(FileURLValue exitCodeLogFile)` Seta o arquivo que armazena o código de saída do algoritmo.
`void`	`setHasExitCode(boolean hasExitCode)` Determina se o algoritmo provê um código de saída durante sua execução.
`boolean`	`setLogFileParameterVisible(boolean isVisible)` Exibe ou oculta o parâmetro log.
`abstract void`	`setParameterValue(String parameterName, String parameterValue)` Atribui o valor a um parâmetro.
`void`	`setParameterValuesByName(Map<String,String> parameterValuesByName)` Atribui valores a este configurador de algoritmos.
`void`	`setStandardOutputFile(FileURLValue standardOutputFile)` Atribui o valor do arquivo que deve receber a saída padrão da execução de um algoritmo representado por este configurador.
`void`	`setWarningsFile(FileURLValue warningsFile)` Atribui o arquivo que armazena os alertas do algoritmo.
`String`	`toString()`
`void`	`updateAlgorithmVersion()` Atualiza a versão deste configurador, que pode ter sido alterada pelo administrador.
`abstract Validation`	`validate(ValidationContext context)` Verifica se os valores armazenados no parâmetro são válidos.

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

- Field Detail
  - FILE_LIST_SEPARATOR
```
public static final String FILE_LIST_SEPARATOR
```
    Caractere separador de lista de arquivos na linha de comando.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AlgorithmConfigurator
```
protected AlgorithmConfigurator(AlgorithmVersionInfo algorithmVersion,
                                String description,
                                ExecutionType executionType,
                                ExecutionLocation executionLocation,
                                String abbreviation,
                                boolean provideId,
                                String commandLinePattern)
```
    Cria um configurador de algoritmos.
    
    Parameters:
    
    algorithmVersion - A versão do algoritmo (Não aceita null).
    
    description - A descrição do configurador de algoritmos (Aceita null).
    
    executionType - O tipo de execução (Não aceita null).
    
    executionLocation - Local de execução do algoritmo.
    
    abbreviation - A abreviatura (Aceita null).
    
    provideId - Sinal que indica se é necessário fornecer o identificador do comando na linha de comando.
    
    commandLinePattern - pattern para linha de comando.
  - AlgorithmConfigurator
```
protected AlgorithmConfigurator(AlgorithmConfigurator.ConfiguratorType type,
                                String description,
                                ExecutionType executionType,
                                ExecutionLocation executionLocation,
                                String abbreviation,
                                boolean provideId,
                                String commandLinePattern)
```
    Cria um configurador de algoritmos.
    
    Parameters:
    
    type - Tipo de configurador (@see AlgorithmConfigurator.ConfiguratorType)
    
    description - A descrição do configurador de algoritmos (Aceita null).
    
    executionType - O tipo de execução (Não aceita null).
    
    executionLocation - Local de execução do algoritmo.
    
    abbreviation - A abreviatura (Aceita null).
    
    provideId - Sinal que indica se é necessário fornecer o identificador do comando na linha de comando.
    
    commandLinePattern - pattern para linha de comando.
  - AlgorithmConfigurator
```
protected AlgorithmConfigurator(AlgorithmConfigurator.ConfiguratorType type,
                                String filePath,
                                String description,
                                ExecutionType executionType,
                                ExecutionLocation executionLocation,
                                String abbreviation,
                                boolean provideId,
                                String commandLinePattern)
```
    Cria um configurador de algoritmos.
    
    Parameters:
    
    type - Tipo de configurador (@see AlgorithmConfigurator.ConfiguratorType)
    
    filePath - O caminho para o arquivo que descreve este configurador (Não aceita null).
    
    description - A descrição do configurador de algoritmos (Aceita null).
    
    executionType - O tipo de execução (Não aceita null).
    
    executionLocation - Local de execução do algoritmo.
    
    abbreviation - A abreviatura (Aceita null).
    
    provideId - Sinal que indica se é necessário fornecer o identificador do comando na linha de comando.
    
    commandLinePattern - pattern para linha de comando.
- Method Detail
  - getConfiguratorType
```
public AlgorithmConfigurator.ConfiguratorType getConfiguratorType()
```
    Retorna
    
    Returns:
    
    configuratorType
  - getLogFiles
```
public Set<FileURLValue> getLogFiles()
```
    Obtém todos os arquivos de log.
    
    O conjunto retornado é imutável (Collections.unmodifiableSet(Set)).
    
    Returns:
    
    o conjunto de arquivos de log (se não existir arquivo de log, retornará um conjunto vazio).
  - addAlgorithmConfiguratorListener
```
public final void addAlgorithmConfiguratorListener(AlgorithmConfiguratorListener listener)
```
    Adiciona um observador de configurador de algoritmos a esta instância.
    
    Parameters:
    
    listener - O observador (Não aceita null).
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - exportValues
```
public abstract 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 importValues(Map).
    
    Returns:
    
    O Map ou uma mapa vazio se não houver valores ou parâmetros.
  - getAbbreviation
```
public final String getAbbreviation()
```
    Obtém a abreviatura do algoritmo.
    
    Returns:
    
    A abreviatura do algoritmo ou null se ela não existir.
  - getAlgorithmName
```
public final String getAlgorithmName()
```
    Obtém o nome do algoritmo.
    
    Returns:
    
    O nome do algoritmo ou null se este configurador não estiver associado a um algoritmo.
  - getAlgorithmVersion
```
public final AlgorithmVersionInfo getAlgorithmVersion()
```
    Obtém a versão do algoritmo deste configurador.
    
    Returns:
    
    A versão do algoritmo ou null se este configurador não estiver uma versão.
  - getAlgorithmVersionId
```
public final AlgorithmVersionId getAlgorithmVersionId()
```
    Obtém o identificador da versão do algoritmo.
    
    Returns:
    
    O identificador da versão do algoritmo ou null se este configurador não estiver associado a um algoritmo.
  - getBinaryDirectories
```
public abstract Set<String> getBinaryDirectories(String platformName,
                                                 char fileSeparator)
```
    Obtém uma relação de caminhos para os diretórios dos binários deste algoritmo para um determinado SGAInfo.
    
    Parameters:
    
    platformName - 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.
  - getBinaryDirectoriesAsArray
```
public abstract Set<String[]> getBinaryDirectoriesAsArray(String platformName)
```
    Obtém uma relação de caminhos em forma de array para os diretórios dos binários deste algoritmo para um determinado SGAInfo.
    
    Parameters:
    
    platformName - 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.
  - getCpuAmount
```
public final float getCpuAmount()
```
    Obtém a quantidade de CPU solicitada pelo algoritmo.
    
    Returns:
    
    .
  - getLogFile
```
public final FileURLValue getLogFile()
```
    Obtém o descritor do arquivo de log.
    
    Returns:
    
    O descritor do arquivo ou null se ele não existir.
  - getLogFileParameter
```
public final OutputFileParameter getLogFileParameter()
```
    Obtém o parâmetro de log.
    
    Returns:
    
    O parâmetro de log (null se ele não existir).
  - getMemoryAmount
```
public final float getMemoryAmount()
```
    Obtém a quantidade de memória solicitada pelo algoritmo.
    
    Returns:
    
    .
  - getCommandLinePattern
```
public final String getCommandLinePattern()
```
    Returns:
    
    o campo commandLinePattern
  - getRequirements
```
public Set<String> getRequirements()
```
    Obtém os requisitos necessários ao algoritmo.
    
    Returns:
    
    .
  - getDescription
```
public final String getDescription()
```
    Obtém a descrição deste configurador.
    
    Returns:
    
    A descrição ou null caso não hava descrição.
  - getOutputDirectories
```
public abstract Set<FileURLValue> getOutputDirectories()
```
    Obtém o conjunto de diretórios de saída.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja diretórios como valor de nenhum dos parâmetros.
  - getInputDirectories
```
public abstract Set<FileURLValue> getInputDirectories()
```
    Obtém o conjunto de diretórios de entrada.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja diretórios como valor de nenhum dos parâmetros.
  - getExecutionType
```
public final ExecutionType getExecutionType()
```
    Obtém o tipo de execução.
    
    Returns:
    
    O tipo de execução.
  - getExecutionLocation
```
public final ExecutionLocation getExecutionLocation()
```
    Obtém o local de execução do algoritmo.
    
    Returns:
    
    O local de execução do algoritmo.
  - getFileParameters
```
public final SortedSet<AbstractFileParameter> getFileParameters()
```
    Obtém a relação com os parâmetros que aceitam arquivos e/ou diretórios.
    
    A relação é ordenada segundo o critério natural de ordenação de um parâmetro (Parameter).
    
    Obs.: a relação é imutável (veja Collections.unmodifiableSortedSet(SortedSet)).
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem arquivos.
  - getFilePath
```
public final String getFilePath()
```
    Obtém o caminho para o arquivo que descreve este configurador.
    
    Returns:
    
    O caminho para o arquivo ou null caso não haja um descritor disponível.
  - getInputFileParameters
```
public abstract 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) ).
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem arquivos.
  - getInputFiles
```
public abstract Set<FileURLValue> getInputFiles()
```
    Obtém o conjunto de arquivos de entrada.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja arquivos de entrada como valor de nenhum dos parâmetros.
  - getOutputFileParameters
```
public abstract 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) ).
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem arquivos.
  - getOutputFiles
```
public abstract Set<FileURLValue> getOutputFiles()
```
    Obtém o conjunto de arquivos de saída.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja arquivos de saída como valor de nenhum dos parâmetros.
  - getInputURLParameters
```
public abstract 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) ).
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem arquivos.
  - getInputURLs
```
public abstract Set<FileURLValue> getInputURLs()
```
    Obtém o conjunto de arquivos (URLs) de entrada.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja arquivos de entrada como valor de nenhum dos parâmetros.
  - getOutputURLParameters
```
public abstract 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) ).
    
    Returns:
    
    A relação de parâmetros ou uma relação vazia caso não haja parâmetros que aceitem arquivos.
  - getOutputURLs
```
public abstract Set<FileURLValue> getOutputURLs()
```
    Obtém o conjunto de arquivos (URLs) de saída.
    
    Obs.: o conjunto é imutável (veja Collections.unmodifiableSet(Set) ).
    
    Returns:
    
    O conjunto ou um conjunto vazio caso não haja arquivos de saída como valor de nenhum dos parâmetros.
  - getParameterLabel
```
public abstract String getParameterLabel(String parameterName)
                                  throws ParameterNotFoundException
```
    Obtém o rótulo de um parâmetro dado o seu nome.
    
    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 abstract Set<String> getParameterNames()
```
    Obtém a relação de nomes dos parâmetros.
    
    A relação é imutável (veja Collections.unmodifiableSet(Set)).
    
    Returns:
    
    A relação de nomes ou uma relação vazia caso não haja parâmetros.
  - getParameterType
```
public abstract String getParameterType(String parameterName)
                                 throws ParameterNotFoundException
```
    Obtém o tipo de um parâmetro dado o seu nome.
    
    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 abstract String getParameterValue(String parameterName)
                                  throws ParameterNotFoundException
```
    Obtém o valor de um parâmetro dado o seu nome.
    
    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.
  - getParameterValuesByName
```
public Map<String,String> getParameterValuesByName()
```
    Retorna um mapa com os valores dos parâmetros indexado pelos nomes.
    
    Returns:
    
    um mapa com os valores dos parâmetros indexado pelos nomes
  - getPlatforms
```
public abstract 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)).
    
    Returns:
    
    A relação de plataformas.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - importValues
```
public abstract void importValues(Map<Object,Object> values)
                           throws ParseException
```
    Importa os valores dos parâmetros de um Map.
    
    Parameters:
    
    values - O mapa de valores de parâmetros (Não aceita null).
    
    Throws:
    
    ParseException - Se os valores do mapa não puderem ser convertidos para os valores dos parâmetros.
  - isEnabled
```
public abstract boolean isEnabled()
```
    Indica se o configurador está habilitado.
    
    Returns:
    
    true se estiver habilitado ou false caso contrário.
  - isMultipleExecution
```
public final boolean isMultipleExecution()
```
    Indica se este configurador utiliza o tipo de execução ExecutionType.MULTIPLE.
    
    Returns:
    
    true se utiliza ou false caso contrário.
  - isSetDefaultValues
```
public abstract boolean isSetDefaultValues()
```
    Verifica se os valores deste configurador são iguais aos valores-padrão.
    
    Returns:
    
    true se todos os valores são iguais aos valores-padrão ou false caso contrário.
  - isSimpleExecution
```
public final boolean isSimpleExecution()
```
    Indica se este configurador utiliza o tipo de execução ExecutionType.SIMPLE.
    
    Returns:
    
    true se utiliza ou false caso contrário.
  - getExitCodeCaptureCommand
```
protected String getExitCodeCaptureCommand(CommandLineContext context)
```
    Retorna a linha de comando necessária para fazer a captura do código de saída de execução do algoritmo. Esse método deve ser chamado pelos configuradores filhos ao final de makeCommandLine(CommandLineContext context), caso queiram capturar o código de saída do algoritmo.
    
    Parameters:
    
    context - O contexto de execução do comando
    
    Returns:
    
    Uma string com a linha de comando que deve ser concatenada ao comando, caso se queria capturar o código de saída de sua execução.
    
    See Also:
    
    (para exemplo de uso)
  - makeCommandLine
```
public abstract String makeCommandLine(CommandLineContext context)
```
    Cria a linha de comando.
    
    Parameters:
    
    context - contexto para criação da linha de comando.
    
    Returns:
    
    A linha de comando compatível com o shell Korn Shell (ksh).
  - makeCommandLineAsScript
```
public CommandScript[] makeCommandLineAsScript(CommandLineContext context)
```
    Cria a linha de comando e a salva em um arquivo de script.
    
    Parameters:
    
    context - contexto para criação da linha de comando.
    
    Returns:
    
    A linha de comando compatível com o shell Korn Shell (ksh) para a execução do script.
  - provideId
```
public final boolean provideId()
```
    Indica se irá fornecer o identificador do comando na linha de comando.
    
    Returns:
    
    true se irá fornecer ou false caso contrário.
  - resetValues
```
public abstract void resetValues()
```
    Restaura os valores dos parâmetros para os valores-padrão.
  - setDefaultInputFile
```
public abstract 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.
    
    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 abstract boolean setEnabled(boolean isEnabled)
```
    Modifica o estado habilitado/desabilitado do configurador de algoritmos.
    
    Dispara o evento AlgorithmConfiguratorListener.wasSetEnabled(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.
  - setLogFileParameterVisible
```
public final boolean setLogFileParameterVisible(boolean isVisible)
```
    Exibe ou oculta o parâmetro log.
    
    Parameters:
    
    isVisible - true para exibir ou false para ocultar.
    
    Returns:
    
    false se não houver parâmetro log ou se foi solicitado "exibir" e o parâmetro está visível ou se foi solicitado "ocultar" e o parâmetro está oculto.
  - setParameterValue
```
public abstract void setParameterValue(String parameterName,
                                       String parameterValue)
                                throws ParseException,
                                       ParameterNotFoundException
```
    Atribui o valor a um parâmetro.
    
    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.
  - setParameterValuesByName
```
public void setParameterValuesByName(Map<String,String> parameterValuesByName)
                              throws ParseException,
                                     ParameterNotFoundException
```
    Atribui valores a este configurador de algoritmos.
    
    O mapa de parâmetros possui pares cujas as chaves são os nomes dos parâmetros e os valores são valores dos parâmetros. Caso não haja um parâmetro cujo nome não é chave do mapa o seu valor deverá ser considerado null.
    
    Parameters:
    
    parameterValuesByName - O mapa de valores.
    
    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.
  - updateAlgorithmVersion
```
public void updateAlgorithmVersion()
                            throws Exception
```
    Atualiza a versão deste configurador, que pode ter sido alterada pelo administrador.
    
    Throws:
    
    Exception - exceção
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setStandardOutputFile
```
public void setStandardOutputFile(FileURLValue standardOutputFile)
```
    Atribui o valor do arquivo que deve receber a saída padrão da execução de um algoritmo representado por este configurador.
    
    Parameters:
    
    standardOutputFile - arquivo de saída.
  - getStandardOutputFile
```
public FileURLValue getStandardOutputFile()
```
    Obtém a saída padrão que será utilizada durante a execução de um algorítmo representado por este configurador. Se este configurador for uma composição de outros, deve-se utilizar o método getStandardOutputFiles() para obter a saída padrão dos algoritmos que constituem este.
    
    Returns:
    
    a saída padrão que será utilizada durante a execução de um algorítmo representado por este configurador.
  - getStandardOutputFiles
```
public Set<FileURLValue> getStandardOutputFiles()
```
    Obtém um conjunto imutável contendo os arquivos de saída padrão. O tamanho do conjuno retornado será maior que um se este algoritmo é uma composição de outros. Como por exemplo, se ele for um fluxo.
    
    Returns:
    
    um conjunto imutável contendo os arquivos de saída padrão.
  - getCurrentParameterFileVersion
```
protected abstract String getCurrentParameterFileVersion()
```
    Obtém a versão atual do arquivo de parâmetros.
    
    Returns:
    
    .
  - fireParameterLabelWasChanged
```
protected final void fireParameterLabelWasChanged(String parameterName,
                                                  String parameterLabel)
```
    Dispara o evento AlgorithmConfiguratorListener.parameterLabelWasChanged(AlgorithmConfigurator, String, String)
    
    Parameters:
    
    parameterName - O nome do parâmetro (Não aceita null).
    
    parameterLabel - O rótulo do parâmetro (Não aceita null).
  - fireParameterValueWasChanged
```
protected final <V> void fireParameterValueWasChanged(String parameterName,
                                                      V parameterValue)
```
    Dispara o evento AlgorithmConfiguratorListener.parameterValueWasChanged(AlgorithmConfigurator, String, Object)
    
    Type Parameters:
    
    V - O tipo do valor.
    
    Parameters:
    
    parameterName - O nome do parâmetro (Não aceita null).
    
    parameterValue - O valor do parâmetro (Aceita null).
  - fireParameterWasSetEnabled
```
protected final void fireParameterWasSetEnabled(String parameterName,
                                                boolean parameterIsEnabled)
```
    Dispara o evento AlgorithmConfiguratorListener.parameterWasSetEnabled(AlgorithmConfigurator, String, boolean) .
    
    Parameters:
    
    parameterName - O nome do parâmetro (Não aceita null).
    
    parameterIsEnabled - Indica se o parâmetro está habilitado ( true) ou desabilitado (false).
  - fireParameterWasSetVisible
```
protected final void fireParameterWasSetVisible(String parameterName,
                                                boolean parameterIsVisible)
```
    Dispara o evento AlgorithmConfiguratorListener.parameterWasSetVisible(AlgorithmConfigurator, String, boolean) .
    
    Parameters:
    
    parameterName - O nome do parâmetro (Não aceita null).
    
    parameterIsVisible - Indica se o parâmetro está visível (true) ou oculto (false).
  - fireWasSetEnabled
```
protected final void fireWasSetEnabled()
```
    Dispara o evento AlgorithmConfiguratorListener.wasSetEnabled(AlgorithmConfigurator).
  - setExecutionType
```
public void setExecutionType(ExecutionType executionType)
```
    Atribui o tipo de execução a este configurador.
    
    Parameters:
    
    executionType - O tipo de execução (Não aceita null).
  - setExecutionLocation
```
public void setExecutionLocation(ExecutionLocation executionLocation)
```
    Atribui o local e execução do algoritmo.
    
    Parameters:
    
    executionLocation - O local de execução do algoritmo.
  - getCommandDescription
```
public String getCommandDescription()
```
    Obtém a descrição default do comando a ser gerado pelo algoritmo.
    
    Returns:
    
    a descrição default do comando
  - setCommandDescription
```
public void setCommandDescription(String commandDescription)
```
    Estabelece a descrição default do comando a ser gerado pelo algoritmo.
    
    Parameters:
    
    commandDescription - descrição do comando
  - hasExitCode
```
public boolean hasExitCode()
```
    Indica se o algoritmo provê um código de saída durante sua execução.
    
    Returns:
    
    Verdadeiro se o algoritmo provê o código de saída, ou falso, caso contrário.
  - setHasExitCode
```
public void setHasExitCode(boolean hasExitCode)
```
    Determina se o algoritmo provê um código de saída durante sua execução.
    
    Parameters:
    
    hasExitCode - Verdadeiro se o algoritmo provê o código de saída, ou falso, caso contrário.
  - getExitCodeLogFile
```
public FileURLValue getExitCodeLogFile()
```
    Retorna o arquivo que armazena o código de saída do algoritmo.
    
    Returns:
    
    o arquivo que armazena o código de saída.
  - getExitCodeLogFiles
```
public Set<FileURLValue> getExitCodeLogFiles()
```
    Retorna os arquivos que armazenam os códigos de saída dos algoritmos (são vários, no caso de fluxo).
    
    Returns:
    
    O conjunto de arquivos de código de saída.
  - setExitCodeLogFile
```
public void setExitCodeLogFile(FileURLValue exitCodeLogFile)
```
    Seta o arquivo que armazena o código de saída do algoritmo.
    
    Parameters:
    
    exitCodeLogFile - o arquivo que armazena o código de saída.
  - getWarningsFile
```
public FileURLValue getWarningsFile()
```
    Retorna o arquivo que armazena os alertas do algoritmo.
    
    Returns:
    
    o arquivo que armazena os alertas.
  - getWarningsFiles
```
public Set<FileURLValue> getWarningsFiles()
```
    Retorna os arquivos que armazenam os alertas dos algoritmos (são vários, no caso de fluxo).
    
    Returns:
    
    O conjunto de arquivos de alerta.
  - setWarningsFile
```
public void setWarningsFile(FileURLValue warningsFile)
```
    Atribui o arquivo que armazena os alertas do algoritmo.
    
    Parameters:
    
    warningsFile - o arquivo que armazena os alertas.
  - hasParameterThatRequiresPipe
```
public boolean hasParameterThatRequiresPipe()
```
    Retorna verdadeiro se algum dos parâmetros do algoritmo somente podem ser utilizados via pipe. Nesse caso, o algoritmo só pode ser executado como parte de um fluxo. Caso nenhum dos parâmetros tenha esse requisito, retorna falso.
    
    Returns:
    
    verdadeiro se algum parâmetro só pode ser utilizado através de pipe ou falso, caso contrário.
  - validate
```
public abstract Validation validate(ValidationContext context)
                             throws RemoteException
```
    Verifica se os valores armazenados no parâmetro são válidos.
    
    Parameters:
    
    context - contexto da validação.
    
    Returns:
    
    O resultado da validação.
    
    Throws:
    
    RemoteException - em caso de erro na comunicação com servidor.

Class AlgorithmConfigurator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILE_LIST_SEPARATOR

Constructor Detail

AlgorithmConfigurator

AlgorithmConfigurator

AlgorithmConfigurator

Method Detail

getConfiguratorType

getLogFiles

addAlgorithmConfiguratorListener

equals

exportValues

getAbbreviation

getAlgorithmName

getAlgorithmVersion

getAlgorithmVersionId

getBinaryDirectories

getBinaryDirectoriesAsArray

getCpuAmount

getLogFile

getLogFileParameter

getMemoryAmount

getCommandLinePattern

getRequirements

getDescription

getOutputDirectories

getInputDirectories

getExecutionType

getExecutionLocation

getFileParameters

getFilePath

getInputFileParameters

getInputFiles

getOutputFileParameters

getOutputFiles

getInputURLParameters

getInputURLs

getOutputURLParameters

getOutputURLs

getParameterLabel

getParameterNames

getParameterType

getParameterValue

getParameterValuesByName

getPlatforms

hashCode

importValues

isEnabled

isMultipleExecution

isSetDefaultValues

isSimpleExecution

getExitCodeCaptureCommand

makeCommandLine

makeCommandLineAsScript

provideId

resetValues

setDefaultInputFile

setEnabled

setLogFileParameterVisible

setParameterValue

setParameterValuesByName

updateAlgorithmVersion

toString

setStandardOutputFile

getStandardOutputFile

getStandardOutputFiles

getCurrentParameterFileVersion

fireParameterLabelWasChanged

fireParameterValueWasChanged

fireParameterWasSetEnabled

fireParameterWasSetVisible

fireWasSetEnabled

setExecutionType

setExecutionLocation