br.ufg.integrate.controller
Interface ControllerI

All Known Implementing Classes:

Controller, ControllerImpl

public interface ControllerI

Version:

0.1

Author:

Rogerio

Field Summary

static int	LOOKUP Define o uso do Controller para a tarefa de lookup (obtenção dos esquemas).
static int	WRAPPER Define o uso do Controller para a tarefa de wrapper (acesso às fontes de dados).

Method Summary

void	closeConnection(String integration) Encerra as conexões nas fontes de dados definidas na integração informada como argumento, cujo ID deve ser definido no arquivo 'integrations.xml'.
void	commit(DataSource dsTarget) Torna persistentes as alterações na fonte de dados informada.
void	commit(String integration) Torna persistentes as alterações nas fontes de dados definidas na integração informada como argumento, cujo ID deve ser definido no arquivo 'integrations.xml'.
ResultSet	executeIntegratedQuery(String target, String sql) Executa consulta integrada a uma fonte de dados de destino desejada (identificada pelo identificador definido no arquivo 'integrate-datasources.xml').
List<ResultSet>	executeQueryFile(String id, String queryFile) Executa consulta integrada, considerando as configurações efetuadas no arquivo 'integration.xml', identificada pelo id.
StringBuilder	executeQueryInXmlFormat(String[] targets, String[] queries) Executa consulta integrada, informando as fontes de dados de destino desejadas e as respectivas consultas, identificadas pelo identificador definido no arquivo 'integrate-datasources.xml'.
StringBuilder	executeQueryInXmlFormat(String target, String sql) Executa consulta integrada a uma fonte de dados de destino desejada (identificada pelo identificador definido no arquivo 'integrate-datasources.xml') e a respectiva consulta.
int	executeUpdate(String target, String sql) Executa uma atualização integrada a fontes de dados de destino desejadas (identificadas pelo identificador definido no arquivo 'integrate-datasources.xml').
Connection	getConnection(String idDataSource) Retorna um java.sql.Connection acessado pelo Wrapper identificado pelo argumento.
DataSources	getDataSources() Retorna um DataSources que empacota uma coleção de objetos do tipo DataSource.
String	getDriver(String idDataSource) Retorna o driver JDBC registrado no arquivo 'integrate-datasources.xml' para a fonte de dados identificada pelo id passado como argumento.
Integrations	getIntegrations() Retorna um Integrations, que empacota uma coleção de objetos do tipo Integration.
Mediator	getMediator() Retorna uma referência para classe que implementa a interface Mediator.
Map<String,String>	getParams() Retorna os parâmetros configurados no arquivo 'integrate-config.xml'.
long	getTime() Retorna o tempo de duração calculado durante o uso de alguma das funções de consulta que utiliza uma fonte de dados.
long	getTotalTime() Retorna o tempo de duração calculado durante o uso de alguma das funções de consulta que utilizam fontes de dados em conjunto.
String	getUrl(String idDataSource) Retorna a URL JDBC registrada no arquivo 'integrate-datasources.xml' para a fonte de dados identificada pelo id passado como argumento.
void	initAllParams(int useType) Carrega os parâmetros iniciais do sistema (integrate-config.xml) e os parâmetros das fontes de dados (integrate-datasources.xml os arquivos de definição da conversão do tipo de dados da fonte para os tipos aceitos em XML Schema).
void	initConfigParams() Carrega os parâmetros de configuração definidos no arquivo 'integrate-config.xml'.
void	initDataSourceParams() Carrega os parâmetros de configuração definidos no arquivo 'integrate-datasources.xml'.
void	initIntegrationParams() Carrega os parâmetros de configuração definidos no arquivo 'integrations.xml'.
StringBuilder	lookup() Acesso ao texto da conversão dos objetos em memória que representam os esquemas de todas as fontes de dados configuradas no arquivo 'integrate-datasources.xml'.
StringBuilder	lookup(DataSource ds) Acesso à variável que armazena o texto da conversão dos objetos em memória que representa o esquema de uma fonte de dados passada como argumento.
StringBuilder	lookup(String idDataSource) Acesso à variável que armazena o texto da conversão dos objetos em memória que representa o esquema de uma fonte de dados passada como argumento.
List<DatabaseMetaData>	lookupMetaData() Monta a coleção de esquemas obtidos das fontes de dados cadastradas no arquivo 'integrate-datasources.xml' e retorna uma coleção de metadados JDBC.
DatabaseMetaData	lookupMetaData(DataSource ds) Retorna o esquema obtido da fonte de dados informada.
DatabaseMetaData	lookupMetaData(String idDatasource) Retorna o esquema obtido da fonte de dados informada.
void	saveResultSetsToXmlFile(String[] targets, String[] queries, String xmlOutputFile) Gera uma coleção de ResultSets obtidos de consultas em um arquivo XML.
void	saveResultSetsToXmlFile(String idIntegration, String queryFile, String xmlOutputFile) Imprime o resultado gerado em formato XML em arquivo texto informado.
void	saveSchemasToXMLFile(String outputFile, boolean append) Cria um arquivo XML contendo os esquemas de todas as fontes de dados configuradas no arquivo 'integrate-datasource.xml'.
void	saveSchemaToXMLFile(String idDataSource, String outputFile, boolean append) Cria um arquivo XML contendo o esquema de uma das fontes de dados configuradas no arquivo 'integrate-datasource.xml', identificada pelo identificador passado como argumento.
void	setMediator() Gera uma referência para a classe que implementa a interface Mediator, cujo nome deve ser configurado no arquivo 'integrate-config.xml'.
void	start() Executa os passos necessários para iniciar a instância que implementa esta interface.
void	stop() Libera os recursos iniciados pelas instâncias da interface Lookup/Wrapper.
void	stop(String idDataSource) Libera os recursos iniciados pelas instâncias da interface Lookup/Wrapper.

