csbase.client.applications

Class ApplicationCommandAdapter

java.lang.Object

csbase.client.applications.ApplicationCommandAdapter

All Implemented Interfaces:

CommandListener

public class ApplicationCommandAdapter
extends Object
implements CommandListener

Esta classe implementa o adaptador para o caso da notificação pelo SGA do término de um comando que foi submetido para execução a partir de um dado de uma aplicação. O término da execução do comando não necessariamente significa sucesso, e esta classe lida com todos os possíveis casos (interrupção, falha ou "comando não recuperado"). Nessa implementação, nenhuma ação é realizada em relação a abertura do arquivo de saída resultante da execução do comando submetido pela aplicação. Veja SGAServicee#commandLost(String, String).

Constructor Summary

Constructors

Constructor and Description
ApplicationCommandAdapter(Object commandId, String[] dataFilePath, String executionName, ApplicationProject application) Constrói um listener de comandos básico, que não abre nenhum tipo de arquivo de saída automaticamente.

Method Summary

Modifier and Type	Method and Description
ApplicationProject	getApplication() Obtém o tipo da aplicação que pode ser usada para abrir o dado de saída.
Object	getCommandId() Obtém o identificador do comando executado.
String[]	getDataFilePath() Obtém o caminho do arquivo de dados da aplicação que submeteu o comando para execução.
protected String	getFileName(String[] filePath) Obtém o nome do arquivo, a partir de um caminho completo do arquivo.
String	getString(String key) Consulta uma propriedade da aplicação.
void	handleFinishedCommand(boolean state) Estabelece se o término de comando deve ser tratado ou não pelo adaptador.
protected boolean	isDataFileInCurrentProject() Verifica se o arquivo de dados faz parte do projeto corrente.
void	notifyCommand(csbase.logic.CommandNotification data) Se o listener estiver interessado, chama o método para a notificação específica.
protected void	notifyCommandError(csbase.logic.CommandErrorNotification data) Ações associadas ao término de uma execução (com erro).
protected void	notifyCommandFailed(csbase.logic.CommandFailedNotification data) Ações associadas a falhas em uma execução.
void	notifyCommandFinished() Implementação default para uma aplicação que é notificada do término do comando que foi submetido para execução.
protected void	notifyCommandFinished(csbase.logic.CommandEndNotification data) Ações associadas ao término de uma execução (sem dados sobre como a execução terminou).
protected void	notifyCommandKilled(csbase.logic.CommandKilledNotification data) Ações associadas à interrupção de uma execução.
protected void	notifyCommandLost(csbase.logic.CommandLostNotification data) Ações associadas ao caso em que o comando terminou mas o SGA não possuía referência para ele.
protected void	notifyCommandSuccess(csbase.logic.CommandSuccessNotification data) Ações associadas ao término de uma execução (com sucesso).
protected void	notifyCommandWithNoExitCode(csbase.logic.CommandWithNoExitCodeNotification data) Ações associadas ao término de uma execução (sem código de retorno).
boolean	shouldRemove() Indica se o listener deve ser removido do CommandNotificationHandler após a notificação.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationCommandAdapter

public ApplicationCommandAdapter(Object commandId,
                                 String[] dataFilePath,
                                 String executionName,
                                 ApplicationProject application)

Constrói um listener de comandos básico, que não abre nenhum tipo de arquivo de saída automaticamente.

Parameters:

commandId - identificador do comando executado

dataFilePath - caminho do arquivo de dados da aplicação

executionName - nome da execução, por exemplo, algoritmo ou simulação

application - aplicação associada a execução do comando

Method Detail

getApplication

public ApplicationProject getApplication()

Obtém o tipo da aplicação que pode ser usada para abrir o dado de saída.

Returns:

o tipo da aplicação que pode ser usada para abrir o dado de saída, ou null, caso nenhuma aplicação esteja associada ao dado de saida

getCommandId

public Object getCommandId()

Obtém o identificador do comando executado.

Returns:

o identificador do comando

getDataFilePath

public String[] getDataFilePath()

Obtém o caminho do arquivo de dados da aplicação que submeteu o comando para execução.

Returns:

