DataReport (JavaBeanStack-Business 1.2.0 API)

java.lang.Object
- org.javabeanstack.report.DataReport

public class DataReport
extends Object

Crea y ejecuta una sentencia sql devolviendo los datos solicitados.
Se estructura de la siguiente manera.

 select {columnsGroup1}, {columnsGroup2}, {columnsGroup3}, {columns}
    from {instrucción generada a partir de entityRoot y entityToJoin
          en la innerclass EntitiesToRelation y EntitiesRelation}
    where {whereFilter}
    order by {orderBy}
    group by {groupBy}

 El test unitario se encuentra en TestProjects clase
     py.com.oym.test.data.TestDataReport

Author:: Jorge Enciso

Field Summary

Fields
Modifier and Type Field and Description

protected Map<String,Object> preference1

protected Map<String,Object> preference2

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`preference1`
`protected Map<String,Object>`	`preference2`

Constructor Summary

Constructors
Constructor and Description

DataReport()

DataReport(IDataLink dao)

Constructors
Constructor and Description
`DataReport()`
`DataReport(IDataLink dao)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`afterCreateSentence()`
`protected List<IDataQueryModel>`	`afterExecuteSqlSentence(List<IDataQueryModel> result)`
`protected void`	`beforeCreateSentence()`
`protected void`	`beforeExecuteSqlSentence()`
`IDataNativeQuery`	`createDataNativeQuery(IDataNativeQuery query)` Genera la sentencia sql a partir de los parámetros asignados (columnsGroup1, columnsGroup2, columns, entityRoot, entitiesToJoin, entitiesAlias, whereFilter, orderBy, groupBy), el valor resultante asigna en el atributo sqlSentence y en el objeto query que luego será utilizado en executeSqlSentence.
`String`	`createGroupBy(String columns)`
`void`	`createSqlSentence()` Genera la sentencia sql a partir de los parámetros asignados (columnsGroup1, columnsGroup2, columns, entityRoot, entitiesToJoin, entitiesAlias, whereFilter, orderBy, groupBy), el valor resultante asigna en el atributo sqlSentence y en el objeto query que luego será utilizado en sqlSentenceExecute.
`List<IDataQueryModel>`	`executeSqlSentence()` Ejecuta la sentencia sql generada previamente en el metodo createSqlSentence.
`String`	`getColumns()` Lista de columnas
`String`	`getColumnsGroup1()` Primer grupo de columnas
`String`	`getColumnsGroup2()` Segundo grupo de columnas
`String`	`getColumnsGroup3()` Tercer grupo de columnas
`IDataLink`	`getDataLink()` Devuelve objeto para acceso a la base de datos
`int`	`getDateGroup()`
`String`	`getDocument()`
`String`	`getEntitiesAlias()` EntitiesAlias es la una lista de entidades (tablas, vistas) que tienen asignado un alias, por la cual serán referenciados en la sentencia sql
`String`	`getEntitiesToJoin()` Lee la lista de entidades (tablas, vistas) que se utilizarán en la consulta
`String`	`getEntityRoot()` Devuelve la entidad raiz a partir de la cual se realizarán los joins para construir la sentencia sql.
`String`	`getGroupBy()` Devuelve lista de campos del group by si lo tuviere
`Map<String,Object>`	`getJasperParams()`
`String`	`getOrderBy()` Devuelve la expresión order by asignada
`IDataNativeQuery`	`getQuery()`
`Integer`	`getReportNumber()` Devuelve el nro de reporte generado.
`String`	`getSqlSentence()` Devuelve la sentencia generada, previamente debio ejecutarse el metodo createSqlSentence().
`IDataExpression`	`getWhereFilter()` Devuelve la condición de filtros de la sentencia sql.
`void`	`init(Map<String,Object> preference1, Map<String,Object> preference2)`
`void`	`setColumns(String columns)` Asigna la lista de columnas
`void`	`setColumnsGroup1(String columnsGroup1)` Asigna el primer grupo de columnas
`void`	`setColumnsGroup2(String columnsGroup2)` Asigna el segundo grupo de columnas
`void`	`setColumnsGroup3(String columnsGroup3)` Asigna el tercer grupo de columnas
`void`	`setDataLink(IDataLink dataLink)` Asigna el objeto para acceso a la base de datos
`void`	`setDateGroup(int dateGroup)`
`void`	`setDocument(String document)`
`void`	`setEntitiesAlias(String entitiesAlias)` Asigna la lista de entidades ej. item a, vendedor b
`void`	`setEntitiesToJoin(String entitiesToJoin)` Asigna la lista de entidades (tablas, vistas) que se utilizarán en la sentencia
`void`	`setEntityRoot(String entityRoot)` Asigna la entidad raiz de la sentencia sql.
`void`	`setGroupBy(String groupBy)` Asigna la expresión group by para la sentencia sql.
`void`	`setOrderBy(String orderBy)` Asigna la expresión order by
`protected void`	`setProperties()` Acomoda los valores previo a ejecutar el metodo sqlSentenciaCreate()
`protected void`	`setQuery(IDataNativeQuery query)`
`protected void`	`setSqlSentence(String sqlSentence)` Asigna la propiedad sqlSentence
`void`	`setWhereFilter(IDataExpression whereFilter)` Setea la condición where de la sentencia sql.

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

- Field Detail
  - preference1
```
protected Map<String,Object> preference1
```
  - preference2
```
protected Map<String,Object> preference2
```
- Constructor Detail
  - DataReport
```
public DataReport()
```
  - DataReport
```
public DataReport(IDataLink dao)
```
- Method Detail
  - getDateGroup
```
public int getDateGroup()
```
  - setDateGroup
```
public void setDateGroup(int dateGroup)
```
  - init
```
public void init(Map<String,Object> preference1,
                 Map<String,Object> preference2)
