csbase.client.applicationmanager

Class ApplicationType

java.lang.Object

java.util.Observable

csbase.client.applicationmanager.ApplicationType

Direct Known Subclasses:

Application, CommandViewer, CSDKApplication, CSDKApplication

public abstract class ApplicationType
extends Observable

Implementa uma aplicação genérica.

Author:

Tecgraf

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationType(String id) Construtor protegido para atualização do campo de identificador de instância.

Method Summary

Modifier and Type	Method and Description
boolean	closeApplication() Método abstrato para fechamento da aplicação.
abstract void	finishApplication() Método abstrato para fechamento do diálogo das aplicações
protected csbase.logic.applicationservice.ApplicationRegistry	getApplicationRegistry() Obtém o registry da aplicação.
static InputStream	getApplicationResourceAsStream(Class<?> baseClass, String path) Busca um stream de um resource da aplicação.
InputStream	getApplicationResourceAsStream(String path) Busca um stream de um resource da aplicação.
static URL	getApplicationResourceAsURL(Class<?> baseClass, String path) Busca um stream de um resource da aplicação.
URL	getApplicationResourceAsURL(String path) Busca um stream de um resource da aplicação.
String	getAuthorMail() Obtém o e-mail do autor da aplicação.
String	getAuthorName() Obtém o nome do autor da aplicação.
boolean	getBooleanSpecificProperty(String propName, boolean defaultValue) Consulta o valor booleano de uma propriedade
String	getDescription() Obtém a descrição da aplicação.
double	getDoubleSpecificProperty(String propName, double defaultValue) Consulta o valor double de uma propriedade
List<String>	getFileTypes() Obtém os tipos de arquivo que abrem diretamente esta aplicação.
String	getId() Obtém o id do tipo da aplicação.
ImageIcon	getImageIcon() Obtém o ícone da aplicação.
static ImageIcon	getImageIcon(Class<?> baseClass, String imagePath) Busca uma imagem para a aplicação.
ImageIcon	getImageIcon(String imagePath) Busca uma imagem para a aplicação.
String	getInstanceId() Obtém o id da instância da aplicação.
int	getInstanceIndex() Obtém o id da instância da aplicação.
int	getIntSpecificProperty(String propName, int defaultValue) Consulta o valor inteiro de uma propriedade
int	getLongSpecificProperty(String propName, int defaultValue) Consulta o valor long de uma propriedade
long	getLongSpecificProperty(String propName, long defaultValue) Consulta o valor long de uma propriedade
protected Class<?>	getMainApplicationClass() Obtém a classe principal da aplicação.
String	getName() Obtém o nome da aplicação.
List<String>	getStringListSpecificProperty(String propName) Consulta o valor lista de strings de uma propriedade
String	getStringSpecificProperty(String propName) Consulta o valor textual de uma propriedade
String	getStringSpecificProperty(String propName, String defaultValue) Consulta o valor textual de uma propriedade
String	getVersion() Obtém a versão da aplicação.
int	getVersionNumber() Obtém a versão da aplicação com número (double) para comparação.
abstract void	killApplication() Método para encerramento da execução, que pode ser redefinido para comportamentos próprios da aplicações.
protected void	launchApplication() Método protegido para lançamento de aplicação.
protected void	onAsyncMessageReceived(String type, Object value, String senderId) Trata uma mensagem assíncrona recebida pela aplicação.
protected Object	onSyncMessageReceived(String type, Object value, String senderId) Trata uma mensagem síncrona recebida pela aplicação.
void	postInitialization() Método que sinaliza a aplicação que ela já foi iniciada.
void	sendMessage(String name, Object value, String senderId) Deprecated. Sua implementação deve ser movida para os métodos onAsyncMessageReceived(String, Object, String) e onSyncMessageReceived(String, Object, String). Para enviar uma mensagem diretamente a uma aplicação, utilizar ApplicationManager.sendAsyncMessage(String, String, Object, String) ou ApplicationManager.sendSyncMessage(String, String, Object, String).
abstract void	startApplication() Método abstrato para abertura do diálogo das aplicações
protected abstract boolean	userCanKillApplication() Método de kill pelo usuário é específico do desktop applications

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationType

protected ApplicationType(String id)

Construtor protegido para atualização do campo de identificador de instância.

Parameters:

id - o identificador da aplicação.

Method Detail

launchApplication

protected final void launchApplication()
                                throws ApplicationException

Método protegido para lançamento de aplicação.

Throws:

ApplicationException - em caso de erro.

