csbase.logic.algorithms

Class Category

java.lang.Object

csbase.logic.algorithms.Category

All Implemented Interfaces:

IdInterface, Serializable, Comparable<Category>

public class Category
extends Object
implements Comparable<Category>, Serializable, IdInterface

Categoria de algoritmo.

Author:

Tecgraf/PUC-Rio

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Category(Category category) Constrói uma categoria a partir de uma categoria base.
Category(Category parentCategory, String id, String name) Construtor
Category(String id, String name) Construtor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addAlgorithm(AlgorithmInfo algorithm) Adiciona um algoritmo a esta categoria.
boolean	addCategory(Category category) Adiciona uma categoria filha.
static void	addObserver(Observer o) Adiciona um observador local da classe.
int	compareTo(Category other)
boolean	containsAlgorithm(AlgorithmInfo algorithm) Verifica se o algoritmo está nesta categoria.
boolean	containsAlgorithm(String algoName) Verifica se um algoritmo com o nome especificado pertence a essa categoria.
boolean	containsAlgorithmInChildren(AlgorithmInfo algorithm) Verifica se o algoritmo está nesta categoria ou em outras sub-categorias.
boolean	containsCategory(String categoryName) Verifica se a categoria contém uma sub-categoria com um determinado nome.
static void	deleteObserver(Observer o) Remove um observador local da classe.
boolean	equals(Object obj)
Set<AlgorithmInfo>	getAlgorithms() Obtém os algoritmos desta categoria.
SortedSet<Category>	getCategories() Obtém as categorias filhas desta categoria.
Category	getCategory(String id) Obtém uma determinada categoria dentro do seu conjunto de sub-categorias.
String	getFullName() Consulta o nome completo da categoria, incluindo o nome completo da categoria pai.
String	getId() Obtém o identificador.
String	getName() Consulta o nome
Category	getParentCategory() Obtém a categoria pai desta categoria.
String	getParentId() Obtém o identificador da categoria pai desta categoria.
Category	getRootCategory()
int	hashCode()
boolean	removeAlgorithm(AlgorithmInfo algorithm) Remove um algoritmo desta categoria.
void	removeAllAlgorithms() Remove todos os algoritmos dessa categoria.
boolean	removeCategory(Category category) Remove uma sub-categoria dessa categoria.
void	setCategories(SortedSet<Category> categories) Estabelece um novo conjunto de sub-categorias para essa categoria.
protected void	setId(String id) Atribui um identificador a esta categoria.
void	setParentCategory(Category parentCategory) Estabelece a categoria pai desta categoria.
String	toString()
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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Category

public Category(Category parentCategory,
        String id,
        String name)

Construtor

Parameters:

parentCategory - categoria pai. Se for uma categoria raiz, esse parâmetro deve ser null.

id - O identificador (Não aceita null).

name - O nome (Não aceita null).

Category

public Category(String id,
        String name)

Construtor.

Parameters:

id - o identificador (Não aceita null).

name - O nome (Não aceita null).

Category

public Category(Category category)

Constrói uma categoria a partir de uma categoria base.

Parameters:

category - categoria base

Method Detail

updateCategory

public void updateCategory(Category category)

Atualiza uma categoria a partir dos dados da categoria especificada.

Parameters:

category - categoria cujos dados serão copiados

addAlgorithm

public boolean addAlgorithm(AlgorithmInfo algorithm)

Adiciona um algoritmo a esta categoria.

Parameters:

algorithm - O de algoritmo (Não aceita null).

Returns:

true em caso de sucesso ou false em caso de erro.

addCategory

public boolean addCategory(Category category)

Adiciona uma categoria filha.

Parameters:

category - A categoria filha (Não aceita null).

Returns:

true em caso de sucesso ou false se a categoria já está na lista de categorias filhas ou se for ela mesma.

compareTo

public int compareTo(Category other)

Specified by:

compareTo in interface Comparable<Category>

