FlowAlgorithmConfigurator (csbase-common 3.4.1-RC2 API)

java.lang.Object
- csbase.logic.algorithms.AlgorithmConfigurator
- - csbase.logic.algorithms.flows.configurator.FlowAlgorithmConfigurator

All Implemented Interfaces:

Serializable
```
public final class FlowAlgorithmConfigurator
extends AlgorithmConfigurator
```
Configurador de Fluxo de Algoritmos:

Um fluxo de algoritmos é um multigrafo orientado cujos os vértices são os nós de algoritmo e as aretas são conexões entre parâmetro do tipo arquivo destes algoritmos.

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
`FlowAlgorithmConfigurator(AlgorithmVersionInfo algorithmVersion, Flow flow)` Cria um configurador.
`FlowAlgorithmConfigurator(Flow flow)` Cria um configurador.
`FlowAlgorithmConfigurator(String filePath, Flow flow)` Cria um configurador.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addLink(Node outputNode, LinkParameter outputLinkParameter, Node inputNode, LinkParameter inputLinkParameter)` Adiciona ligação ao nó de saída através dos parâmetros de entrada e saída especificados.
`protected boolean`	`addLinks(Map<Integer,Node> nodesMap, Flow flx)` Adiciona as ligações do fluxo nos nós que estão no mapa.
`protected void`	`addNodes(Map<Integer,Node> nodesMap, Flow flx)` Adiciona os nós do fluxo no mapa indexado por seus identificadores.
`protected void`	`addPendingLink(Map<Integer,Node> nodesMap, FlowLink pendingLink, FlowLink matchingLink)` Adiciona a ligação pendente, substituindo a ligação desviada correspondente.
`protected boolean`	`addPendingLinks(Map<Integer,Node> nodesMap, List<FlowLink> pendingLinks, List<FlowLink> bypassedLinks)` Adiciona ligações que ficaram pendentes, se for possível determinar sem ambiguidade como as ligações devem ser reconectadas de acordo com os desvios feitos no fluxo.
`protected boolean`	`areAllBypassedLinksMatched(Map<Integer,Node> nodesMap, List<FlowLink> bypassedLinks, Map<FlowLink,FlowLink> linkMatches)` Verifica se todas as ligações desviadas que deveriam ser consideradas foram tratadas.
`boolean`	`canBeExecuted()` Retorna se é possível executar o fluxo com a configuração atual (levando em consideracão possíveis desvios feitos no fluxo)
`boolean`	`canBeRunAsSimpleCommand()` Determina se o fluxo pode ser rodado como um comando simples.
`protected int`	`countBypassedLinks(List<FlowLink> bypassedLinks, Map<Integer,Node> nodesMap)` Conta o número de ligações desviadas que deveriam ser tratadas.
`protected Map<Integer,Node>`	`createNodesMap(Flow flx)` Extrai os nós `FlowNode` e ligações `FlowLink` de um fluxo `Flow` e o coloca num mapa de nós `Node` indexados pelos seus identificadores.
`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`	`getCommandDescription()` Obtém a descrição default do comando a ser gerado pelo algoritmo.
`protected String`	`getCurrentParameterFileVersion()` Obtém a versão atual do arquivo de parâmetros.
`Set<FileURLValue>`	`getExitCodeLogFiles()` Retorna os arquivos que armazenam os códigos de saída dos algoritmos (são vários, no caso de fluxo).
`Flow`	`getFlow()` Obtém a estrutura que descreve o fluxo.
`FileURLValue`	`getGuiltyNodeLog()` Retorna o arquivo de log que armazena o identificador do nó responsável por erro na execução do fluxo (se houver).
`Set<FileURLValue>`	`getInputDirectories()` Obtém o conjunto de diretórios de entrada.
`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.
`protected String`	`getInputParamType(FlowLink link)` Retorna o tipo do parâmetro de entrada da ligação especificada.
`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>`	`getLogFiles()` Obtém todos os arquivos de log.
`protected FlowLink`	`getMatchingLink(List<FlowLink> bypassedLinks, FlowLink pendingInputLink)` Procura a ligação desviada que corresponde à ligação pendente.
`protected List<FlowLink>`	`getMatchingLinksByName(FlowLink pendingLink, List<FlowLink> candidateLinks)` Retorna uma lista com todas as ligações desviadas correspondentes que têm o mesmo nome do parâmetro de entrada da ligação pendente especificada.
`protected List<FlowLink>`	`getMatchingLinksByType(FlowLink pendingLink, List<FlowLink> candidateLinks)` Retorna uma lista com todas as ligações desviadas correspondentes que têm o mesmo tipo da ligação pendente especificada (@see `getMatchingLinksByTypeRecursively(csbase.logic.algorithms.flows.FlowLink, csbase.logic.algorithms.flows.FlowLink, java.util.List<csbase.logic.algorithms.flows.FlowLink>)`).
`protected List<FlowLink>`	`getMatchingLinksByTypeRecursively(FlowLink pendingLink, FlowLink candidateLink, List<FlowLink> candidateLinks)` Procura recursivamente as ligações desviadas correspondentes que têm o mesmo tipo da ligação pendente especificada a partir de uma ligação candidata a ser a correspondente.
`String`	`getName()` Obtém o nome do fluxo.
`Node`	`getNode(int id)` Obtém um nó de algoritmo através do seu identificador.
`SimpleParameter<?>`	`getNodeParameter(String encodedParameterName)` Obtém um parâmetro simples dado o seu nome.
`Set<Node>`	`getNodes()` Obtém o conjunto de nós deste fluxo.
`Set<FileURLValue>`	`getOutputDirectories()` Obtém o conjunto de diretórios de saída.
`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<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 encodedParameterName)` Obtém o rótulo de um parâmetro dado o seu nome.
`Set<String>`	`getParameterNames()` Os nomes dos parâmetros são codificados utilizando com a seguinte gramática:
`String`	`getParameterType(String encodedParameterName)` Obtém o tipo de um parâmetro dado o seu nome.
`String`	`getParameterValue(String encodedParameterName)` 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.
`Set<String>`	`getRequirements()` Obtém os requisitos necessários ao algoritmo.
`Set<FileURLValue>`	`getStandardOutputFiles()` Obtém um conjunto imutável contendo os arquivos de saída padrão de cada nó que serão utilizadas durante a execução de um fluxo.
`Set<FileURLValue>`	`getWarningsFiles()` Retorna os arquivos que armazenam os alertas dos algoritmos (são vários, no caso de fluxo).
`protected Map<LinkParameter,List<FlowLink>>`	`groupPendingLinksByOutput(List<FlowLink> pendingLinks)` Agrupa as ligações pendentes pelo parâmetro de saída do nó ao qual elas estão conectadas.
`boolean`	`hasBypassedNodes()` Determina se o fluxo contém algum nó que está sendo desviado.
`boolean`	`hasExitCode()` Indica se o algoritmo provê um código de saída durante sua execução.
`void`	`importValues(Map<Object,Object> values)` Importa os valores dos parâmetros de um `Map`.
`protected boolean`	`isConfigured(Flow flx)` Determina se um fluxo está configurado (todos os algoritmos do fluxo têm configurador)
`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.
`CommandScript[]`	`makeCommandLineAsScript(CommandLineContext context)` Cria a linha de comando e a salva em um arquivo de script.
`protected String`	`makeEnvironmentVariablesDeclaration(FlowCommandLineContext context)` Cria a parte da linha de comando que declara as variáveis de ambiente utilizadas e disponibilizadas pelo comando.
`protected String`	`makeFlowCommandLine(FlowCommandLineContext context, Map<Integer,String> commands)` Gera a linha de comando do fluxo.
`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.
`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`	`setExitCodeLogFile(FileURLValue exitCodeLogFile)` Seta o arquivo que armazena o código de saída do algoritmo.
`void`	`setGuiltyNodeLog(FileURLValue guiltyNodeLog)` Atribui o arquivo de log que armazena o identificador do nó responsável por erro na execução do fluxo (se houver).
`void`	`setParameterValue(String encodedParameterName, String parameterValue)` Atribui o valor a um parâmetro.
`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()`
`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, getCommandLinePattern, getConfiguratorType, getCpuAmount, getDescription, getExecutionLocation, getExecutionType, getExitCodeCaptureCommand, getExitCodeLogFile, getFileParameters, getFilePath, getLogFile, getLogFileParameter, getMemoryAmount, getParameterValuesByName, getStandardOutputFile, getWarningsFile, hashCode, hasParameterThatRequiresPipe, isMultipleExecution, isSimpleExecution, provideId, setExecutionLocation, setExecutionType, setHasExitCode, setLogFileParameterVisible, setParameterValuesByName, updateAlgorithmVersion

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

- Constructor Detail
  - FlowAlgorithmConfigurator
```
public FlowAlgorithmConfigurator(AlgorithmVersionInfo algorithmVersion,
                                 Flow flow)