```
  - getDataLink
```
public final IDataLink getDataLink()
```
    Devuelve objeto para acceso a la base de datos
    
    Returns:
    
    objeto para acceso a la base de datos
  - getQuery
```
public IDataNativeQuery getQuery()
```
  - setQuery
```
protected void setQuery(IDataNativeQuery query)
```
  - setDataLink
```
public final void setDataLink(IDataLink dataLink)
```
    Asigna el objeto para acceso a la base de datos
    
    Parameters:
    
    dataLink - objeto manejador de datos.
  - getColumnsGroup1
```
public final String getColumnsGroup1()
```
    Primer grupo de columnas
    
    Returns:
    
    Primer grupo de columnas
  - setColumnsGroup1
```
public final void setColumnsGroup1(String columnsGroup1)
```
    Asigna el primer grupo de columnas
    
    Parameters:
    
    columnsGroup1 - primer grupo de columnas
  - getColumnsGroup2
```
public final String getColumnsGroup2()
```
    Segundo grupo de columnas
    
    Returns:
    
    Segundo grupo de columnas
  - setColumnsGroup2
```
public final void setColumnsGroup2(String columnsGroup2)
```
    Asigna el segundo grupo de columnas
    
    Parameters:
    
    columnsGroup2 - segundo grupo de columnas
  - getColumnsGroup3
```
public final String getColumnsGroup3()
```
    Tercer grupo de columnas
    
    Returns:
    
    Tercer grupo de columnas
  - setColumnsGroup3
```
public final void setColumnsGroup3(String columnsGroup3)
```
    Asigna el tercer grupo de columnas
    
    Parameters:
    
    columnsGroup3 - primer grupo de columnas
  - getColumns
```
public final String getColumns()
```
    Lista de columnas
    
    Returns:
    
    lista de columnas
  - setColumns
```
public final void setColumns(String columns)
```
    Asigna la lista de columnas
    
    Parameters:
    
    columns -
  - getEntitiesToJoin
```
public final String getEntitiesToJoin()
```
    Lee la lista de entidades (tablas, vistas) que se utilizarán en la consulta
    
    Returns:
    
    lista de entidades
  - setEntitiesToJoin
```
public final void setEntitiesToJoin(String entitiesToJoin)
```
    Asigna la lista de entidades (tablas, vistas) que se utilizarán en la sentencia
    
    Parameters:
    
    entitiesToJoin -
  - getEntityRoot
```
public final String getEntityRoot()
```
    Devuelve la entidad raiz a partir de la cual se realizarán los joins para construir la sentencia sql.
    
    Returns:
    
    entidad raiz.
  - setEntityRoot
```
public final void setEntityRoot(String entityRoot)
```
    Asigna la entidad raiz de la sentencia sql.
    
    Parameters:
    
    entityRoot -
  - getEntitiesAlias
```
public final String getEntitiesAlias()
```
    EntitiesAlias es la una lista de entidades (tablas, vistas) que tienen asignado un alias, por la cual serán referenciados en la sentencia sql
    
    Returns:
    
    lista separada con coma de entidades con sus alias
  - setEntitiesAlias
```
public final void setEntitiesAlias(String entitiesAlias)
```
    Asigna la lista de entidades
    ej. item a, vendedor b
    
    Parameters:
    
    entitiesAlias - (
  - getDocument
```
public final String getDocument()
```
  - setDocument
```
public final void setDocument(String document)
```
  - getWhereFilter
```
public final IDataExpression getWhereFilter()
```
    Devuelve la condición de filtros de la sentencia sql.
    
    Returns:
    
    condición where.
  - setWhereFilter
```
public final void setWhereFilter(IDataExpression whereFilter)
```
    Setea la condición where de la sentencia sql.
    
    Parameters:
    
    whereFilter -
  - getGroupBy
```
public final String getGroupBy()
```
    Devuelve lista de campos del group by si lo tuviere
    
    Returns:
    
    lista de campos del group by
  - setGroupBy
```
public final void setGroupBy(String groupBy)
```
    Asigna la expresión group by para la sentencia sql.
    
    Parameters:
    
    groupBy -
  - getOrderBy
```
public final String getOrderBy()
```
    Devuelve la expresión order by asignada
    
    Returns:
    
    expresión order by
  - setOrderBy
```
public final void setOrderBy(String orderBy)
```
    Asigna la expresión order by
    
    Parameters:
    
    orderBy -
  - getReportNumber
```
public final Integer getReportNumber()
```
    Devuelve el nro de reporte generado.
    
    Returns:
    
    nro de reporte.
  - getSqlSentence
```
public String getSqlSentence()
```
    Devuelve la sentencia generada, previamente debio ejecutarse el metodo createSqlSentence().
    
    Returns:
    
    sentencia sql
  - setSqlSentence
```
protected void setSqlSentence(String sqlSentence)
```
    Asigna la propiedad sqlSentence
    
    Parameters:
    
    sqlSentence -
  - getJasperParams
```
public Map<String,Object> getJasperParams()
```
  - setProperties
```
protected void setProperties()
```
    Acomoda los valores previo a ejecutar el metodo sqlSentenciaCreate()
  - beforeCreateSentence
```
protected void beforeCreateSentence()
```
  - createSqlSentence
```
public void createSqlSentence()
```
    Genera la sentencia sql a partir de los parámetros asignados (columnsGroup1, columnsGroup2, columns, entityRoot, entitiesToJoin, entitiesAlias, whereFilter, orderBy, groupBy), el valor resultante asigna en el atributo sqlSentence y en el objeto query que luego será utilizado en sqlSentenceExecute.
  - afterCreateSentence
```
protected void afterCreateSentence()
```
  - createDataNativeQuery
```
public IDataNativeQuery createDataNativeQuery(IDataNativeQuery query)
```
    Genera la sentencia sql a partir de los parámetros asignados (columnsGroup1, columnsGroup2, columns, entityRoot, entitiesToJoin, entitiesAlias, whereFilter, orderBy, groupBy), el valor resultante asigna en el atributo sqlSentence y en el objeto query que luego será utilizado en executeSqlSentence.
    
    Parameters:
    
    query -
    
    Returns:
  - beforeExecuteSqlSentence
```
protected void beforeExecuteSqlSentence()
```
  - executeSqlSentence
```
public List<IDataQueryModel> executeSqlSentence()
                                         throws Exception