o caminho do arquivo de dados da aplicação

handleFinishedCommand

public void handleFinishedCommand(boolean state)

Estabelece se o término de comando deve ser tratado ou não pelo adaptador. O default é não tratar o término de comando. Se for estabelecido o tratamento do término de comando, uma janela popup é exibida com uma mensagem para o usuário, contendo as informações do comando. A janela popup é aberta com base no desktop do projeto, e pode acabar aparecendo múltiplas janelas para o usuário, no caso do término de comando ser tratado também pela aplicação que submeteu o comando para execução.

Parameters:

state - se true, estabelece que o término de comando deve ser tratado pelo adaptador, caso contrário, o usuário receberá somente uma notificação de término de comando no painel de notificações

getFileName

protected String getFileName(String[] filePath)

Obtém o nome do arquivo, a partir de um caminho completo do arquivo.

Parameters:

filePath - Caminho completo do arquivo.

Returns:

o nome do arquivo ou retorna null, no caso do path estar vazio

notifyCommand

public void notifyCommand(csbase.logic.CommandNotification data)

Se o listener estiver interessado, chama o método para a notificação específica.

Specified by:

notifyCommand in interface CommandListener

Parameters:

data - informações do comando

notifyCommandFinished

public void notifyCommandFinished()

Implementação default para uma aplicação que é notificada do término do comando que foi submetido para execução. Esse método deve ser redefinido por toda aplicação que deseja realizar alguma tarefa específica quando o comando terminar, tal como recarregar o arquivo corrente.

shouldRemove

public boolean shouldRemove()

Indica se o listener deve ser removido do CommandNotificationHandler após a notificação.

Specified by:

shouldRemove in interface CommandListener

Returns:

true se o listener deve ser removido após a notificação, ou false caso contrário.

isDataFileInCurrentProject

protected boolean isDataFileInCurrentProject()

Verifica se o arquivo de dados faz parte do projeto corrente. Caso não seja, exibe uma mensagem.

Returns:

retorna true, se o arquivo de dados cuja execução foi disparada estiver aberto ou false, caso contrário.

notifyCommandFinished

protected void notifyCommandFinished(csbase.logic.CommandEndNotification data)

Ações associadas ao término de uma execução (sem dados sobre como a execução terminou).

Parameters:

data - Dados da notificação, enviados pelo SGA.

notifyCommandSuccess

protected void notifyCommandSuccess(csbase.logic.CommandSuccessNotification data)

Ações associadas ao término de uma execução (com sucesso).

Parameters:

data - Dados da notificação, enviados pelo SGA.

notifyCommandError

protected void notifyCommandError(csbase.logic.CommandErrorNotification data)

Ações associadas ao término de uma execução (com erro).

Parameters:

data - Dados da notificação, enviados pelo SGA.

notifyCommandWithNoExitCode

protected void notifyCommandWithNoExitCode(csbase.logic.CommandWithNoExitCodeNotification data)

Ações associadas ao término de uma execução (sem código de retorno).

Parameters:

data - Dados da notificação, enviados pelo SGA.

notifyCommandKilled

protected void notifyCommandKilled(csbase.logic.CommandKilledNotification data)

Ações associadas à interrupção de uma execução. Remove o arquivo temporário e muda o estado do arquivo de logging.

Parameters:

data - dados da notificação, enviados pelo SGA

getString

public final String getString(String key)

Consulta uma propriedade da aplicação.

Parameters:

key - a chave da propriedade

Returns:

o valor da propriedade

notifyCommandFailed

protected void notifyCommandFailed(csbase.logic.CommandFailedNotification data)

Ações associadas a falhas em uma execução.

Parameters:

data - dados da notificação, enviados pelo SGA

notifyCommandLost

protected void notifyCommandLost(csbase.logic.CommandLostNotification data)

Ações associadas ao caso em que o comando terminou mas o SGA não possuía referência para ele. Esta situação acontece p.ex. quando o SGA é reiniciado e percebe que o comando não está mais executando, mas não é capaz de fornecer as informações de tempo (tempo total, CPU e sistema).

Parameters:

data - dados da notificação, enviados pelo SGA