```
    Cria um configurador.
    
    Parameters:
    
    algorithmVersion - A versão do algoritmo (Não aceita null).
    
    flow - A estrutura que descreve o fluxo (Não aceita null).
  - FlowAlgorithmConfigurator
```
public FlowAlgorithmConfigurator(String filePath,
                                 Flow flow)
```
    Cria um configurador.
    
    Parameters:
    
    filePath - O caminho para o arquivo que descreve o fluxo (Não aceita null).
    
    flow - A estrutura que descreve o fluxo (Não aceita null).
  - FlowAlgorithmConfigurator
```
public FlowAlgorithmConfigurator(Flow flow)
```
    Cria um configurador.
    
    Parameters:
    
    flow - A estrutura que descreve o fluxo (Não aceita null).
- Method Detail
  - 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.
  - getRequirements
```
public Set<String> getRequirements()
```
    Obtém os requisitos necessários ao algoritmo.
    
    Overrides:
    
    getRequirements in class AlgorithmConfigurator
    
    Returns:
    
    .
  - 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.
  - 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.
  - 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.
  - 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.
  - getFlow
```
public Flow getFlow()
```
    Obtém a estrutura que descreve o fluxo.
    
    Returns:
    
    a estrutura que descreve o fluxo.
  - getGuiltyNodeLog
```
public FileURLValue getGuiltyNodeLog()
```
    Retorna o arquivo de log que armazena o identificador do nó responsável por erro na execução do fluxo (se houver).
    
    Returns:
    
    o arquivo de log.
  - setGuiltyNodeLog
```
public void setGuiltyNodeLog(FileURLValue guiltyNodeLog)
```
    Atribui o arquivo de log que armazena o identificador do nó responsável por erro na execução do fluxo (se houver).
    
    Parameters:
    
    guiltyNodeLog - o arquivo de log.
  - getLogFiles
```
public Set<FileURLValue> getLogFiles()
```
    Obtém todos os arquivos de log.
    
    O conjunto retornado é imutável (Collections.unmodifiableSet(Set)).
    
    Overrides:
    
    getLogFiles in class AlgorithmConfigurator
    
    Returns:
    
    o conjunto de arquivos de log (se não existir arquivo de log, retornará um conjunto vazio).
  - getName
```
public String getName()
```
    Obtém o nome do fluxo.
    
    Returns:
    
    O nome do fluxo ou null se ele não tiver um nome.
  - getNode
```
public Node getNode(int id)
```
    Obtém um nó de algoritmo através do seu identificador.
    
    Parameters:
    
    id - O identificador.
    
    Returns:
    
    O nó ou null se ele não existir.
  - getNodes
```
public Set<Node> getNodes()
```
    Obtém o conjunto de nós deste fluxo.
    
    O conjunto retornado é imutável (veja Collections.unmodifiableSet(Set)).
    
    Returns:
    
    O conjunto (Retorna um conjunto vazio se não houver nós).
  - hasBypassedNodes
```
public boolean hasBypassedNodes()
```
    Determina se o fluxo contém algum nó que está sendo desviado.
    
    Returns:
    
    verdadeiro se o fluxo contém pelo menos um nó desviado ou falso caso contrário.
  - 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.
  - 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 encodedParameterName)
                         throws ParameterNotFoundException
```
    Description copied from class: AlgorithmConfigurator
    
    Obtém o rótulo de um parâmetro dado o seu nome.
    
    Specified by:
    
    getParameterLabel in class AlgorithmConfigurator
    
    Parameters:
    
    encodedParameterName - Nome codificado do parâmetro. Para uma explicação sobre o nome codificado veja getParameterNames() .
    
    Returns:
    
    O rótulo.
    
    Throws:
    
    ParameterNotFoundException - Se não existir um parâmetro com o nome fornecido.
  - getParameterNames
