CategorySet (csbase-common 3.4.1-RC2 API)

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

All Implemented Interfaces:

Serializable
```
public class CategorySet
extends Object
implements Serializable
```
Essa classe representa um conjunto de categorias de algoritmos.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`CategorySet()` Constrói o conjunto de categorias vazio.
`CategorySet(SortedSet<Category> categories)` Constrói o conjunto de categorias a partir das categorias disponíveis no sistema.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlgorithms(Category category, List<AlgorithmInfo> algorithms)` Adiciona os algoritmos especificados em uma determinada categoria.
`void`	`addAlgorithmsToCategories(SortedSet<Category> categories, List<AlgorithmInfo> algorithms)` Adiciona os algoritmos especificados em uma determinada categoria.
`void`	`addCategory(Category category)` Adiciona uma categoria ao conjunto de categorias.
`static void`	`addObserver(Observer o)` Adiciona um observador local da classe.
`void`	`changeCategoryIds()` Modifica os identificadores lidos para esse conjunto de categorias, para obter os números sequencialmente a partir da estrutura de controle de ids.
`Category`	`createCategory(Category parentCategory, String name)` Cria uma nova categoria, a partir do nome especificado, na categoria pai.
`static void`	`deleteObserver(Observer o)` Remove um observador local da classe.
`List<String>`	`getAlgorithmCategoriesFullNames(AlgorithmInfo algoInfo)` Obtém os nomes completos de todas as categorias que contém o algoritmo especificado.
`List<String>`	`getAlgorithmCategoriesFullNames(String algoName)` Obtém os nomes completos de todas as categorias que contém o algoritmo especificado.
`SortedSet<Category>`	`getAllCategories()` Obter todas as categorias disponíveis no servidor, inclusive as subcategorias.
`SortedSet<Category>`	`getCategories()` Obtém as categorias de algoritmos disponíveis no conjunto.
`List<Category>`	`getCategoriesFromFullNames(List<String> categoryFullNames)` Obtém uma lista de categorias por através de uma busca feita a partir de uma lista de nomes de categorias recebida como parâmetro.
`Category`	`getCategory(String id)` Obtém uma determinada categoria nesse conjunto de categorias.
`Category`	`getCategory(String parentCategoryFullName, String catFullName)` Obtém uma categoria, dado o nome da categoria pai e o nome da categoria a ser obtida.
`Category`	`getFirstCategory()` Obtém a primeira categoria do conjunto.
`Category`	`getRootCategory(String categoryId)` Obtém uma determinada categoria que esteja na raiz do conjunto de categorias, ou seja, não deve buscar nas sub-categorias da categoria.
`int`	`getSize()` Obtém o número de categorias que existem na raiz desse conjunto.
`boolean`	`isCategorySetSaved()` Verifica se esse conjunto de categorias foi ou não salvo com sucesso.
`boolean`	`isEmpty()` Verifica se o conjunto de categorias está vazio.
`void`	`removeAlgorithms(Category category, List<AlgorithmInfo> algorithms)` Remove os algoritmos especificados em uma determinada categoria.
`void`	`removeAlgorithmsFromCategories(SortedSet<Category> categories, List<AlgorithmInfo> algorithms)` Remove os algoritmos especificados das categorias especificadas.
`void`	`removeAllAlgorithmsFromCategories(SortedSet<Category> categories)` Remove todos os algoritmos de todas as categorias especificadas.
`void`	`removeAllCategories()` Remove todas as categorias do conjunto de categorias.
`Category`	`removeCategory(String id)` Remove uma determinada categoria desse conjunto de categorias.
`void`	`setCategories(SortedSet<Category> categories)` Estabelece as categorias de algoritmos disponíveis no conjunto.
`void`	`setCategorySetSavedFlag(boolean state)` Estabelece um novo estado para o flag que indica se esse conjunto de categorias foi ou não salvo
`static void`	`update(AlgoEvent event)` Esse método é chamado quando o serviço de algoritmos sofre alguma alteração relativa a categoria de algoritmos.
`void`	`updateCategory(Category category)` Atualiza uma categoria a partir dos dados da categoria especificada.

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

- Constructor Detail
  - CategorySet
```
public CategorySet()
```
    Constrói o conjunto de categorias vazio.
  - CategorySet
```
public CategorySet(SortedSet<Category> categories)
```
    Constrói o conjunto de categorias a partir das categorias disponíveis no sistema.
    
    Parameters:
    
    categories - categorias disponíveis no sistema
- Method Detail
  - getCategories
```
public SortedSet<Category> getCategories()
```
    Obtém as categorias de algoritmos disponíveis no conjunto.
    
    Returns:
    
    as categorias de algoritmos
  - setCategories
```
public void setCategories(SortedSet<Category> categories)
```
    Estabelece as categorias de algoritmos disponíveis no conjunto.
    
    Parameters:
    
    categories - as categorias de algoritmos
  - addCategory
```
public void addCategory(Category category)
```
    Adiciona uma categoria ao conjunto de categorias.
    
    Parameters:
    
    category - categoria a ser adicionada
  - createCategory
```
public Category createCategory(Category parentCategory,
                               String name)