containsAlgorithm

public boolean containsAlgorithm(AlgorithmInfo algorithm)

Verifica se o algoritmo está nesta categoria. Não faz a busca em suas sub-categorias. Veja também: @see containsAlgorithmInChildren(AlgorithmInfo)

Parameters:

algorithm - O algoritmo (não aceita null).

Returns:

retorna true se a categoria contém o algoritmo, caso contrário, retorna false

containsAlgorithm

public boolean containsAlgorithm(String algoName)

Verifica se um algoritmo com o nome especificado pertence a essa categoria. Não faz a busca em suas sub-categorias.

Parameters:

algoName - nome do algoritmo procurado

Returns:

retorna true se a categoria contém o algoritmo, caso contrário, retorna false

containsAlgorithmInChildren

public boolean containsAlgorithmInChildren(AlgorithmInfo algorithm)

Verifica se o algoritmo está nesta categoria ou em outras sub-categorias.

Parameters:

algorithm - O algoritmo (não aceita null).

Returns:

indicativo

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAlgorithms

public Set<AlgorithmInfo> getAlgorithms()

Obtém os algoritmos desta categoria.

Returns:

Os algoritmos desta categoria. O conjunto retornado é imutável. Caso não haja algoritmos, retornará um conjunto vazio.

getCategories

public SortedSet<Category> getCategories()

Obtém as categorias filhas desta categoria.

Returns:

As categorias filhas. O conjunto retornado é imutável. Caso não haja categorias filhas, retornará um conjunto vazio.

getId

public String getId()

Obtém o identificador.

Specified by:

getId in interface IdInterface

Returns:

o identificador.

getName

public String getName()

Consulta o nome

Returns:

o nome

getFullName

public String getFullName()

Consulta o nome completo da categoria, incluindo o nome completo da categoria pai. Por exemplo, "categoriaA:categoriaA1:categoriaA11".

Returns:

o nome completo da categoria

hashCode

public int hashCode()

Overrides:

hashCode in class Object

removeAlgorithm

public boolean removeAlgorithm(AlgorithmInfo algorithm)

Remove um algoritmo desta categoria.

Parameters:

algorithm - O de algoritmo (Não aceita null).

Returns:

true em caso de sucesso ou false em caso de erro.

removeAllAlgorithms

public void removeAllAlgorithms()

Remove todos os algoritmos dessa categoria.

removeCategory

public boolean removeCategory(Category category)

Remove uma sub-categoria dessa categoria.

Parameters:

category - categoria a ser removida

Returns:

retorna true se a sub-categoria foi removida com sucesso, caso contrário, retorna false

toString

public String toString()

Overrides:

toString in class Object

setId

protected void setId(String id)

Atribui um identificador a esta categoria.

Parameters:

id - O identificador (Não aceita null).

setParentCategory

public void setParentCategory(Category parentCategory)

Estabelece a categoria pai desta categoria.

Parameters:

parentCategory - categoria pai

getParentId

public String getParentId()

Obtém o identificador da categoria pai desta categoria.

Returns:

o identificador da categoria pai

getParentCategory

public Category getParentCategory()

Obtém a categoria pai desta categoria.

Returns:

a categoria pai

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

containsCategory

public boolean containsCategory(String categoryName)

Verifica se a categoria contém uma sub-categoria com um determinado nome.

Parameters:

categoryName - nome da categoria

Returns:

retorna true se existir uma categoria com o nome especificado, caso contrário, retorna false

getCategory

public Category getCategory(String id)

Obtém uma determinada categoria dentro do seu conjunto de sub-categorias.

Parameters:

id - identificador da categoria procurada

Returns:

a categoria procurada, caso contrário, retorna null

getRootCategory

public Category getRootCategory()

setCategories

public void setCategories(SortedSet<Category> categories)

Estabelece um novo conjunto de sub-categorias para essa categoria.

Parameters:

categories - novo conjunto de categorias