```
public Set<String> getParameterNames()
```
    Os nomes dos parâmetros são codificados utilizando com a seguinte gramática:
```
 <nome_codificado> := <id_do_no><nome_codificado>
 ou
 <nome_codificado> := <nome_do_parametro>
 
```
    - nome_codificado é o nome do codificado do parâmetro.
    - id_do_no é o identificador do nó.
    - nome_do_parametro é o nome real do parâmetro.
    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 encodedParameterName)
                        throws ParameterNotFoundException
```
    Description copied from class: AlgorithmConfigurator
    
    Obtém o tipo de um parâmetro dado o seu nome.
    
    Specified by:
    
    getParameterType in class AlgorithmConfigurator
    
    Parameters:
    
    encodedParameterName - Nome codificado do parâmetro. Para uma explicação sobre o nome codificado veja getParameterNames() .
    
    Returns:
    
    O tipo.
    
    Throws:
    
    ParameterNotFoundException - Se não existir um parâmetro com o nome fornecido.
  - getParameterValue
```
public String getParameterValue(String encodedParameterName)
                         throws ParameterNotFoundException
```
    Description copied from class: AlgorithmConfigurator
    
    Obtém o valor de um parâmetro dado o seu nome.
    
    Specified by:
    
    getParameterValue in class AlgorithmConfigurator
    
    Parameters:
    
    encodedParameterName - Nome codificado do parâmetro. Para uma explicação sobre o nome codificado veja getParameterNames() .
    
    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.
  - importValues
```
public void importValues(Map<Object,Object> values)
                  throws ParseException
