csbase.logic.algorithms

Class AlgorithmInfo

java.lang.Object

csbase.logic.algorithms.AlgorithmInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AlgorithmInfo>

public class AlgorithmInfo
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<AlgorithmInfo>

Representa os dados de um algoritmo para ser mostrado no cliente.

Version:

$Revision: 172547 $

Author:

clinio

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HIDE_ALGORITHM_PROPERTY Chave da propriedade que determina se o algoritmo deve ser exibido
static java.lang.String	HIDE_ALGORITHM_VALUE Valor da propriedade que determina se o algoritmo deve ser exibido
static int	MAX_NAME_SIZE Tamanho máximo do nome de um algoritmo.
static java.lang.String	OWNER_ALGORITHM_PROPERTY Chave da propriedade que determina o usuário (login) que criou o algoritmo
static java.lang.String	PROPERTY_VALUES_FILE Nome do arquivo de informacoes do algoritmo.
static java.lang.String	VERSIONS_DIR Nome do subdiretório de versões (dentro do diretório de um algoritmo).

Constructor Summary

Constructors

Constructor and Description
AlgorithmInfo(AlgorithmInfo algorithmInfo) Constrói um algoritmo a partir de um algoritmo base.
AlgorithmInfo(java.lang.String id, java.lang.String name, java.lang.String dir, java.lang.String algorithmRepositoryPath, java.util.Hashtable<java.lang.String,java.lang.String> propertyValues) Construtor de um AlgorithmInfo.
AlgorithmInfo(java.lang.String id, java.lang.String name, java.lang.String dir, java.lang.String algorithmRepositoryPath, java.util.Hashtable<java.lang.String,java.lang.String> propertyValues, java.util.Hashtable<AlgorithmVersionId,AlgorithmVersionInfo> versions) Construtor de um AlgorithmInfo.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addObserver(java.util.Observer o) Adiciona um observador local da classe.
int	compareTo(AlgorithmInfo o) (non-Javadoc)
static void	deleteObserver(java.util.Observer o) Remove um observador local da classe.
protected void	deleteVersion(java.lang.Object versionId) Remove uma versão
boolean	equals(java.lang.Object object) (non-Javadoc)
java.util.List<java.lang.String>	getAlgoPackCategoryFullNames() Retorna os nomes completos das categorias em que o algoritmo do Pacote de Algoritmos faz parte.
static AlgorithmInfo	getAlgorithmInfo(java.lang.Object id) Solicita ao servico de algoritmos um algoritmo que possui determinada identificacao.
static AlgorithmInfo	getAlgorithmInfo(java.lang.String name) Solicita ao servico de algoritmos um algoritmo que possui determinada identificacao.
java.lang.String	getAlgorithmRepositoryPath() Obtém o caminho para o repositório de algoritmos.
protected java.util.Hashtable<AlgorithmVersionId,AlgorithmVersionInfo>	getAllVersionInfo() Obtem as informações de todas as versões de um algoritmo.
java.lang.String	getDescription() Obtém a descrição do algoritmo.
java.lang.String	getDirectory() Obtém o nome do diretório do algoritmo.
java.lang.String	getId() Obtém o identificador.
AlgorithmVersionInfo	getLastVersion() Obtém a última versão deste algoritmo.
java.lang.String	getName() Obtém o nome do algoritmo.
AlgorithmOutline	getOutline() Obtém um resumo do algoritmo.
java.lang.String	getOwner() Obtém o valor da propriedade que indica o usuário (login) que criou esse algoritmo.
java.lang.String	getPropertyValue(java.lang.String propertyName) Retorna o valor associado a um determinado atributo estendido, como por exemplo, o nome do analista responsavel.
java.util.Hashtable<java.lang.String,java.lang.String>	getPropertyValues() Retorna uma lista com os valores dos atributos estendidos do algoritmo
java.lang.Object[]	getVersionIds() Obtenção dos identificadores de versão do algoritmo.
AlgorithmVersionInfo	getVersionInfo(java.lang.Object versionId) Obtem as informações de uma versão.
java.util.Vector<AlgorithmVersionInfo>	getVersions() Obtém as versões deste algoritmo.
java.lang.String	getVersionsDirName() Consulta ao nome do sub-pacote de versões.
int	hashCode() (non-Javadoc)
protected void	includeVersion(AlgorithmVersionId versionId, AlgorithmVersionInfo vInfo) Inclui uma versão
protected void	rename(java.lang.String newName) Atribui um novo nome ao algoritmo.
void	setAlgoPackCategoryFullNames(java.util.List<java.lang.String> categoryFullNames) Estabelece os nomes completos das categorias em que o algoritmo do Pacote de Algoritmos faz parte.
void	setDescription(java.lang.String description) Atribui uma descrição para o algoritmo.
void	setPropertyValues(java.util.Hashtable<java.lang.String,java.lang.String> atributeValues) Modifica o valor dos atributos estendidos.
java.lang.String	toString() (non-Javadoc)
static void	update(AlgoEvent event) Esse método é chamado quando o serviço de algoritmos sofre alguma alteração relativa a do algo.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_NAME_SIZE

