csbase.logic.algorithms

Class AlgorithmVersionInfo

java.lang.Object

csbase.logic.algorithms.AlgorithmVersionInfo

All Implemented Interfaces:

Serializable, Comparable<AlgorithmVersionInfo>

public final class AlgorithmVersionInfo
extends Object
implements Comparable<AlgorithmVersionInfo>, Serializable

Representa os dados de uma versão de algoritmo no SSI.

Author:

clinio

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIN_DIR Nome do diretório que contém os executáveis para as plataformas (contido no diretório de uma versão).
static String	CONFIG_FILE Nome do arquivo que define o configurador de algoritmos.
static String	CONFIG_PROPERTIES_FILE Nome do arquivo de configuração de uma versão de um algoritmo.
static String	CONFIGURATOR_DIR Nome do subdiretório/subpacote (dentro do diretório de uma versão)
static String	DOCUMENTATION_DIR Nome do pacote (default) aonde se busca a documentação do algoritmo.
static String	FLOW_CONFIG_FILE Nome do arquivo que define o configurador de fluxos de algoritmo.
static String	HTML_FILE Nome do arquivo de ajuda.
static String	PARAMETERS_PROPERTIES_FILE Nome do arquivo de configuração de parâmetros de uma versão de um algoritmo.
static String	PROPERTY_VALUES_FILE Nome do arquivo de informacoes do algoritmo.

Constructor Summary

Constructors

Constructor and Description
AlgorithmVersionInfo(AlgorithmInfo algorithmInfo, AlgorithmVersionId id, Map<String,List<FileInfo>> supportedPlatforms, Map<String,String> propertyValues, AlgorithmConfigurator.ConfiguratorType type) Construtor da representação da versão de um algoritmo.
AlgorithmVersionInfo(AlgorithmInfo algorithmInfo, String versionDirName, Map<String,List<FileInfo>> supportedPlatforms, Map<String,String> propertyValues, AlgorithmConfigurator.ConfiguratorType type) Construtor da representação da versão de um algoritmo.
AlgorithmVersionInfo(AlgorithmVersionId id, String description, Map<String,String> propertyValues, AlgorithmConfigurator.ConfiguratorType type) Constrói as informações da versão de um algoritmo durante o processo de leitura das versões em um pacote de algoritmos.

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfigurator(FileInfo file) Adiciona um arquivo de configuração da versão.
void	addDocumentation(FileInfo file) Adiciona um arquivo de documentação da versão.
int	compareTo(AlgorithmVersionInfo o)
boolean	equals(Object obj)
String	getBinDirName() Consulta ao nome do diretório de executáveis para as plataformas.
String	getConfiguratorDirName() Consulta ao nome do sub-pacote do configurador.
String	getConfiguratorDirPath() Obtém o caminho para o diretório de configuração da versão.
String	getConfiguratorPath() Obtém o caminho para o arquivo de configuração da versão.
List<FileInfo>	getConfigurators() Obtém os arquivos de configuração da versão.
String	getDescription() Obtém a descrição da versão do algoritmo.
String	getDirectory() Obtém o subdiretório da versão.
static String	getDirectoryFor(int major, int minor, int patch) Obtem o nome do diretório de uma versão partir de seus números.
String	getDirPath() Obtem o diretorio completo para a versao (repositorio+algoritmo+versao)
String	getDocDirPath() Obtém o caminho para o diretório de documentação da versão.
List<FileInfo>	getDocumentation() Obtém os arquivos de documentação da versão.
String	getDocumentationDirName() Consulta ao nome do sub-pacote da documentação.
String	getExecFilePath(String platform, String exec) Obtém o caminho para o executável de uma plataforma da versão.
String	getExecutableDirPath() Obtém o caminho para o diretório de executáveis da versão.
List<FileInfo>	getExecutables(String platform) Obtém os arquivos executáveis de uma plataforma da versão.
String	getFlowConfiguratorPath() Obtém o caminho para o arquivo de configuração do fluxo.
AlgorithmVersionId	getId() Obtém o identificador.
static Object	getIdFor(int major, int minor, int patch) Obtem um identificador de versão a partir de seus números.
static Object	getIdFromDirectory(String dirName) Obtém o identificador da versão do algoritmo associando ao diretório fornecido.
AlgorithmInfo	getInfo() Obtém as informações sobre o algoritmo.
String	getPackageName() Consulta ao nome do pacote do algoritmo e versão.
String	getPlatformPath(String platform) Obtém o caminho para o diretório da plataforma de execução da versão.
Map<String,List<FileInfo>>	getPlatforms() Obtém as plataformas suportadas com os executaveis.
Set<String>	getPlatformsNames() Obtém os nomes das plataformas suportadas.
String	getPropertiesPath() Obtém o caminho para o arquivo de propriedades da versão.
Map<String,String>	getPropertyValues() Retorna uma lista com os valores dos atributos estendidos do algoritmo
Vector<String>	getSupportedPlatforms() Obtém as plataformas suportadas.
AlgorithmConfigurator.ConfiguratorType	getType() Obtém o tipo da versão.
String	getVersionsDirName() Consulta ao nome do sub-pacote de versões.
int	hashCode()
void	removeConfigurator(FileInfo file) Remove o arquivo de configuração da versão.
void	removeDocumentation(FileInfo file) Remove o arquivo de documentação da versão.
boolean	removeExecutable(String platform, FileInfo executable) Remove o executável de uma plataforma da versão.
void	setConfigurators(List<FileInfo> configurators) Atribui os arquivos de configuração da versão.
void	setDescription(String description) Atribui uma descrição para essa versão do algoritmo.
void	setDocumentation(List<FileInfo> documentation) Atribui os arquivos de documentação da versão.
void	setPlatform(String platform) Adiciona nova plataforma de executáveis da versão.
void	setPlatformExecutables(String platform, List<FileInfo> execs) Coloca os executaveis de uma plataforma.
void	setPlatforms(Hashtable<String,List<FileInfo>> platforms) Atribui as plataformas dos executáveis da versão.
void	setPropertyValues(Hashtable<String,String> propertyValues) Modifica o valor dos atributos estendidos.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