```
    Importa os valores dos parâmetros de um Map.
    
    Specified by:
    
    importValues in class AlgorithmConfigurator
    
    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 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.
  - makeCommandLineAsScript
```
public CommandScript[] makeCommandLineAsScript(CommandLineContext context)
```
    Cria a linha de comando e a salva em um arquivo de script.
    
    Overrides:
    
    makeCommandLineAsScript 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) para a execução do script.
  - canBeRunAsSimpleCommand
```
public boolean canBeRunAsSimpleCommand()
```
    Determina se o fluxo pode ser rodado como um comando simples. Para isso, o fluxo não pode ter mais de um nó. Fluxos sem nenhum nó também podem ser considerados como comandos simples (mesmo que não possam ser executados na prática).
    
    Returns:
    
    verdadeiro se o fluxo puder ser rodado como um comando simples ou falso, caso contrário.
  - 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(FlowCommandLineContext 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.
  - makeFlowCommandLine
```
protected String makeFlowCommandLine(FlowCommandLineContext context,
                                     Map<Integer,String> commands)
```
    Gera a linha de comando do fluxo. O comando gerado usa named-pipes para representar as conexões e permitir comunicar os dados entre os algoritmos. Ele também solicita a execução simultânea de todos os comandos gerados por cada um dos nós de algoritmos.
    
    Parameters:
    
    context - O contexto com informações para a geração da linha de comando.
    
    commands - A lista de comandos gerados por cada um dos nós de algoritmos.
    
    Returns:
    
    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.
  - getNodeParameter
```
public SimpleParameter<?> getNodeParameter(String encodedParameterName)
                                    throws ParameterNotFoundException