public static final int MAX_NAME_SIZE

Tamanho máximo do nome de um algoritmo.

See Also:

Constant Field Values

VERSIONS_DIR

public static final java.lang.String VERSIONS_DIR

Nome do subdiretório de versões (dentro do diretório de um algoritmo). Usado para localizar as versões de um algoritmos e para compor o nome do pacote que contém o configurador de uma versão de algoritmo (Configurator).

See Also:

Constant Field Values

PROPERTY_VALUES_FILE

public static final java.lang.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

HIDE_ALGORITHM_PROPERTY

public static final java.lang.String HIDE_ALGORITHM_PROPERTY

Chave da propriedade que determina se o algoritmo deve ser exibido

See Also:

Constant Field Values

HIDE_ALGORITHM_VALUE

public static final java.lang.String HIDE_ALGORITHM_VALUE

Valor da propriedade que determina se o algoritmo deve ser exibido

See Also:

Constant Field Values

OWNER_ALGORITHM_PROPERTY

public static final java.lang.String OWNER_ALGORITHM_PROPERTY

Chave da propriedade que determina o usuário (login) que criou o algoritmo

See Also:

Constant Field Values

Constructor Detail

AlgorithmInfo

public AlgorithmInfo(java.lang.String id,
             java.lang.String name,
             java.lang.String dir,
             java.lang.String algorithmRepositoryPath,
             java.util.Hashtable<java.lang.String,java.lang.String> propertyValues)

Construtor de um AlgorithmInfo. Deve ser utilizado para a criacao e inlcusao de um algoritmo. A classe é criada com propriedades estendidas e sem informcao das versoes e, por isso, ela irá salvar a informacao de atributo no arquivo de propriedades.

Parameters:

id - id do algoritmo

name - nome do algoritmo

dir - diretório do algoritmo

algorithmRepositoryPath - caminho para o repositório de algoritmos.

propertyValues - Vector com os valores dos atributos estendidos

AlgorithmInfo

public AlgorithmInfo(java.lang.String id,
             java.lang.String name,
             java.lang.String dir,
             java.lang.String algorithmRepositoryPath,
             java.util.Hashtable<java.lang.String,java.lang.String> propertyValues,
             java.util.Hashtable<AlgorithmVersionId,AlgorithmVersionInfo> versions)

Construtor de um AlgorithmInfo. Deve ser utilizado para a transoformacao de um ModifiableAlgorithmInfo em um AlgorithmInfo. A classe é criada com propriedades estendidas e com informcao das versoes. Porem, como nao esta havendo modificacao nos atributos estendidos, esse construtor nao manipula o arquivo de propriedades.

Parameters:

id - id do algoritmo

name - nome do algoritmo

dir - diretório do algoritmo

algorithmRepositoryPath - caminho para o repositório de algoritmos.

propertyValues - vector com os valores dos atributos estendidos

versions - versoes do algoritmo

AlgorithmInfo

public AlgorithmInfo(AlgorithmInfo algorithmInfo)

Constrói um algoritmo a partir de um algoritmo base.

Parameters:

algorithmInfo - algoritmo base

Method Detail

addObserver

public static void addObserver(java.util.Observer o)

Adiciona um observador local da classe. Sempre que a classe é avisada pelo serviço de algoritmos de que alguma mudança ocorreu, os observadores locais também são notificados.

Parameters:

o - um observador local

deleteObserver

public static void deleteObserver(java.util.Observer o)

Remove um observador local da classe.

Parameters:

o - o observador a ser removido

getAlgorithmRepositoryPath

public java.lang.String getAlgorithmRepositoryPath()

Obtém o caminho para o repositório de algoritmos.

Returns:

repositoryPath Caminho para o repositório de algoritmos.

getAlgorithmInfo

public static AlgorithmInfo getAlgorithmInfo(java.lang.String name)
                                      throws java.lang.Exception

Solicita ao servico de algoritmos um algoritmo que possui determinada identificacao.

Parameters:

name - nome do algoritmo

Returns:

o algoritmo que possui o identificador, ou null

Throws:

java.lang.Exception - se houver falha de comunicação.

getAlgorithmInfo

public static AlgorithmInfo getAlgorithmInfo(java.lang.Object id)
                                      throws java.lang.Exception

