AlgorithmInfo (csbase-common 3.5.1 API)

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

All Implemented Interfaces:

Serializable, Comparable<AlgorithmInfo>

Direct Known Subclasses:

RecentAlgorithmInfo
```
public class AlgorithmInfo
extends Object
implements Serializable, Comparable<AlgorithmInfo>
```
Representa os dados de um algoritmo para ser mostrado no cliente.

Version:

$Revision$

Author:

clinio

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HIDE_ALGORITHM_PROPERTY` Chave da propriedade que determina se o algoritmo deve ser exibido
`static 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 String`	`OWNER_ALGORITHM_PROPERTY` Chave da propriedade que determina o usuário (login) que criou o algoritmo
`static String`	`PROPERTY_VALUES_FILE` Nome do arquivo de informacoes do algoritmo.
`static 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(String id, String name, String dir, String algorithmRepositoryPath, Hashtable<String,String> propertyValues)` Construtor de um AlgorithmInfo.
`AlgorithmInfo(String id, String name, String dir, String algorithmRepositoryPath, Hashtable<String,String> propertyValues, Hashtable<AlgorithmVersionId,AlgorithmVersionInfo> versions)` Construtor de um AlgorithmInfo.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addObserver(Observer o)` Adiciona um observador local da classe.
`int`	`compareTo(AlgorithmInfo o)` (non-Javadoc)
`static void`	`deleteObserver(Observer o)` Remove um observador local da classe.
`protected void`	`deleteVersion(Object versionId)` Remove uma versão
`boolean`	`equals(Object object)` (non-Javadoc)
`List<String>`	`getAlgoPackCategoryFullNames()` Retorna os nomes completos das categorias em que o algoritmo do Pacote de Algoritmos faz parte.
`static AlgorithmInfo`	`getAlgorithmInfo(Object id)` Solicita ao servico de algoritmos um algoritmo que possui determinada identificacao.
`static AlgorithmInfo`	`getAlgorithmInfo(String name)` Solicita ao servico de algoritmos um algoritmo que possui determinada identificacao.
`String`	`getAlgorithmRepositoryPath()` Obtém o caminho para o repositório de algoritmos.
`protected Hashtable<AlgorithmVersionId,AlgorithmVersionInfo>`	`getAllVersionInfo()` Obtem as informações de todas as versões de um algoritmo.
`String`	`getDescription()` Obtém a descrição do algoritmo.
`String`	`getDirectory()` Obtém o nome do diretório do algoritmo.
`String`	`getId()` Obtém o identificador.
`AlgorithmVersionInfo`	`getLastVersion()` Obtém a última versão deste algoritmo.
`String`	`getName()` Obtém o nome do algoritmo.
`AlgorithmOutline`	`getOutline()` Obtém um resumo do algoritmo.
`String`	`getOwner()` Obtém o valor da propriedade que indica o usuário (login) que criou esse algoritmo.
`String`	`getPropertyValue(String propertyName)` Retorna o valor associado a um determinado atributo estendido, como por exemplo, o nome do analista responsavel.
`Hashtable<String,String>`	`getPropertyValues()` Retorna uma lista com os valores dos atributos estendidos do algoritmo
`Object[]`	`getVersionIds()` Obtenção dos identificadores de versão do algoritmo.
`AlgorithmVersionInfo`	`getVersionInfo(Object versionId)` Obtem as informações de uma versão.
`Vector<AlgorithmVersionInfo>`	`getVersions()` Obtém as versões deste algoritmo.
`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(String newName)` Atribui um novo nome ao algoritmo.
`void`	`setAlgoPackCategoryFullNames(List<String> categoryFullNames)` Estabelece os nomes completos das categorias em que o algoritmo do Pacote de Algoritmos faz parte.
`void`	`setDescription(String description)` Atribui uma descrição para o algoritmo.
`void`	`setPropertyValues(Hashtable<String,String> atributeValues)` Modifica o valor dos atributos estendidos.
`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 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 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 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 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 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(String id,
                     String name,
                     String dir,
                     String algorithmRepositoryPath,
                     Hashtable<String,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(String id,
                     String name,
                     String dir,
                     String algorithmRepositoryPath,
                     Hashtable<String,String> propertyValues,
                     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(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(Observer o)
```
    Remove um observador local da classe.
    
    Parameters:
    
    o - o observador a ser removido
  - getAlgorithmRepositoryPath
```
public 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(String name)
                                      throws 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:
    
    Exception - se houver falha de comunicação.
  - getAlgorithmInfo
```
public static AlgorithmInfo getAlgorithmInfo(Object id)
                                      throws 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:
    
    Exception - se houver falha de comunicação.
  - update
```
public static void update(AlgoEvent event)
                   throws 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:
    
    Exception - Em caso de erro.
  - compareTo
```
public int compareTo(AlgorithmInfo o)
```
    (non-Javadoc)
    
    Specified by:
    
    compareTo in interface 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(Object object)
```
    (non-Javadoc)
    
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - getDirectory
```
public String getDirectory()
```
    Obtém o nome do diretório do algoritmo.
    
    Returns:
    
    a diretório desejado.
  - getId
```
public 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 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 Object[] getVersionIds()
```
    Obtenção dos identificadores de versão do algoritmo.
    
    Returns:
    
    as versões do algoritmo.
  - getVersionInfo
```
public AlgorithmVersionInfo getVersionInfo(Object versionId)
```
    Obtem as informações de uma versão.
    
    Parameters:
    
    versionId - .
    
    Returns:
    
    .
  - getVersionsDirName
```
public String getVersionsDirName()
```
    Consulta ao nome do sub-pacote de versões.
    
    Returns:
    
    retorna o nome do sub-pacote como uma string.
  - getVersions
```
public 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 Object
    
    See Also:
    
    Object.hashCode()
  - toString
```
public String toString()
```
    (non-Javadoc)
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - deleteVersion
```
protected void deleteVersion(Object versionId)
```
    Remove uma versão
    
    Parameters:
    
    versionId - .
  - rename
```
protected void rename(String newName)
```
    Atribui um novo nome ao algoritmo.
    
    Parameters:
    
    newName - o novo nome.
  - getAllVersionInfo
```
protected 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 String getPropertyValue(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 Hashtable<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> 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 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(String description)
```
    Atribui uma descrição para o algoritmo.
    
    Parameters:
    
    description - descrição do algoritmo
  - getDescription
```
public String getDescription()
```
    Obtém a descrição do algoritmo.
    
    Returns:
    
    a descrição do algoritmo
  - setAlgoPackCategoryFullNames
```
public void setAlgoPackCategoryFullNames(List<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 List<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

Class AlgorithmInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_NAME_SIZE

VERSIONS_DIR

PROPERTY_VALUES_FILE

HIDE_ALGORITHM_PROPERTY

HIDE_ALGORITHM_VALUE

OWNER_ALGORITHM_PROPERTY

Constructor Detail

AlgorithmInfo

AlgorithmInfo

AlgorithmInfo

Method Detail

addObserver

deleteObserver

getAlgorithmRepositoryPath

getAlgorithmInfo

getAlgorithmInfo

update

compareTo

equals

getDirectory

getId

getLastVersion

getName

getOutline

getVersionIds

getVersionInfo

getVersionsDirName

getVersions

hashCode

toString

deleteVersion

rename

getAllVersionInfo

includeVersion

getPropertyValue

getPropertyValues

setPropertyValues

getOwner

setDescription

getDescription

setAlgoPackCategoryFullNames

getAlgoPackCategoryFullNames