```
    Obtém um parâmetro simples dado o seu nome.
    
    Parameters:
    
    encodedParameterName - O nome do parâmetro codificado com id do nó (Não aceita null).
    
    Returns:
    
    O parâmetro ou null se o parâmetro não for encontrado.
    
    Throws:
    
    ParameterNotFoundException
  - setParameterValue
```
public void setParameterValue(String encodedParameterName,
                              String parameterValue)
                       throws ParameterNotFoundException,
                              ParseException
```
    Description copied from class: AlgorithmConfigurator
    
    Atribui o valor a um parâmetro.
    
    Specified by:
    
    setParameterValue in class AlgorithmConfigurator
    
    Parameters:
    
    encodedParameterName - Nome codificado do parâmetro. Para uma explicação sobre o nome codificado veja getParameterNames() .
    
    parameterValue - O valor do parâmetro (Aceita null)
    
    Throws:
    
    ParameterNotFoundException - Caso não exista um parâmetro com o nome fornecido.
    
    ParseException - Se pelo menos um dos valores não estiver em um formato que não pode ser aceito pelo seu parâmetro.
  - setWarningsFile
```
public void setWarningsFile(FileURLValue warningsFile)
```
    Atribui o arquivo que armazena os alertas do algoritmo.
    
    Overrides:
    
    setWarningsFile in class AlgorithmConfigurator
    
    Parameters:
    
    warningsFile - 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).
    
    Overrides:
    
    getWarningsFiles in class AlgorithmConfigurator
    
    Returns:
    
    O conjunto de arquivos de alerta.
  - 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.
    
    Este valor será repassado para todos os nós deste fluxo.
    
    Overrides:
    
    setStandardOutputFile in class AlgorithmConfigurator
    
    Parameters:
    
    standardOutputFile - o valor do arquivo que deve receber a saída padrão.
  - getStandardOutputFiles
```
public Set<FileURLValue> getStandardOutputFiles()
```
    Obtém um conjunto imutável contendo os arquivos de saída padrão de cada nó que serão utilizadas durante a execução de um fluxo.
    
    Overrides:
    
    getStandardOutputFiles in class AlgorithmConfigurator
    
    Returns:
    
    um conjunto imutável contendo os arquivos de saída padrão de cada nó que serão utilizadas durante a execução de um fluxo.
  - setExitCodeLogFile
```
public void setExitCodeLogFile(FileURLValue exitCodeLogFile)
```
    Seta o arquivo que armazena o código de saída do algoritmo.
    
    Overrides:
    
    setExitCodeLogFile in class AlgorithmConfigurator
    
    Parameters:
    
    exitCodeLogFile - 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).
    
    Overrides:
    
    getExitCodeLogFiles in class AlgorithmConfigurator
    
    Returns:
    
    O conjunto de arquivos de código de saída.
  - hasExitCode
```
public boolean hasExitCode()
```
    Indica se o algoritmo provê um código de saída durante sua execução.
    
    Overrides:
    
    hasExitCode in class AlgorithmConfigurator
    
    Returns:
    
    Verdadeiro se o algoritmo provê o código de saída, ou falso, caso contrário.
  - getCurrentParameterFileVersion
```
protected String getCurrentParameterFileVersion()
```
    Obtém a versão atual do arquivo de parâmetros.
    
    Specified by:
    
    getCurrentParameterFileVersion in class AlgorithmConfigurator
    
    Returns:
    
    .
  - setCommandDescription
```
public void setCommandDescription(String commandDescription)
```
    Estabelece a descrição default do comando a ser gerado pelo algoritmo.
    
    Overrides:
    
    setCommandDescription in class AlgorithmConfigurator
    
    Parameters:
    
    commandDescription - descrição do comando
  - getCommandDescription
```
public String getCommandDescription()
```
    Obtém a descrição default do comando a ser gerado pelo algoritmo.
    
    Overrides:
    
    getCommandDescription in class AlgorithmConfigurator
    
    Returns:
    
    a descrição default do comando
  - canBeExecuted
```
public boolean canBeExecuted()
```
    Retorna se é possível executar o fluxo com a configuração atual (levando em consideracão possíveis desvios feitos no fluxo)
    
    Returns:
    
    verdadeiro se for possível executar o fluxo com a configuração atual ou falso caso contrário
  - createNodesMap
```
protected Map<Integer,Node> createNodesMap(Flow flx)
```
    Extrai os nós FlowNode e ligações FlowLink de um fluxo Flow e o coloca num mapa de nós Node indexados pelos seus identificadores.
    
    Parameters:
    
    flx - Fluxo a ser utilizado para a criação do mapa.
    
    Returns:
    
    mapa com os nós (não desviados) do fluxo indexados por seus identificadores.
  - isConfigured
```
protected boolean isConfigured(Flow flx)
```
    Determina se um fluxo está configurado (todos os algoritmos do fluxo têm configurador)
    
    Parameters:
    
    flx - O fluxo que deve ser testado.
    
    Returns:
    
    verdadeiro se o fluxo estiver pronto para execução ou falso caso contrário.
  - addNodes
```
protected void addNodes(Map<Integer,Node> nodesMap,
                        Flow flx)