Solicita ao servico de algoritmos um algoritmo que possui determinada identificacao.

Parameters:

id - identificador do algoritmo

Returns:

o algoritmo que possui o identificador, ou null

Throws:

java.lang.Exception - se houver falha de comunicação.

update

public static void update(AlgoEvent event)
                   throws java.lang.Exception

Esse método é chamado quando o serviço de algoritmos sofre alguma alteração relativa a do algo.

Parameters:

event - o evento que ocorreu no serviço de algoritmo

Throws:

java.lang.Exception - Em caso de erro.

compareTo

public int compareTo(AlgorithmInfo o)

(non-Javadoc)

Specified by:

compareTo in interface java.lang.Comparable<AlgorithmInfo>

Parameters:

o - informação de algoritmo a ser comparado

Returns:

o resultado da comparação entre os nomes dos algoritmos

See Also:

*

equals

public boolean equals(java.lang.Object object)

(non-Javadoc)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getDirectory

public java.lang.String getDirectory()

Obtém o nome do diretório do algoritmo.

Returns:

a diretório desejado.

getId

public java.lang.String getId()

Obtém o identificador.

Returns:

a identificação

getLastVersion

public AlgorithmVersionInfo getLastVersion()

Obtém a última versão deste algoritmo.

Returns:

A última versão deste algoritmo ou null se não houver versões.

getName

public java.lang.String getName()

Obtém o nome do algoritmo.

Returns:

nome do algoritmo

getOutline

public AlgorithmOutline getOutline()

Obtém um resumo do algoritmo.

Returns:

o resumo

getVersionIds

public java.lang.Object[] getVersionIds()

Obtenção dos identificadores de versão do algoritmo.

Returns:

as versões do algoritmo.

getVersionInfo

public AlgorithmVersionInfo getVersionInfo(java.lang.Object versionId)

Obtem as informações de uma versão.

Parameters:

versionId - .

Returns:

.

getVersionsDirName

public java.lang.String getVersionsDirName()

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

Returns:

retorna o nome do sub-pacote como uma string.

getVersions

public java.util.Vector<AlgorithmVersionInfo> getVersions()

Obtém as versões deste algoritmo.

Returns:

Um vetor (Vector) com as versões deste algoritmo.

hashCode

public int hashCode()

(non-Javadoc)

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

toString

public java.lang.String toString()

(non-Javadoc)

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

deleteVersion

protected void deleteVersion(java.lang.Object versionId)

Remove uma versão

Parameters:

versionId - .

rename

protected void rename(java.lang.String newName)

Atribui um novo nome ao algoritmo.

Parameters:

newName - o novo nome.

getAllVersionInfo

protected java.util.Hashtable<AlgorithmVersionId,AlgorithmVersionInfo> getAllVersionInfo()

Obtem as informações de todas as versões de um algoritmo.

Returns:

uma Hashtable com as informações, onde a chave e' o identificador da versão

includeVersion

protected void includeVersion(AlgorithmVersionId versionId,
                  AlgorithmVersionInfo vInfo)

Inclui uma versão

Parameters:

versionId - .

vInfo - .

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String propertyName)

Retorna o valor associado a um determinado atributo estendido, como por exemplo, o nome do analista responsavel.

Parameters:

propertyName - .

Returns:

valor no atributo estendido

getPropertyValues

public java.util.Hashtable<java.lang.String,java.lang.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(java.util.Hashtable<java.lang.String,java.lang.String> atributeValues)

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

Parameters:

atributeValues - vector com os novos valores dos atributos

getOwner

public java.lang.String getOwner()

Obtém o valor da propriedade que indica o usuário (login) que criou esse algoritmo.

Returns:

retorna o login do usuário que criou esse algoritmo

setDescription

public void setDescription(java.lang.String description)

Atribui uma descrição para o algoritmo.

Parameters:

description - descrição do algoritmo

getDescription

public java.lang.String getDescription()

Obtém a descrição do algoritmo.

Returns:

a descrição do algoritmo

setAlgoPackCategoryFullNames

public void setAlgoPackCategoryFullNames(java.util.List<java.lang.String> categoryFullNames)

Estabelece os nomes completos das categorias em que o algoritmo do Pacote de Algoritmos faz parte. No serviço de algoritmos, esses nomes completos das categorias devem ser analisados, e então criadas as respectivas categorias e sub-categorias em que o algorimto participa.

Parameters:

categoryFullNames - nomes completos das categorias

getAlgoPackCategoryFullNames

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

Retorna os nomes completos das categorias em que o algoritmo do Pacote de Algoritmos faz parte.

Returns:

os nomes completos das categorias em que o algoritmo do PA faz parte