See Also:

startApplication()

getFileTypes

public final List<String> getFileTypes()

Obtém os tipos de arquivo que abrem diretamente esta aplicação.

Returns:

os tipos de arquivo.

getApplicationRegistry

protected final csbase.logic.applicationservice.ApplicationRegistry getApplicationRegistry()

Obtém o registry da aplicação.

Returns:

o registry.

getId

public final String getId()

Obtém o id do tipo da aplicação.

Returns:

o id.

getInstanceId

public final String getInstanceId()

Obtém o id da instância da aplicação.

Returns:

o id.

getInstanceIndex

public final int getInstanceIndex()

Obtém o id da instância da aplicação.

Returns:

o id

getImageIcon

public final ImageIcon getImageIcon()

Obtém o ícone da aplicação.

Returns:

a imagem.

getName

public final String getName()

Obtém o nome da aplicação.

Returns:

o nome.

getVersionNumber

public final int getVersionNumber()

Obtém a versão da aplicação com número (double) para comparação.

Returns:

texto indicativo.

getVersion

public final String getVersion()

Obtém a versão da aplicação.

Returns:

texto indicativo.

getAuthorMail

public final String getAuthorMail()

Obtém o e-mail do autor da aplicação.

Returns:

o nome.

getAuthorName

public final String getAuthorName()

Obtém o nome do autor da aplicação.

Returns:

o nome.

getDescription

public final String getDescription()

Obtém a descrição da aplicação.

Returns:

a descrição.

getIntSpecificProperty

public final int getIntSpecificProperty(String propName,
                                        int defaultValue)

Consulta o valor inteiro de uma propriedade

Parameters:

propName - o nome

defaultValue - o valor default

Returns:

a propriedade

getLongSpecificProperty

public final long getLongSpecificProperty(String propName,
                                          long defaultValue)

Consulta o valor long de uma propriedade

Parameters:

propName - o nome

defaultValue - o valor default

Returns:

a propriedade

getLongSpecificProperty

public final int getLongSpecificProperty(String propName,
                                         int defaultValue)

Consulta o valor long de uma propriedade

Parameters:

propName - o nome

defaultValue - o valor default

Returns:

a propriedade

getStringSpecificProperty

public final String getStringSpecificProperty(String propName)

Consulta o valor textual de uma propriedade

Parameters:

propName - o nome

Returns:

a propriedade

getStringSpecificProperty

public final String getStringSpecificProperty(String propName,
                                              String defaultValue)

Consulta o valor textual de uma propriedade

Parameters:

propName - o nome

defaultValue - o valor default

Returns:

a propriedade

getStringListSpecificProperty

public final List<String> getStringListSpecificProperty(String propName)

Consulta o valor lista de strings de uma propriedade

Parameters:

propName - o nome

Returns:

a lista

getBooleanSpecificProperty

public final boolean getBooleanSpecificProperty(String propName,
                                                boolean defaultValue)

Consulta o valor booleano de uma propriedade

Parameters:

propName - o nome

defaultValue - o valor default

Returns:

a propriedade

getDoubleSpecificProperty

public final double getDoubleSpecificProperty(String propName,
                                              double defaultValue)

Consulta o valor double de uma propriedade

Parameters:

propName - o nome

defaultValue - o valor default

Returns:

a propriedade

sendMessage

@Deprecated
public void sendMessage(String name,
                                    Object value,
                                    String senderId)

Deprecated. Sua implementação deve ser movida para os métodos onAsyncMessageReceived(String, Object, String) e onSyncMessageReceived(String, Object, String). Para enviar uma mensagem diretamente a uma aplicação, utilizar ApplicationManager.sendAsyncMessage(String, String, Object, String) ou ApplicationManager.sendSyncMessage(String, String, Object, String).

Método para enviar atributos para uma aplicação; deve ser definido na aplicação de acordo com a necessidade da mesma.

Parameters:

name - nome do atributo.

value - seu valor.

senderId - a identificação da aplicação que enviou a mensagem.

onAsyncMessageReceived

protected void onAsyncMessageReceived(String type,
                                      Object value,
                                      String senderId)

Trata uma mensagem assíncrona recebida pela aplicação. [ATENÇÃO] Este método *não* deve ser chamado explicitamente para enviar mensagem para a aplicação. Somente o ApplicationManager deve usá-lo. A aplicação poderá receber uma mensagem a qualquer momento de sua execução. O remetente da mensagem pode ser outra aplicação, representada pelo parâmetro senderId ou o próprio ambiente, nesse caso o parâmetro senderId vem nulo. Uma mesma aplicação pode receber diferentes tipos de mensagem, definidos por type. O valor da mensagem é definido em value.

