RelatorioTemplate (siga-doc 1.2-SNAPSHOT API)

java.lang.Object
- ar.com.fdvs.dj.domain.builders.DynamicReportBuilder
- - br.gov.jfrj.relatorio.dinamico.AbstractRelatorioBaseBuilder
  - - br.gov.jfrj.relatorio.dinamico.RelatorioRapido
    - - br.gov.jfrj.relatorio.dinamico.RelatorioTemplate

Direct Known Subclasses:

AcessoServicoRelatorio, AlteracaoDireitosRelatorio, HistoricoUsuarioRelatorio, PermissaoUsuarioRelatorio, RelatorioDocumentosSubordinados, RelatorioModelos, RelClassificacao, RelConsultaDocEntreDatas, RelDocsClassificados, RelDocSubordinadosCriados, RelEstatisticaProcedimento, RelMovCad, RelMovimentacao, RelMovimentacaoDocSubordinados, RelMovProcesso, RelOrgao, RelTempoDoc, RelTempoDocDetalhado, RelTipoDoc, SrRelAtendimento, SrRelPrazo
```
public abstract class RelatorioTemplate
extends RelatorioRapido
```
USE ESTA CLASSE para a criação de relatórios rápidos.
Procedimentos para criar relatorios no siga-ex
RESUMO:
1) Criar a classe do relatório (extends RelatorioTemplate)
2) Implementar os métodos:
2.1) construtor passando um Map <-- Com o parâmentros que podem ser usados no relatório.
2.2) configurarRelatorio() <-- Para definir o layout do relatório.
2.3) processarDados() <-- Para gerar um Set ou List contendo os dados do relatório.
3) Usar o relatório:
Exemplo: MeuRelatorio r = new MeuRelatorio(null); r.gerar(); JasperViewer.viewReport(r.getRelatorioJasperPrint());

A) Crie a classe do relatorio
a.1) Crie um builder baseado no AbstractRelatorioBaseBuilder caso não use o RelatorioTemplate ou RelatorioRapido
a.2) Crie a classe do relatorio baseada no template (br.gov.jfrj.siga.ex.relatorio.dinamico.RelatorioTemplate.java)

1) Crie o menu do relatório (/sigaex/WebContent/paginas/menus/menu.jsp)
Exemplo:
namespace="/expediente/rel">
relModelos.jsp
Relatório de Modelos

emiteRelNOME_DO_RELATORIO
NOME_DO_RELATORIO
relNOME_DO_RELATORIO.jsp

.jsp

4) Crie a action no xwork.xml
4.1) Informe o nome da action (emiteRel...)
4.2) Informe a classe (br.gov.jfrj.webwork.action.ExRelatorioAction)
4.3) Informe o método que tratará o relatório
4.5) Informe o result name = relatorio
4.6) Informe o contentType = application/pdf
4.7) Informe o inputName = inputStream

Ex:

class="br.gov.jfrj.webwork.action.ExRelatorioAction"
method="aRelDocumentosSubordinados">

application/pdf
inputStream

5) No br.gov.jfrj.webwork.action.ExRelatorioAction.java inclua o método que vai gerar o relatório
5.1) Use um código como esse para gerar o relatorio

public String aRelDocumentosSubordinados() throws Exception {

Map parametros = new HashMap(); <-- Para passar parâmetros para o relatório

Obrigatório para RelatórioRapido--->parametros.put("secaoUsuario",getRequest() .getParameter("secaoUsuario"));

parametros.put("lotacao",getRequest().getParameter( "lotacaoDestinatarioSel.sigla"));
parametros.put("tipoFormaDoc", getRequest().getParameter("tipoFormaDoc"));
parametros.put("incluirSubordinados", getRequest().getParameter("incluirSubordinados"));
parametros.put("lotacaoTitular", getRequest().getParameter("lotacaoTitular"));
parametros.put("orgaoUsuario",getRequest().getParameter("orgaoUsuario"));
parametros.put("link_siga","http://" + getRequest().getServerName() + ":"
+ getRequest().getServerPort()
+ getRequest().getContextPath() + "/app/expediente/doc/exibir?id=");

RelatorioDocumentosSubordinados rel = new RelatorioDocumentosSubordinados(parametros);

rel.gerar();

this.setInputStream(new ByteArrayInputStream( rel.getRelatorioPDF()));

return "relatorio";

5.1) Na última linha do método coloque (return "relatorio";)