```
    Ejecuta la sentencia sql generada previamente en el metodo createSqlSentence.
    
    Returns:
    
    el resultado de la ejecución de la sentencia sql.
    
    Throws:
    
    Exception
  - afterExecuteSqlSentence
```
protected List<IDataQueryModel> afterExecuteSqlSentence(List<IDataQueryModel> result)
```
  - createGroupBy
```
public final String createGroupBy(String columns)
```

Class DataReport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

preference1

preference2

Constructor Detail

DataReport

DataReport

Method Detail

getDateGroup

setDateGroup

init

getDataLink

getQuery

setQuery

setDataLink

getColumnsGroup1

setColumnsGroup1

getColumnsGroup2

setColumnsGroup2

getColumnsGroup3

setColumnsGroup3

getColumns

setColumns

getEntitiesToJoin

setEntitiesToJoin

getEntityRoot

setEntityRoot

getEntitiesAlias

setEntitiesAlias

getDocument

setDocument

getWhereFilter

setWhereFilter

getGroupBy

setGroupBy

getOrderBy

setOrderBy

getReportNumber

getSqlSentence

setSqlSentence

getJasperParams

setProperties

beforeCreateSentence

createSqlSentence

afterCreateSentence

createDataNativeQuery

beforeExecuteSqlSentence

executeSqlSentence

afterExecuteSqlSentence

createGroupBy