Field Detail

LOOKUP

static final int LOOKUP

Define o uso do Controller para a tarefa de lookup (obtenção dos esquemas).

See Also:

Constant Field Values

WRAPPER

static final int WRAPPER

Define o uso do Controller para a tarefa de wrapper (acesso às fontes de dados).

See Also:

Constant Field Values

Method Detail

closeConnection

void closeConnection(String integration)
                     throws SQLException

Encerra as conexões nas fontes de dados definidas na integração informada como argumento, cujo ID deve ser definido no arquivo 'integrations.xml'.

Parameters:

integration - Integração registrada, que contém uma coleção de fontes de dados de destino

Throws:

SQLException

commit

void commit(DataSource dsTarget)
            throws SQLException

Torna persistentes as alterações na fonte de dados informada.

Parameters:

dsTarget - Fonte de dados de destino

Throws:

SQLException

commit

void commit(String integration)
            throws SQLException

Torna persistentes as alterações nas fontes de dados definidas na integração informada como argumento, cujo ID deve ser definido no arquivo 'integrations.xml'.

Parameters:

integration - Fonte de dados de destino

Throws:

SQLException

executeIntegratedQuery

ResultSet executeIntegratedQuery(String target,
                                 String sql)
                                 throws SQLException

Executa consulta integrada a uma fonte de dados de destino desejada (identificada pelo identificador definido no arquivo 'integrate-datasources.xml'). Se a fonte de dados de destino for a mesma da fonte de origem, esta recebe a consulta SQL diretamente. Caso contrário, a sentença SQL é convertida, através de serviço solicitado ao mediador.

Parameters:

target - Identificador da consulta integrada existente no arquivo 'integration.xml'

sql - Sentença SQL a ser executada.

Throws:

SQLException

executeQueryInXmlFormat

StringBuilder executeQueryInXmlFormat(String target,
                                      String sql)
                                      throws IntegrateException

