csbase.client.algorithms.commands.cache

Class CommandsCache

java.lang.Object

csbase.client.algorithms.commands.cache.CommandsCache

public final class CommandsCache
extends Object

Representa uma cache contendo todos os comandos a que o usuário tenha acesso.

Author:

Tecgraf/PUC-Rio

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventListener(AbstractCacheUpdatedEventListener listener) Adiciona um observador para eventos de atualização da cache toda.
void	addEventListener(AbstractCommandUpdatedEventListener listener) Adiciona um observador para eventos de atualização de comandos.
void	addEventListener(EventListener<FinishedOrSystemFailureCommandsLoadingEvent> listener) Adicona listener.
csbase.logic.CommandInfo	getCommand(CommandsFilter filter) Obtém um comando qualquer que seja aceito pelo filtro.
csbase.logic.CommandInfo	getCommand(Object prjId, String cmdId) Obtém um comando dado seu projeto e identificador.
Collection<csbase.logic.CommandInfo>	getCommands() Obtém todos os comandos na cache.
Collection<csbase.logic.CommandInfo>	getCommands(CommandsFilter filter) Obtém uma lista contendo todos os comandos que sejam aceitos pelo filtro.
static CommandsCache	getInstance() Obtém a instância única da cache.
void	hardReload(Object prjId) Apaga e recarrega os comandos de um projeto na cache, forçando a releitura das informações persistidas.
boolean	hasCommand(String commandId) Retorna true se existir um comando com o dado identificador, false caso contrário.
boolean[]	removeCommands(List<csbase.logic.CommandInfo> commands) Remove comandos do servidor.
<E extends IEvent,L extends EventListener<E>> void	removeEventListener(L listener) Remove um observador de eventos.
void	updateDescription(csbase.logic.CommandInfo command) Atualiza a descrição de um comando no servidor.
boolean	updatePosition(csbase.logic.CommandInfo command) Atualiza a posição de um comando no servidor.
boolean	updatePriority(csbase.logic.CommandInfo command) Atualiza a prioridade de um comando no servidor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static CommandsCache getInstance()

Obtém a instância única da cache.

Returns:

a instância única da cache ou null caso tenha ocorrido um erro durante a sua criação.

hasCommand

public boolean hasCommand(String commandId)
                   throws RemoteException

Retorna true se existir um comando com o dado identificador, false caso contrário.

Parameters:

commandId - - identificador de um comando.

Returns:

true se existir um comando com o dado identificador, false caso contrário.

Throws:

RemoteException - Caso ocorra algum problema na comunicação com o servidor.

getCommands

public Collection<csbase.logic.CommandInfo> getCommands()
                                                 throws RemoteException

Obtém todos os comandos na cache.

Returns:

todos os comandos.

Throws:

RemoteException - Caso ocorra algum problema na comunicação com o servidor.

getCommands

public final Collection<csbase.logic.CommandInfo> getCommands(CommandsFilter filter)
                                                       throws RemoteException

Obtém uma lista contendo todos os comandos que sejam aceitos pelo filtro.

Parameters:

filter - filtro utilizado para indicar que tipo de comando se está interessado.

Returns:

uma lista de comandos que foram aceitos pelo filtro.

Throws:

RemoteException - Caso ocorra algum problema na comunicação com o servidor.

getCommand

public final csbase.logic.CommandInfo getCommand(CommandsFilter filter)
                                          throws RemoteException

Obtém um comando qualquer que seja aceito pelo filtro.
Este método costuma ser utilizado quando só existe um comando que passe pelo filtro.

Parameters:

filter - filtro utilizado para indicar que tipo de comando se está interessado.

Returns:

um comando qualquer que seja aceito pelo filtro ou null caso nenhum comando passe no teste do filtro.

Throws:

RemoteException - Caso ocorra algum problema na comunicação com o servidor.

RemoteException - em caso de falha de chamada remota.

getCommand

public final csbase.logic.CommandInfo getCommand(Object prjId,
                                  String cmdId)
                                          throws RemoteException

Obtém um comando dado seu projeto e identificador.

Parameters:

prjId - identificador único do projeto dono do comando.

cmdId - identificador único do comando.

Returns:

o comando representado pelo identificador passado.

Throws:

RemoteException - Caso ocorra algum problema na comunicação com o servidor.

removeCommands

public boolean[] removeCommands(List<csbase.logic.CommandInfo> commands)
                         throws RemoteException

Remove comandos do servidor.
Este método só funciona para comandos terminados.

Parameters:

commands - os comandos a serem removidos.

Returns:

um array de booleanos indicando que comandos foram removidos com sucesso.

Throws:

RemoteException - Caso ocorra algum problema na comunicação com o servidor.

updatePriority

public boolean updatePriority(csbase.logic.CommandInfo command)
                       throws RemoteException

Atualiza a prioridade de um comando no servidor.
Somente comandos no estado CommandStatus.SCHEDULED podem ter sua prioridade atualizada.

Parameters:

command - o comando a ser atualizado.

Returns:

true se o comando estava no estado CommandStatus.SCHEDULED e a prioridade foi alterada com sucesso.

Throws:

RemoteException - Caso ocorra algum problema na comunicação com o servidor.

updatePosition

public boolean updatePosition(csbase.logic.CommandInfo command)
                       throws RemoteException

Atualiza a posição de um comando no servidor.
Somente comandos no estado CommandStatus.SCHEDULED podem ter sua posição atualizada.

Parameters:

command - o comando a ser atualizado.

Returns:

true se o comando estava no estado CommandStatus.SCHEDULED e a posição foi alterada com sucesso.

Throws:

RemoteException - Caso ocorra algum problema na comunicação com o servidor.

updateDescription

public void updateDescription(csbase.logic.CommandInfo command)
                       throws RemoteException

Atualiza a descrição de um comando no servidor.

Parameters:

command - o comando a ser atualizado.

Throws:

RemoteException - Caso ocorra algum problema na comunicação com o servidor.

addEventListener

public void addEventListener(AbstractCacheUpdatedEventListener listener)

Adiciona um observador para eventos de atualização da cache toda.
Liga a recarga automática caso esta já não esteja ligado.

Parameters:

listener - observador do evento.

addEventListener

public void addEventListener(AbstractCommandUpdatedEventListener listener)

Adiciona um observador para eventos de atualização de comandos.
Liga a recarga automática caso esta já não esteja ligado.

Parameters:

listener - observador do evento.

addEventListener

public void addEventListener(EventListener<FinishedOrSystemFailureCommandsLoadingEvent> listener)

Adicona listener.

Parameters:

listener - listener

removeEventListener

public <E extends IEvent,L extends EventListener<E>> void removeEventListener(L listener)

Remove um observador de eventos.
Desliga a recarga automática caso não haja mais nenhum observador.

Type Parameters:

E - tipo do evento a sendo observado.

L - tipo do observador do evento.

Parameters:

listener - observador do evento.

hardReload

public void hardReload(Object prjId)
                throws RemoteException

Apaga e recarrega os comandos de um projeto na cache, forçando a releitura das informações persistidas. Esse método somente deve ser utilizado quando os arquivos de persistência dos comandos de um projeto forem *comprometidos* no sistema de arquivos. Em outros casos, para atualizar as informações da cache, deve ser utilizado o método runManualReload(boolean).

Parameters:

prjId - Identificador do projeto a ter seus comandos recarregados.

Throws:

RemoteException - Caso ocorra algum problema na comunicação com o servidor.