```
    Adiciona os nós do fluxo no mapa indexado por seus identificadores. Nós que estão sendo marcados como desviados não são adicionados porque não deverão ser executados.
    
    Parameters:
    
    nodesMap - mapa com os nós (não desviados) do fluxo indexados por seus identificadores.
    
    flx - O fluxo a ser utilizado.
  - addLinks
```
protected boolean addLinks(Map<Integer,Node> nodesMap,
                           Flow flx)
```
    Adiciona as ligações do fluxo nos nós que estão no mapa. Caso hajam nós desviados no fluxo, pode não ser possível determinar automaticamente como as ligações devem ser feitas nos nós restantes. Nesse caso, o método retorna falso. Se for possível determinar, sem ambiguidades, como as ligações devem ser feitas, o método retorna verdadeiro.
    
    Parameters:
    
    nodesMap - mapa com os nós (não desviados) do fluxo indexados por seus identificadores.
    
    flx - O fluxo a ser utilizado.
    
    Returns:
    
    verdadeiro se foi possível adicionar todos os links sem ambiguidade.
  - addLink
```
protected void addLink(Node outputNode,
                       LinkParameter outputLinkParameter,
                       Node inputNode,
                       LinkParameter inputLinkParameter)
```
    Adiciona ligação ao nó de saída através dos parâmetros de entrada e saída especificados.
    
    Parameters:
    
    outputNode - Nó ao qual será adicionado a ligação como saída.
    
    outputLinkParameter - Parâmetro de saída da ligação.
    
    inputNode - Nó ao qual será adicionado a ligação como entrada.
    
    inputLinkParameter - Parâmetro de entrada da ligação.
  - addPendingLinks
```
protected boolean addPendingLinks(Map<Integer,Node> nodesMap,
                                  List<FlowLink> pendingLinks,
                                  List<FlowLink> bypassedLinks)
```
    Adiciona ligações que ficaram pendentes, se for possível determinar sem ambiguidade como as ligações devem ser reconectadas de acordo com os desvios feitos no fluxo. Para cada ligação pendente é procurada uma única ligação desviada que ela vai substituir. Se não for possível encontrar nenhuma ligação equivalente ou existirem diversas ligações que podem ser equivalentes, o fluxo não poderá ser executado com a configuração atual. O usuário deve fazer o desvio manualmente ou refazer os desvios para que não gerem ambiguidades.
    
    Parameters:
    
    nodesMap - mapa com os nós (não desviados) do fluxo indexados por seus identificadores.
    
    pendingLinks - ligações que devem ser refeitas.
    
    bypassedLinks - ligações que devem ser ignoradas pelo fluxo.
    
    Returns:
    
    verdadeiro se for possível refazer as ligações sem ambiguidade ou falso caso contrário.
  - areAllBypassedLinksMatched
```
protected boolean areAllBypassedLinksMatched(Map<Integer,Node> nodesMap,
                                             List<FlowLink> bypassedLinks,
                                             Map<FlowLink,FlowLink> linkMatches)