Executa consulta integrada a uma fonte de dados de destino desejada (identificada pelo identificador definido no arquivo 'integrate-datasources.xml') e a respectiva consulta.

Parameters:

target - Identificador da consulta integrada existente no arquivo 'integration.xml'

sql - Sentença SQL a ser executada, já no formato da respectiva fonte de dados.

Returns:

StringBuilder Texto que representa o resultado em formato XML.

Throws:

IntegrateException - Mesnagens de erro são gravadas no arquivo 'error.log'.

executeQueryInXmlFormat

StringBuilder executeQueryInXmlFormat(String[] targets,
                                      String[] queries)
                                      throws IntegrateException

Executa consulta integrada, informando as fontes de dados de destino desejadas e as respectivas consultas, identificadas pelo identificador definido no arquivo 'integrate-datasources.xml'. O resultado final é retornado em formato XML.

Parameters:

targets - Coleção de destinos, definidos no arquivo 'integrate-datasources.xml'.

queries - Coleção de consultas SQL, ordenadas na mesma seqüência da coleçã de fontes de dados (parâmetro 'targets').

Returns:

StringBuilder Texto que representa o resultado em formato XML. Os ResultSet's são ordenados pelo identificador.

Throws:

IntegrateException

executeQueryFile

List<ResultSet> executeQueryFile(String id,
                                 String queryFile)
                                 throws IntegrateException

Executa consulta integrada, considerando as configurações efetuadas no arquivo 'integration.xml', identificada pelo id. O arquivo de consulta infomado é validado pelo arquivo query.xsd antes do processamento.

Returns:

List Coleção de ResultSets obtidos das consultas solicitadas. Para montar esta coleção, o Integrate ordena os DataSources em ordem crescente do identificador. É nesta ordem que os ResultSets são inseridos na coleção.

Throws:

IntegrateException

executeUpdate

int executeUpdate(String target,
                  String sql)
                  throws SQLException

Executa uma atualização integrada a fontes de dados de destino desejadas (identificadas pelo identificador definido no arquivo 'integrate-datasources.xml'). Se a fonte de dados de destino for a mesma da fonte de origem, esta recebe a consulta SQL diretamente. Caso contrário, a sentença SQL é convertida, através de serviço solicitado ao mediador.

Parameters:

target - Identificador da consulta integrada existente no arquivo 'integration.xml'

sql - Sentença SQL a ser executada.

Throws:

SQLException

IntegrateException

getConnection

Connection getConnection(String idDataSource)
                         throws IntegrateException

Retorna um java.sql.Connection acessado pelo Wrapper identificado pelo argumento. Este identificador é um dos configurados previamente no arquivo 'integrate-datasources.xml'.

Throws:

IntegrateException

getDataSources

DataSources getDataSources()
                           throws IntegrateException

Retorna um DataSources que empacota uma coleção de objetos do tipo DataSource.

Returns:

DataSources Coleção de DataSource

Throws:

WrapperException - Se DataSources for null. Execute init() antes.

IntegrateException

getDriver

String getDriver(String idDataSource)
                 throws IntegrateException

Retorna o driver JDBC registrado no arquivo 'integrate-datasources.xml' para a fonte de dados identificada pelo id passado como argumento.

Returns:

Driver JDBC registrado para esta fonte de dados.

Throws:

IntegrateException - Caso haja algum erro ao acessar o arquivo 'integrate-datasources.xml'.

getIntegrations

Integrations getIntegrations()
                             throws IntegrateException

Retorna um Integrations, que empacota uma coleção de objetos do tipo Integration.

Returns:

Integrations Coleção de Integration

Throws:

WrapperException - Se Integrations for null. Execute init() antes.

IntegrateException

getMediator

Mediator getMediator()
                     throws IntegrateException

Retorna uma referência para classe que implementa a interface Mediator.

Returns:

Mediator Implementação da interface Mediator.

Throws:

