Classe principal do framework BoxSQL que funciona como um fa�ade para todo as funcionalidades de template de execu��o de SQL do framework.
@see
Roteiro de uso:
1) - Para definir par�metros nas seten�as SQL, use o caractere # .
| EX: | select * from CLIENTES where UF = '#' |
ou
| EX: | select * from CLIENTES where UF = ':PARAMETRO' |
2) - Essa classe usa o padr�o SINGLETON portante dever� ser chamada usando atrav�s de BoxSQL.getIntance();
3) - Defina o caminho base com o diret�rio em forma de pacotes, onde se encontram os arquivos SQL.
| EX: | BoxSQL.getIntance().setCaminhoBase("/nomepacote/sub-pacote"); |
4) - Os par�metros s�o sequencias, ou seja, ser�o alimentados conforme a ordem que foram inseridos no arquivo SQL.
Para alimentar um valor para determinado par�metro, use a fun��o setParametro(),
| EX: | BoxSQL.getInstance().setParametro("PA"); |
5) - Use m�todo getTemplate() para obter a String gerada partir do arquivo de template,
| EX: | out.println(BoxSQL.getInstance().getTemplate("clientes.sql")); |
7) - Mapeamento Autom�tico de Par�mentros - Use m�todo getTemplate(nomeArquivo,Objeto) para obter a String gerada partir do arquivo de template, sendo que os valores dos paramentros da seten�a SQL ser�o preenchidos automaticamente, uma vez que o nome dos par�mentros seja o mesmo nome dos atributos do objeto, s� que todo em letras MAI�SCULAS.
| Exemplo de SQL com par�mentros para mapeamento : |
insert into CLIENTES values (:CODIGO,:NOME) |
| Exemplo de classe Bean: |
public classe Clientes { private int codigo; private String nome; public int getCodigo() { return codigo; } public String getNome() { return nome; } } |
| Exemplo de aplica��o do BoxSQL: |
Clientes cliente = new Clientes() cliente.setCodigo = "999"; cliente.setNome = "Emanuel Silva Pimentel"; metodoUpdateQualquer(BoxSQL.getInstance().getTemplate("clientes.sql",cliente)); |
9) - Log de templates processados Primeiro Passo - Defina o caminho e nome do arquivo de log que ser� criado pelo pr�prio BoxSQL Segundo Passo - Defina o m�todo setAtivaLog(true) Obs: Por motivo de desempenho, � sugerido que use esse recurso apenas em fase desenvolvimento. 10) - O m�todo getList pode ser usado para executar a instru��o SQL no SGDB e retornar uma cole��o de objetos com base nos registros. 11) - O m�todo executeUpdate, como o nome diz, executa a instru��o SQL no SGDB e retorna o n�mero de registros afetados
@since 15/11/2006
@version 1.06 (Release: 08/03/2007) (com DbUtils)
@author Manoel Pimentel, Felipe Rodrigues