```
    Verifica se todas as ligações desviadas que deveriam ser consideradas foram tratadas. @see countBypassedLinks(List, Map)
    
    Parameters:
    
    nodesMap - mapa com os nós (não desviados) do fluxo indexados por seus identificadores.
    
    bypassedLinks - Lista de ligações que foram desviadas.
    
    linkMatches - Mapa com as ligações pendentes e as ligações desviadas correspondentes.
    
    Returns:
    
    verdadeiro se todas as ligações desviadas que deveriam ser consideradas foram tratadas ou falso caso contrário.
  - countBypassedLinks
```
protected int countBypassedLinks(List<FlowLink> bypassedLinks,
                                 Map<Integer,Node> nodesMap)
```
    Conta o número de ligações desviadas que deveriam ser tratadas. As ligações que conectam dois nós desviados são descartas e ignoradas durante a execução. Já as ligações que só a entrada ou a saída estão conectadas a um nó desviado são contadas e devem ser tratadas. Cada ligação dessa deve corresponder a pelo menos uma ligação pendente.
    
    Parameters:
    
    bypassedLinks - Lista de ligações que foram desviadas.
    
    nodesMap - mapa com os nós (não desviados) do fluxo indexados por seus identificadores.
    
    Returns:
    
    número de ligações desviadas que devem ser tratadas.
  - addPendingLink
```
protected void addPendingLink(Map<Integer,Node> nodesMap,
                              FlowLink pendingLink,
                              FlowLink matchingLink)
```
    Adiciona a ligação pendente, substituindo a ligação desviada correspondente.
    
    Parameters:
    
    nodesMap - mapa com os nós (não desviados) do fluxo indexados por seus identificadores.
    
    pendingLink - Ligação pendente.
    
    matchingLink - Ligação desviada correspondente.
  - groupPendingLinksByOutput
```
protected Map<LinkParameter,List<FlowLink>> groupPendingLinksByOutput(List<FlowLink> pendingLinks)
```
    Agrupa as ligações pendentes pelo parâmetro de saída do nó ao qual elas estão conectadas.
    
    Parameters:
    
    pendingLinks - Lista de ligações pendentes.
    
    Returns:
    
    mapa com as ligações pendentes agrupadas pelo parâmetro de saída do nó ao qual estão conectadas.
  - getMatchingLink
```
protected FlowLink getMatchingLink(List<FlowLink> bypassedLinks,
                                   FlowLink pendingInputLink)
```
    Procura a ligação desviada que corresponde à ligação pendente. Retorna nulo se não encontrar nenhuma ligação correspondente ou encontrar mais de uma ligação correspondente (gerando ambiguidade).
    
    Parameters:
    
    bypassedLinks - Lista de ligações desviadas.
    
    pendingInputLink - Ligação pendente.
    
    Returns:
    
    a ligação desviada que corresponde à ligação pendente ou nulo se não for possível encontrar uma única correspondente
  - getMatchingLinksByType
```
protected List<FlowLink> getMatchingLinksByType(FlowLink pendingLink,
                                                List<FlowLink> candidateLinks)