DICA: Para testar o relatório na própria classe, use o método main. Exemplo
public static void main(String[] args){

try {
RelatorioEstatisticaProcedimento rep = new RelatorioEstatisticaProcedimento(null);
rep.gerar();
JasperViewer.viewReport(rep.getRelatorioJasperPrint());
} catch (JRException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (DJBuilderException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

Author:: kpf

Field Summary

Fields
Modifier and Type Field and Description

protected AbstractRelatorioBaseBuilder relatorio
- Fields inherited from class br.gov.jfrj.relatorio.dinamico.RelatorioRapido
  CENTRO, DIREITA, ESQUERDA
- Fields inherited from class br.gov.jfrj.relatorio.dinamico.AbstractRelatorioBaseBuilder
  dr, ds, estiloColuna, estiloSubtitulo, estiloTitulo, estiloTituloColuna, estiloTituloGrupo, parametros
- Fields inherited from class ar.com.fdvs.dj.domain.builders.DynamicReportBuilder
  autoTexts, concatenatedReports, globalFooterCrosstabs, globalHeaderCrosstabs, globalVariablesGroup, groupFooterSubreports, groupHeaderSubreports, options, report

Fields
Modifier and Type	Field and Description
`protected AbstractRelatorioBaseBuilder`	`relatorio`

Constructor Summary

Constructors
Constructor and Description
`RelatorioTemplate(Map parametros)` Caso o relatório precise receber parâmetros, use o construtor para obrigar o utilizador do relatório a informá-los.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract AbstractRelatorioBaseBuilder`	`configurarRelatorio()` Classe que permite o uso do Design Pattern Template Method.
`void`	`gerar()`
`byte[]`	`getRelatorioExcel()`
`StringBuffer`	`getRelatorioHTML()`
`byte[]`	`getRelatorioPDF()` Método que gera o relatório em PDF.
`abstract Collection`	`processarDados()` Implemente este método para processar os dados que serão exibidos no relatório.

Methods inherited from class br.gov.jfrj.relatorio.dinamico.RelatorioRapido
addColuna, addColuna, addColuna, delColuna, getRelatorioJasperPrint, setColunaPercTotal, setColunaTotal, setDados

Methods inherited from class br.gov.jfrj.relatorio.dinamico.AbstractRelatorioBaseBuilder
copiarEstilo, setDadosColecaoMap

Methods inherited from class ar.com.fdvs.dj.domain.builders.DynamicReportBuilder
addAutoText, addAutoText, addAutoText, addAutoText, addAutoText, addAutoText, addAutoText, addAutoText, addAutoText, addChart, addChart, addColumn, addConcatenatedReport, addConcatenatedReport, addConcatenatedReport, addConcatenatedReport, addConcatenatedReport, addField, addField, addField, addFirstPageImageBanner, addFirstPageImageBanner, addFont, addFooterCrosstab, addGlobalColumnVariable, addGlobalColumnVariable, addGlobalColumnVariable, addGlobalColumnVariable, addGlobalColumnVariable, addGlobalColumnVariable, addGlobalFooterVariable, addGlobalFooterVariable, addGlobalFooterVariable, addGlobalFooterVariable, addGlobalFooterVariable, addGlobalFooterVariable, addGlobalHeaderVariable, addGlobalHeaderVariable, addGlobalHeaderVariable, addGlobalHeaderVariable, addGlobalHeaderVariable, addGlobalHeaderVariable, addGlobalVariable, addGlobalVariable, addGlobalVariable, addGroup, addHeaderCrosstab, addImageBanner, addImageBanner, addParameter, addResourceBundle, addStyle, addSubreportInGroup, addSubreportInGroup, addSubreportInGroupFooter, addSubreportInGroupFooter, addSubreportInGroupFooter, addSubreportInGroupFooter, addSubreportInGroupFooter, addSubreportInGroupFooter, addSubreportInGroupFooter, addSubreportInGroupHeader, addSubreportInGroupHeader, addSubreportInGroupHeader, addSubreportInGroupHeader, addSubreportInGroupHeader, addSubreportInGroupHeader, addSubreportsToGroups, addVariable, build, concatenateReports, getColumn, getColumns, getFields, getGroup, setAllowDetailSplit, setBottomMargin, setBottomMargin, setColspan, setColspan, setColumnSpace, setColumnSpace, setColumnsPerPage, setColumnsPerPage, setColumnsPerPage, setColumnsPerPage, setDefaultStyles, setDetailHeight, setDetailHeight, setFooterHeight, setFooterHeight, setFooterVariablesHeight, setFooterVariablesHeight, setGlobalFooterVariableHeight, setGlobalHeaderVariableHeight, setGrandTotalLegend, setGrandTotalLegendStyle, setHeaderHeight, setHeaderHeight, setHeaderVariablesHeight, setIgnorePagination, setLanguage, setLeftMargin, setLeftMargin, setMargins, setOddRowBackgroundStyle, setPageSizeAndOrientation, setPrintBackgroundOnOddRows, setPrintBackgroundOnOddRows, setPrintColumnNames, setProperty, setQuery, setReportLocale, setReportName, setResourceBundle, setRightMargin, setRightMargin, setShowDetailBand, setSubtitle, setSubtitleHeight, setSubtitleStyle, setTemplateFile, setTemplateFile, setTitle, setTitle, setTitleHeight, setTitleIsJrExpression, setTitleStyle, setTopMargin, setTopMargin, setUseFullPageWidth, setUseFullPageWidth, setWhenNoData, setWhenNoData, setWhenNoDataAllSectionNoDetail, setWhenNoDataBlankPage, setWhenNoDataNoPages, setWhenNoDataShowNoDataSection, setWhenNoDataType, setWhenResourceMissing, setWhenResourceMissingLeaveEmptySpace, setWhenResourceMissingReturnNull, setWhenResourceMissingShowKey, setWhenResourceMissingThrowException

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - relatorio
```
protected AbstractRelatorioBaseBuilder relatorio
```
- Constructor Detail
  - RelatorioTemplate
```
public RelatorioTemplate(Map parametros)
                  throws ar.com.fdvs.dj.domain.builders.DJBuilderException
```
    Caso o relatório precise receber parâmetros, use o construtor para obrigar o utilizador do relatório a informá-los. O ideal é que as validações dos parâmetros sejam feitas aqui no construtor
    Exemplo:
    public RelatorioDocumentosSubordinados(Map parametros) throws DJBuilderException { super(parametros); if (parametros.get("secaoUsuario") == null){ throw new DJBuilderException("Parâmetro secaoUsuario não informado!"); } if (parametros.get("link_siga") == null){ throw new DJBuilderException("Parâmetro link_siga não informado!"); } }
    
    Throws:
    
    ar.com.fdvs.dj.domain.builders.DJBuilderException
- Method Detail
  - gerar
```
public void gerar()
           throws Exception
```
    Throws:
    
    Exception
  - configurarRelatorio
```
public abstract AbstractRelatorioBaseBuilder configurarRelatorio()
                                                          throws ar.com.fdvs.dj.domain.builders.DJBuilderException,
                                                                 net.sf.jasperreports.engine.JRException,
                                                                 ar.com.fdvs.dj.domain.builders.ColumnBuilderException
```
    Classe que permite o uso do Design Pattern Template Method. Implemente este método para definir o desenho do relatório usando um builder. Use a classe RelatorioRapido como builder para gerar relatórios rápidos.
    Caso queira um builder de relatório personalizado, estenda a classe AbstractRelatorioBaseBuilder.
    
    Exemplo:
    public AbstractRelatorioBaseBuilder configurarRelatorio() throws DJBuilderException, JRException { this.setTitle("Relatório de Documentos em Setores Subordinados"); this.addColuna("Setor", 0,RelatorioRapido.ESQUERDA,true); this.addColuna("Documento", 25,RelatorioRapido.ESQUERDA,false,true); this.addColuna("Descrição", 50,RelatorioRapido.ESQUERDA,false); this.addColuna("Responsável", 30,RelatorioRapido.ESQUERDA,false); this.addColuna("Situação", 30,RelatorioRapido.ESQUERDA,false); return this; }
    
    Returns:
    Retorna um builder de relatórios.
    
    Throws:
    
    ar.com.fdvs.dj.domain.builders.DJBuilderException
    
    net.sf.jasperreports.engine.JRException
    
    ar.com.fdvs.dj.domain.builders.ColumnBuilderException
  - processarDados
```
public abstract Collection processarDados()
                                   throws Exception
```
    Implemente este método para processar os dados que serão exibidos no relatório. É neste método que se faz as consultas a um banco de dados, por exemplo.
    CUIDADO: A coleção de dados deve ser ordenada, senão os dados vão aparecer desordenados no relatório. Exemplo:
    public Collection processarDados() { List d = new LinkedList(); Query q = HibernateUtil.getSessao().createQuery("from ExModelo order by exFormaDocumento.descrFormaDoc"); for (Iterator iterator = q.list().iterator(); iterator.hasNext();) { ExModelo modelo = (ExModelo) iterator.next(); d.add(modelo.getExFormaDocumento().getDescrFormaDoc()); d.add(modelo.getNmMod()); d.add(modelo.getExClassificacao().getSigla()); d.add(modelo.getExClassCriacaoVia().getSigla()); } return d; }
    
    Returns:
    Retorna um Collection contendo os dados do relatório.
    
    Throws:
    
    Exception
  - getRelatorioPDF
```
public byte[] getRelatorioPDF()
                       throws net.sf.jasperreports.engine.JRException
```
    Método que gera o relatório em PDF.
    
    Throws:
    
    net.sf.jasperreports.engine.JRException
  - getRelatorioHTML
```
public StringBuffer getRelatorioHTML()
                              throws net.sf.jasperreports.engine.JRException
```
    Throws:
    
    net.sf.jasperreports.engine.JRException
  - getRelatorioExcel
```
public byte[] getRelatorioExcel()
                         throws net.sf.jasperreports.engine.JRException,
                                IOException
```
    Throws:
    
    net.sf.jasperreports.engine.JRException
    
    IOException

Class RelatorioTemplate

Field Summary

Fields inherited from class br.gov.jfrj.relatorio.dinamico.RelatorioRapido

Fields inherited from class br.gov.jfrj.relatorio.dinamico.AbstractRelatorioBaseBuilder

Fields inherited from class ar.com.fdvs.dj.domain.builders.DynamicReportBuilder

Constructor Summary

Method Summary

Methods inherited from class br.gov.jfrj.relatorio.dinamico.RelatorioRapido

Methods inherited from class br.gov.jfrj.relatorio.dinamico.AbstractRelatorioBaseBuilder

Methods inherited from class ar.com.fdvs.dj.domain.builders.DynamicReportBuilder

Methods inherited from class java.lang.Object

Field Detail

relatorio

Constructor Detail

RelatorioTemplate

Method Detail

gerar

configurarRelatorio

processarDados

getRelatorioPDF

getRelatorioHTML

getRelatorioExcel