IntegrateException - Caso haja erro ao carregar parâmetros do arquivo de configuração.

See Also:

Mediator

getParams

Map<String,String> getParams()
                             throws IntegrateException

Retorna os parâmetros configurados no arquivo 'integrate-config.xml'.

Throws:

IntegrateException

getTime

long getTime()

Retorna o tempo de duração calculado durante o uso de alguma das funções de consulta que utiliza uma fonte de dados. Se o valor retornado for 0 significa que estas funções não foram utilizadas, e esta variável não foi inicializada.

getTotalTime

long getTotalTime()

Retorna o tempo de duração calculado durante o uso de alguma das funções de consulta que utilizam fontes de dados em conjunto. Se o valor retornado for 0 significa que estas funções não foram utilizadas, e esta variável não foi inicializada.

getUrl

String getUrl(String idDataSource)
              throws IntegrateException

Retorna a URL JDBC registrada no arquivo 'integrate-datasources.xml' para a fonte de dados identificada pelo id passado como argumento.

Returns:

URL registrada para esta fonte de dados.

Throws:

IntegrateException - Caso haja algum erro ao acessar o arquivo 'integrate-datasources.xml'.

initAllParams

void initAllParams(int useType)
                   throws IntegrateException

Carrega os parâmetros iniciais do sistema (integrate-config.xml) e os parâmetros das fontes de dados (integrate-datasources.xml os arquivos de definição da conversão do tipo de dados da fonte para os tipos aceitos em XML Schema). Para carregar também as configurações das integrações desejadas (integration.xml), basta informar como argumento Controller.WRAPPER .

Throws:

WrapperException - Ver erros lançados pelo método loadTypes() da classe DataSource.

XMLException - Erro no parse dos arquivos de configuração ou dos datasources.

IntegrateException

initConfigParams

void initConfigParams()
                      throws IntegrateException

Carrega os parâmetros de configuração definidos no arquivo 'integrate-config.xml'. Erros na definição dos parâmetros são impressos no arquivo 'error.log'.

Throws:

IntegrateException

initDataSourceParams

void initDataSourceParams()
                          throws IntegrateException

Carrega os parâmetros de configuração definidos no arquivo 'integrate-datasources.xml'. Erros na definição dos parâmetros são impressos no arquivo 'error.log'.

Throws:

IntegrateException

initIntegrationParams

void initIntegrationParams()
                           throws IntegrateException

Carrega os parâmetros de configuração definidos no arquivo 'integrations.xml'. Erros na definição dos parâmetros são impressos no arquivo 'error.log'.

Throws:

IntegrateException

lookup

StringBuilder lookup()
                     throws IntegrateException

Acesso ao texto da conversão dos objetos em memória que representam os esquemas de todas as fontes de dados configuradas no arquivo 'integrate-datasources.xml'.

Returns:

StringBuilder Variável que empacota o texto a ser impresso.

Throws:

IntegrateException - Caso ocorra algum erro na preparação do arquivo XML de saída.

lookup

StringBuilder lookup(String idDataSource)
                     throws IntegrateException,
                            XMLException

Acesso à variável que armazena o texto da conversão dos objetos em memória que representa o esquema de uma fonte de dados passada como argumento.

Parameters:

idDataSource - identificador da fonte de dados(ver 'integrate-datasources.xml').

Returns:

StringBuilder Variável que empacota o texto a ser impresso.

Throws:

XMLException - Caso ocorra algum erro na preparação do arquivo XML de saída.

IntegrateException

lookup

StringBuilder lookup(DataSource ds)
                     throws IntegrateException,
                            XMLException

Acesso à variável que armazena o texto da conversão dos objetos em memória que representa o esquema de uma fonte de dados passada como argumento.

Parameters:

ds - DataSource que representa a fonte de dados(ver 'integrate-datasources.xml').

Returns:

StringBuilder Variável que empacota o texto a ser impresso.