BIN_DIR

public static String BIN_DIR

Nome do diretório que contém os executáveis para as plataformas (contido no diretório de uma versão).

CONFIGURATOR_DIR

public static final String CONFIGURATOR_DIR

Nome do subdiretório/subpacote (dentro do diretório de uma versão)

See Also:

Constant Field Values

DOCUMENTATION_DIR

public static final String DOCUMENTATION_DIR

Nome do pacote (default) aonde se busca a documentação do algoritmo.

See Also:

Constant Field Values

HTML_FILE

public static final String HTML_FILE

Nome do arquivo de ajuda.

See Also:

Constant Field Values

CONFIG_FILE

public static final String CONFIG_FILE

Nome do arquivo que define o configurador de algoritmos.

See Also:

Constant Field Values

CONFIG_PROPERTIES_FILE

public static final String CONFIG_PROPERTIES_FILE

Nome do arquivo de configuração de uma versão de um algoritmo.

See Also:

Constant Field Values

PARAMETERS_PROPERTIES_FILE

public static final String PARAMETERS_PROPERTIES_FILE

Nome do arquivo de configuração de parâmetros de uma versão de um algoritmo.

See Also:

Constant Field Values

FLOW_CONFIG_FILE

public static final String FLOW_CONFIG_FILE

Nome do arquivo que define o configurador de fluxos de algoritmo.

See Also:

Constant Field Values

PROPERTY_VALUES_FILE

public static final String PROPERTY_VALUES_FILE

Nome do arquivo de informacoes do algoritmo. Contem os VALORES atribuidos a cada um dos atributos estendidos de uma dada instancia do algoritmo.

See Also:

Constant Field Values

Constructor Detail

AlgorithmVersionInfo

public AlgorithmVersionInfo(AlgorithmInfo algorithmInfo,
                    AlgorithmVersionId id,
                    Map<String,List<FileInfo>> supportedPlatforms,
                    Map<String,String> propertyValues,
                    AlgorithmConfigurator.ConfiguratorType type)

Construtor da representação da versão de um algoritmo. Utilizado para criar uma nova versao no servico. Recebe a lista de atributos estendidos.

Parameters:

algorithmInfo - Informações sobre o algoritmo.

id - identificação da versão

supportedPlatforms - Plataformas suportadas.

propertyValues - Mapa de valores para os atributos estendidos.

AlgorithmVersionInfo