```
    Retorna uma lista com todas as ligações desviadas correspondentes que têm o mesmo tipo da ligação pendente especificada (@see getMatchingLinksByTypeRecursively(csbase.logic.algorithms.flows.FlowLink, csbase.logic.algorithms.flows.FlowLink, java.util.List<csbase.logic.algorithms.flows.FlowLink>)). Retorna nulo se não encontrar nenhuma ligação correspondente com o tipo em questão.
    
    Parameters:
    
    pendingLink - Ligação pendente
    
    candidateLinks - Lista de ligações desviadas que têm o mesmo tipo da ligação pendente
    
    Returns:
    
    lista com as ligações correspondentes do tipo especificado ou nulo se não for possível encontrar nenhuma ligação desviada correspondente do tipo especificado.
  - getMatchingLinksByTypeRecursively
```
protected List<FlowLink> getMatchingLinksByTypeRecursively(FlowLink pendingLink,
                                                           FlowLink candidateLink,
                                                           List<FlowLink> candidateLinks)
```
    Procura recursivamente as ligações desviadas correspondentes que têm o mesmo tipo da ligação pendente especificada a partir de uma ligação candidata a ser a correspondente. Caso a ligação candidata esteja conectada a saída de um nó desviado, o método é chamado recursivamente para as ligações de entrada deste nó. Quando a ligação candidata está ligada a um nó que não foi desviado e tem o tipo correto, a ligação é considerada correspondente.
    
    Parameters:
    
    pendingLink - Ligação pendente
    
    candidateLink - Ligação candidata
    
    candidateLinks - Lista de ligações desviadas candidatas
    
    Returns:
    
    a lista de ligações desviadas consideradas correspondentes
  - getMatchingLinksByName
```
protected List<FlowLink> getMatchingLinksByName(FlowLink pendingLink,
                                                List<FlowLink> candidateLinks)
```
    Retorna uma lista com todas as ligações desviadas correspondentes que têm o mesmo nome do parâmetro de entrada da ligação pendente especificada. Retorna nulo se não encontrar nenhuma ligação correspondente com o nome em questão.
    
    Parameters:
    
    pendingLink - Ligação pendente
    
    candidateLinks - Lista de ligações desviadas candidatas
    
    Returns:
    
    lista com as ligações desviadas correspondentes que têm o mesmo nome do parâmetro de entrada da ligação pendente especificada.
  - getInputParamType
```
protected String getInputParamType(FlowLink link)
```
    Retorna o tipo do parâmetro de entrada da ligação especificada.
    
    Parameters:
    
    link - A ligação especificada.
    
    Returns:
    
    o tipo do parâmetro de entrada da ligação especificada.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AlgorithmConfigurator
  - 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.

Class FlowAlgorithmConfigurator

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

FlowAlgorithmConfigurator

FlowAlgorithmConfigurator

FlowAlgorithmConfigurator

Method Detail

exportValues

getRequirements

getBinaryDirectoriesAsArray

getBinaryDirectories

getInputDirectories

getOutputDirectories

getInputFileParameters

getInputFiles

getInputURLParameters

getInputURLs

getFlow

getGuiltyNodeLog

setGuiltyNodeLog

getLogFiles

getName

getNode

getNodes

hasBypassedNodes

getOutputFileParameters

getOutputFiles

getOutputURLParameters

getOutputURLs

getParameterLabel

getParameterNames

getParameterType

getParameterValue

getPlatforms

importValues

isEnabled

isSetDefaultValues

makeCommandLineAsScript

canBeRunAsSimpleCommand

makeCommandLine

makeEnvironmentVariablesDeclaration

makeFlowCommandLine

resetValues

setDefaultInputFile

setEnabled

getNodeParameter

setParameterValue

setWarningsFile

getWarningsFiles

setStandardOutputFile

getStandardOutputFiles

setExitCodeLogFile

getExitCodeLogFiles

hasExitCode

getCurrentParameterFileVersion

setCommandDescription

getCommandDescription

canBeExecuted

createNodesMap

isConfigured

addNodes

addLinks

addLink

addPendingLinks

areAllBypassedLinksMatched

countBypassedLinks

addPendingLink

groupPendingLinksByOutput

getMatchingLink

getMatchingLinksByType

getMatchingLinksByTypeRecursively

getMatchingLinksByName

getInputParamType