```
    Cria uma nova categoria, a partir do nome especificado, na categoria pai. Se a categoria pai for nula, a categoria é criada diretamente no conjunto, caso contrário, ela é adicionada à categoria pai.
    
    Parameters:
    
    parentCategory - categoria pai
    
    name - nome da categoria sendo criada
    
    Returns:
    
    a categoria criada
  - updateCategory
```
public void updateCategory(Category category)
```
    Atualiza uma categoria a partir dos dados da categoria especificada.
    
    Parameters:
    
    category - categoria cujos dados serão copiados
  - removeCategory
```
public Category removeCategory(String id)
```
    Remove uma determinada categoria desse conjunto de categorias.
    
    Parameters:
    
    id - identificador da categoria a ser removida
    
    Returns:
    
    a categoria removida
  - removeAllCategories
```
public void removeAllCategories()
```
    Remove todas as categorias do conjunto de categorias.
  - getCategory
```
public Category getCategory(String id)
```
    Obtém uma determinada categoria nesse conjunto de categorias.
    
    Parameters:
    
    id - identificador da categoria procurada
    
    Returns:
    
    a categoria procurada, caso contrário, retorna null
  - getRootCategory
```
public Category getRootCategory(String categoryId)
```
    Obtém uma determinada categoria que esteja na raiz do conjunto de categorias, ou seja, não deve buscar nas sub-categorias da categoria.
    
    Parameters:
    
    categoryId - identificador da categoria procurada
    
    Returns:
    
    retorna true se a categoria procurada está na raiz do conjunto de categorias, caso contrário, retorna null
  - addAlgorithms
```
public void addAlgorithms(Category category,
                          List<AlgorithmInfo> algorithms)
```
    Adiciona os algoritmos especificados em uma determinada categoria.
    
    Parameters:
    
    category - categoria onde os algoritmos serão adicionados
    
    algorithms - algoritmos a serem adicionados
  - addAlgorithmsToCategories
```
public void addAlgorithmsToCategories(SortedSet<Category> categories,
                                      List<AlgorithmInfo> algorithms)
```
    Adiciona os algoritmos especificados em uma determinada categoria.
    
    Parameters:
    
    categories - categorias onde serão adicionados os algoritmos
    
    algorithms - algoritmos a serem adicionados
  - removeAlgorithms
```
public void removeAlgorithms(Category category,
                             List<AlgorithmInfo> algorithms)
```
    Remove os algoritmos especificados em uma determinada categoria.
    
    Parameters:
    
    category - categoria em que os algoritmos serão removidos
    
    algorithms - algoritmos a serem removidos
  - removeAlgorithmsFromCategories
```
public void removeAlgorithmsFromCategories(SortedSet<Category> categories,
                                           List<AlgorithmInfo> algorithms)