public AlgorithmVersionInfo(AlgorithmInfo algorithmInfo,
                    String versionDirName,
                    Map<String,List<FileInfo>> supportedPlatforms,
                    Map<String,String> propertyValues,
                    AlgorithmConfigurator.ConfiguratorType type)

Construtor da representação da versão de um algoritmo. Utilizado para incluir uma versao no algoritmo (carrega atributos estendidos do arquivo de propriedades)

Parameters:

algorithmInfo - Informações sobre o algoritmo.

versionDirName - O node do diretório da versão.

supportedPlatforms - Plataformas suportadas.

propertyValues - Mapa de valores para os atributos estendidos

type - tipo da versão (simples ou fluxo).

AlgorithmVersionInfo

public AlgorithmVersionInfo(AlgorithmVersionId id,
                    String description,
                    Map<String,String> propertyValues,
                    AlgorithmConfigurator.ConfiguratorType type)

Constrói as informações da versão de um algoritmo durante o processo de leitura das versões em um pacote de algoritmos.

Parameters:

id - identificador de uma versão do algoritmo

description - descrição do algoritmo

propertyValues - valores das propriedades

type - tipo da versão (simples ou fluxo).

Method Detail

getDirectoryFor

public static String getDirectoryFor(int major,
                     int minor,
                     int patch)

Obtem o nome do diretório de uma versão partir de seus números.

Parameters:

major - numero da versão

minor - numero da revisão

patch - numero da correção

Returns:

o identificador como uma String

getIdFromDirectory

public static Object getIdFromDirectory(String dirName)

Obtém o identificador da versão do algoritmo associando ao diretório fornecido.

Parameters:

dirName - O nome do diretório.

Returns:

O identificador da versão do algoritmo.

getIdFor

public static Object getIdFor(int major,
              int minor,
              int patch)

Obtem um identificador de versão a partir de seus números.

Parameters:

major - numero da versão

minor - numero da revisão

patch - numero da correção

Returns:

o identificador da versão

compareTo

public int compareTo(AlgorithmVersionInfo o)

Specified by:

compareTo in interface Comparable<AlgorithmVersionInfo>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getInfo

public AlgorithmInfo getInfo()

Obtém as informações sobre o algoritmo.

Returns:

As informações sobre o algoritmo.

setDocumentation

public void setDocumentation(List<FileInfo> documentation)

Atribui os arquivos de documentação da versão.

Parameters:

documentation - Lista de arquivos de documentação.

removeDocumentation

public void removeDocumentation(FileInfo file)

Remove o arquivo de documentação da versão.

Parameters:

file - O arquivo a ser removido.

addDocumentation

public void addDocumentation(FileInfo file)

Adiciona um arquivo de documentação da versão.

Parameters:

file - Arquivo a ser adicionado.

getDocumentation

public List<FileInfo> getDocumentation()

Obtém os arquivos de documentação da versão.

Returns:

Lista de arquivos de documentação.

setConfigurators

public void setConfigurators(List<FileInfo> configurators)

Atribui os arquivos de configuração da versão.

Parameters:

configurators - A lista de arquivos de configuração.

removeConfigurator

public void removeConfigurator(FileInfo file)

Remove o arquivo de configuração da versão.

Parameters:

file - O arquivo a ser removido.

addConfigurator

public void addConfigurator(FileInfo file)

Adiciona um arquivo de configuração da versão.

Parameters:

file - Arquivo a ser adicionado.

getConfigurators

public List<FileInfo> getConfigurators()

Obtém os arquivos de configuração da versão.

Returns:

Lista de arquivos de documentação.

getBinDirName

public String getBinDirName()

Consulta ao nome do diretório de executáveis para as plataformas.

Returns:

o nome do diretório

getConfiguratorDirName

public String getConfiguratorDirName()

Consulta ao nome do sub-pacote do configurador.

Returns:

o nome do sub-pacote como uma string.

getDocumentationDirName

public String getDocumentationDirName()

Consulta ao nome do sub-pacote da documentação.

Returns:

o nome do sub-pacote como uma string.

getDirectory

public String getDirectory()

Obtém o subdiretório da versão. Nao inclui o caminho ate ele!

Returns:

o nome do subdiretório desejado

getId

public AlgorithmVersionId getId()

Obtém o identificador.

Returns:

a identificação

getPackageName

public String getPackageName()

Consulta ao nome do pacote do algoritmo e versão.

Returns:

o nome do pacote como uma string.

getSupportedPlatforms

public Vector<String> getSupportedPlatforms()

Obtém as plataformas suportadas.

Returns:

vetor contendo os identificadores das plataformas

getPlatforms

public Map<String,List<FileInfo>> getPlatforms()

Obtém as plataformas suportadas com os executaveis.

Returns:

Hashtable com as plataformas e os executaveis correspondentes.

getPlatformsNames

public Set<String> getPlatformsNames()

Obtém os nomes das plataformas suportadas.

Returns:

Lista com as plataformas.

getExecutables

public List<FileInfo> getExecutables(String platform)

Obtém os arquivos executáveis de uma plataforma da versão.

Parameters:

platform - Plataforma dos executáveis.

Returns:

Lista de arquivos executáveis.

setPlatformExecutables

public void setPlatformExecutables(String platform,
                          List<FileInfo> execs)

Coloca os executaveis de uma plataforma.

Parameters:

platform - .

execs - .

setPlatforms

public void setPlatforms(Hashtable<String,List<FileInfo>> platforms)

Atribui as plataformas dos executáveis da versão.

Parameters:

platforms - Lista de plataformas da versão, mapeadas pelo nome.

setPlatform

public void setPlatform(String platform)

Adiciona nova plataforma de executáveis da versão.

Parameters:

platform - Platafroma de executáveis.

getVersionsDirName

public String getVersionsDirName()

Consulta ao nome do sub-pacote de versões.

Returns:

o nome do sub-pacote como uma string.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

removeExecutable

public boolean removeExecutable(String platform,
                       FileInfo executable)

Remove o executável de uma plataforma da versão.

Parameters:

platform - Plataforma do executável.

executable - Arquico executável.

Returns:

Verdadeiro se o executável foi removido ou falso, caso contrário.

getDirPath

public String getDirPath()

Obtem o diretorio completo para a versao (repositorio+algoritmo+versao)

Returns:

caminho para a versao

getConfiguratorDirPath

public String getConfiguratorDirPath()

Obtém o caminho para o diretório de configuração da versão.

Returns:

O caminho para o diretório de configuração.

getExecutableDirPath

public String getExecutableDirPath()

Obtém o caminho para o diretório de executáveis da versão.

Returns:

O caminho para o diretório de executáveis.

getConfiguratorPath

public String getConfiguratorPath()

Obtém o caminho para o arquivo de configuração da versão.

Returns:

O caminho para o arquivo de configuração.

getFlowConfiguratorPath

public String getFlowConfiguratorPath()

Obtém o caminho para o arquivo de configuração do fluxo.

Returns:

O caminho para o arquivo do fluxo.

getPropertiesPath

public String getPropertiesPath()

Obtém o caminho para o arquivo de propriedades da versão.

Returns:

O caminho para o arquivo de propriedades.

getDocDirPath

public String getDocDirPath()

Obtém o caminho para o diretório de documentação da versão.

Returns:

O caminho para o diretório de documentação.

getPlatformPath

public String getPlatformPath(String platform)

Obtém o caminho para o diretório da plataforma de execução da versão.

Parameters:

platform - Plataforma de execução.

Returns:

O caminho para o diretório da plataforma de execução.

getExecFilePath

public String getExecFilePath(String platform,
                     String exec)

Obtém o caminho para o executável de uma plataforma da versão.

Parameters:

platform - Plataforma do executável.

exec - Nome do executável.

Returns:

O caminho para o executável de uma plataforma.

getPropertyValues

public Map<String,String> getPropertyValues()

Retorna uma lista com os valores dos atributos estendidos do algoritmo

Returns:

vector com os valores dos atributos estendidos do algoritmo

setPropertyValues

public void setPropertyValues(Hashtable<String,String> propertyValues)

Modifica o valor dos atributos estendidos. O método garante a persistencia da modificacao.

Parameters:

propertyValues - vector com os novos valores dos atributos

setDescription

public void setDescription(String description)

Atribui uma descrição para essa versão do algoritmo.

Parameters:

description - descrição da versão do algoritmo

getDescription

public String getDescription()

Obtém a descrição da versão do algoritmo.

Returns:

description a descrição da versão do algoritmo

getType

public AlgorithmConfigurator.ConfiguratorType getType()

Obtém o tipo da versão.

Returns:

o tipo.