Parameters:

type - tipo da mensagem recebida.

value - valor da mensagem recebida.

senderId - o id da instância da aplicação que enviou a mensagem. (pode ser null - caso a mensagem tenha vindo do sistema, por exemplo)

onSyncMessageReceived

protected Object onSyncMessageReceived(String type,
                                       Object value,
                                       String senderId)

Trata uma mensagem síncrona recebida pela aplicação. [ATENÇÃO] Este método *não* deve ser chamado explicitamente para enviar mensagem para a aplicação. Somente o ApplicationManager deve usá-lo. A aplicação poderá receber uma mensagem a qualquer momento de sua execução. O remetente da mensagem pode ser outra aplicação, representada pelo parâmetro senderId ou o próprio ambiente, nesse caso o parâmetro senderId vem nulo. Uma mesma aplicação pode receber diferentes tipos de mensagem, definidos por type. O valor da mensagem é definido em value.

Parameters:

type - tipo da mensagem recebida.

value - valor da mensagem recebida.

senderId - o id da instância da aplicação que enviou a mensagem. (pode ser null - caso a mensagem tenha vindo do sistema, por exemplo)

Returns:

o objeto de resposta.

postInitialization

public void postInitialization()
                        throws ApplicationException

Método que sinaliza a aplicação que ela já foi iniciada.

Throws:

ApplicationException - em caso de falha.

killApplication

public abstract void killApplication()
                              throws ApplicationException

Método para encerramento da execução, que pode ser redefinido para comportamentos próprios da aplicações.

Throws:

ApplicationException - em caso de erro no fechamento da applicação.

startApplication

public abstract void startApplication()
                               throws ApplicationException

Método abstrato para abertura do diálogo das aplicações

Throws:

ApplicationException - Em caso de erro ao iniciar a aplicação.

finishApplication

public abstract void finishApplication()

Método abstrato para fechamento do diálogo das aplicações

closeApplication

public final boolean closeApplication()

Método abstrato para fechamento da aplicação.

Returns:

um flag indicativo de sucesso no fechamento.

getMainApplicationClass

protected Class<?> getMainApplicationClass()

Obtém a classe principal da aplicação.

Returns:

a classe principal.

getImageIcon

public static final ImageIcon getImageIcon(Class<?> baseClass,
                                           String imagePath)

Busca uma imagem para a aplicação. A versão não estática deste método deve ser preferida, quando uma instância da aplicação está disponível: getImageIcon(String).

Parameters:

baseClass - classe base para busca do recurso.

imagePath - caminho dentro do diretório de imagens da aplicação.

Returns:

a imagem ou null

getApplicationResourceAsURL

public static final URL getApplicationResourceAsURL(Class<?> baseClass,
                                                    String path)

Busca um stream de um resource da aplicação. A versão não estática deste método deve ser preferida, quando uma instância da aplicação está disponível: getApplicationResourceAsURL(String).

Parameters:

baseClass - classe base para busca do recurso.

path - path relativo dentro do diretório 'resources'

Returns:

o stream.

getApplicationResourceAsStream

public static final InputStream getApplicationResourceAsStream(Class<?> baseClass,
                                                               String path)

Busca um stream de um resource da aplicação. A versão não estática deste método deve ser preferida, quando uma instância da aplicação está disponível: getApplicationResourceAsStream(String).

Parameters:

baseClass - classe base para busca do recurso.

path - path relativo dentro do diretório 'resources'

Returns:

o stream.

getImageIcon

public final ImageIcon getImageIcon(String imagePath)

Busca uma imagem para a aplicação.

Parameters:

imagePath - caminho dentro do diretório de imagens da aplicação.

Returns:

a imagem ou null

getApplicationResourceAsURL

public final URL getApplicationResourceAsURL(String path)

Busca um stream de um resource da aplicação.

Parameters:

path - path relativo dentro do diretório 'resources'

Returns:

o stream.

getApplicationResourceAsStream

public final InputStream getApplicationResourceAsStream(String path)

Busca um stream de um resource da aplicação.

Parameters:

path - path relativo dentro do diretório 'resources'

Returns:

o stream.

userCanKillApplication

protected abstract boolean userCanKillApplication()

Método de kill pelo usuário é específico do desktop applications

Returns:

um flag indicativo de possibilidade de fechamento da aplicação.