Throws:

XMLException - Caso ocorra algum erro na preparação do arquivo XML de saída.

IntegrateException

lookupMetaData

List<DatabaseMetaData> lookupMetaData()
                                      throws IntegrateException

Monta a coleção de esquemas obtidos das fontes de dados cadastradas no arquivo 'integrate-datasources.xml' e retorna uma coleção de metadados JDBC.

Returns:

List Coleção de DatabaseMetaData.

Throws:

WrapperException

IntegrateException

lookupMetaData

DatabaseMetaData lookupMetaData(DataSource ds)
                                throws IntegrateException

Retorna o esquema obtido da fonte de dados informada.

Returns:

DatabaseMetaData referente ao DataSource informado.

Throws:

WrapperException

IntegrateException

lookupMetaData

DatabaseMetaData lookupMetaData(String idDatasource)
                                throws IntegrateException

Retorna o esquema obtido da fonte de dados informada.

Returns:

DatabaseMetaData DatabaseMetaData do datasource solicitado.

Throws:

IntegrateException

saveResultSetsToXmlFile

void saveResultSetsToXmlFile(String[] targets,
                             String[] queries,
                             String xmlOutputFile)
                             throws WrapperException

Gera uma coleção de ResultSets obtidos de consultas em um arquivo XML.

Throws:

WrapperException

saveResultSetsToXmlFile

void saveResultSetsToXmlFile(String idIntegration,
                             String queryFile,
                             String xmlOutputFile)
                             throws WrapperException

Imprime o resultado gerado em formato XML em arquivo texto informado.

Parameters:

idIntegration - Identificador da fonte de dados. Os ResultSet's são ordenados pelo identificador da fonte de dados.

queryFile - Arquivo que representa uma consulta, validada pelo 'query.xsd'.

xmlOutputFile - Nome do arquivo que será gerado.

Throws:

WrapperException

saveSchemasToXMLFile

void saveSchemasToXMLFile(String outputFile,
                          boolean append)
                          throws XMLException,
                                 IntegrateException

Cria um arquivo XML contendo os esquemas de todas as fontes de dados configuradas no arquivo 'integrate-datasource.xml'.

Parameters:

outputFile - Texto contendo caminho e nome do arquivo de saída desejado.

append - Informe 'true' caso deseje que a operação não sobrescreva o arquivo de saída, mas adicione o resultado no final do arquivo.

Throws:

XMLException

IntegrateException

saveSchemaToXMLFile

void saveSchemaToXMLFile(String idDataSource,
                         String outputFile,
                         boolean append)
                         throws XMLException,
                                IntegrateException

Cria um arquivo XML contendo o esquema de uma das fontes de dados configuradas no arquivo 'integrate-datasource.xml', identificada pelo identificador passado como argumento.

Parameters:

idDataSource - identificador da fonte de dados.

outputFile - Texto contendo caminho e nome do arquivo de saída desejado.

append - Informe 'true' caso deseje que a operação não sobrescreva o arquivo de saída, mas adicione o resultado no final do arquivo.

Throws:

XMLException

IntegrateException

setMediator

void setMediator()
                 throws IntegrateException

Gera uma referência para a classe que implementa a interface Mediator, cujo nome deve ser configurado no arquivo 'integrate-config.xml'.

Throws:

IntegrateException

start

void start()
           throws IntegrateException

Executa os passos necessários para iniciar a instância que implementa esta interface. É o primeiro método que deve ser executado.

Throws:

IntegrateException

stop

void stop()
          throws IntegrateException

Libera os recursos iniciados pelas instâncias da interface Lookup/Wrapper. Deve ser executada após o término das operações.

Throws:

WrapperException

IntegrateException

stop

void stop(String idDataSource)
          throws WrapperException

Libera os recursos iniciados pelas instâncias da interface Lookup/Wrapper. Deve ser executada após o término das operações.

Throws:

WrapperException