```
    Remove os algoritmos especificados das categorias especificadas.
    
    Parameters:
    
    categories - categorias em que serão removidos os algoritmos
    
    algorithms - algoritmos a serem removidos
  - isEmpty
```
public boolean isEmpty()
```
    Verifica se o conjunto de categorias está vazio.
    
    Returns:
    
    retorna true se não tiver categorias no conjunto, caso contrário, retorna false
  - 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 categoria de algoritmos. 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:
    
    event - o evento que ocorreu no serviço de algoritmo
    
    Throws:
    
    Exception - Em caso de erro.
  - addObserver
```
public static void addObserver(Observer o)
```
    Adiciona um observador local da classe.
    
    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
  - getSize
```
public int getSize()
```
    Obtém o número de categorias que existem na raiz desse conjunto.
    
    Returns:
    
    o número de categorias que existem na raiz desse conjunto
  - getAllCategories
```
public SortedSet<Category> getAllCategories()
```
    Obter todas as categorias disponíveis no servidor, inclusive as subcategorias.
    
    Returns:
    
    as categorias disponíveis no servidor, inclusive as subcategorias
  - setCategorySetSavedFlag
```
public void setCategorySetSavedFlag(boolean state)
```
    Estabelece um novo estado para o flag que indica se esse conjunto de categorias foi ou não salvo
    
    Parameters:
    
    state - se true, indica que o conjunto de categorias foi salvo, caso contrário, ocorreu um erro durante a persistência e o conjunto não foi salvo
  - isCategorySetSaved
```
public boolean isCategorySetSaved()
```
    Verifica se esse conjunto de categorias foi ou não salvo com sucesso.
    
    Returns:
    
    retorna true, se o conjunto de categorias foi salvo, caso contrário, retorna false (quando ocorre um erro durante a persistência)
  - removeAllAlgorithmsFromCategories
```
public void removeAllAlgorithmsFromCategories(SortedSet<Category> categories)
```
    Remove todos os algoritmos de todas as categorias especificadas.
    
    Parameters:
    
    categories - categorias em que serão removidos os algoritmos
  - getFirstCategory
```
public Category getFirstCategory()
```
    Obtém a primeira categoria do conjunto.
    
    Returns:
    
    a primeira categoria do conjunto
  - changeCategoryIds
```
public void changeCategoryIds()
```
    Modifica os identificadores lidos para esse conjunto de categorias, para obter os números sequencialmente a partir da estrutura de controle de ids.
  - getAlgorithmCategoriesFullNames
```
public List<String> getAlgorithmCategoriesFullNames(AlgorithmInfo algoInfo)
```
    Obtém os nomes completos de todas as categorias que contém o algoritmo especificado.
    
    Parameters:
    
    algoInfo - informações do algoritmo procurado
    
    Returns:
    
    uma lista com os nomes completos de todas as categorias que contém o algoritmo
  - getAlgorithmCategoriesFullNames
```
public List<String> getAlgorithmCategoriesFullNames(String algoName)
```
    Obtém os nomes completos de todas as categorias que contém o algoritmo especificado.
    
    Parameters:
    
    algoName - informações do algoritmo procurado
    
    Returns:
    
    uma lista com os nomes completos de todas as categorias que contém o algoritmo
  - getCategoriesFromFullNames
```
public List<Category> getCategoriesFromFullNames(List<String> categoryFullNames)
```
    Obtém uma lista de categorias por através de uma busca feita a partir de uma lista de nomes de categorias recebida como parâmetro.
    
    Parameters:
    
    categoryFullNames - lista de nome de categorias.
    
    Returns:
    
    lista de categorias.
  - getCategory
```
public Category getCategory(String parentCategoryFullName,
                            String catFullName)
```
    Obtém uma categoria, dado o nome da categoria pai e o nome da categoria a ser obtida.
    
    Parameters:
    
    parentCategoryFullName - nome da categoria pai.
    
    catFullName - nome da categoria.
    
    Returns:
    
    a categoria.

Class CategorySet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CategorySet

CategorySet

Method Detail

getCategories

setCategories

addCategory

createCategory

updateCategory

removeCategory

removeAllCategories

getCategory

getRootCategory

addAlgorithms

addAlgorithmsToCategories

removeAlgorithms

removeAlgorithmsFromCategories

isEmpty

update

addObserver

deleteObserver

getSize

getAllCategories

setCategorySetSavedFlag

isCategorySetSaved

removeAllAlgorithmsFromCategories

getFirstCategory

changeCategoryIds

getAlgorithmCategoriesFullNames

getAlgorithmCategoriesFullNames

getCategoriesFromFullNames

getCategory