org.javabeanstack.data

Class DataNativeQuery

java.lang.Object

org.javabeanstack.data.DataNativeQuery

All Implemented Interfaces:

IDataNativeQuery

public class DataNativeQuery
extends Object
implements IDataNativeQuery

Esta clase abstrae funcionalidades que permiten ejecutar sentencias nativas sobre la base de datos. El test unitario se encuentra en TestProjects clase py.com.oym.test.data.TestDataNativeQuery

Author:

Jorge Enciso

Constructor Summary

Constructors

Constructor and Description
DataNativeQuery()

Method Summary

Modifier and Type	Method and Description
IDataNativeQuery	addParam(String key, Object value) Agrega valores a los parámetros de la sentencia
IDataNativeQuery	addParams(Map<String,Object> params) Asigna los parámetros de la sentencia
static List<IDataQueryModel>	converToNativeQuery(List<Object> source, String columns) Convierte una lista de objetos al tipo IDataQueryModel
protected static String[]	convertToMatrix(String expr, String separator) Convierte una expresión en una matriz
void	createQuery() Crear la sentencia select a partir de todas los parámetros previos recibidos
String	createQuerySentence() Crear la sentencia select a partir de todas los parámetros previos recibidos
List<IDataQueryModel>	execQuery() Ejecuta la sentencia y devuelve una lista de registros
List<IDataQueryModel>	execQuery(IDataLink dataLink) Ejecuta la sentencia y devuelve una lista de registros
List<IDataQueryModel>	execQuery(int first, int maxResult) Ejecuta la sentencia y devuelve una lista de registros
IDataNativeQuery	from(IDataNativeQuery query, String alias) Asigna la/s entidad/es desde donde se extraeran la información.
IDataNativeQuery	from(String entities) Asigna la/s entidad/es desde donde se extraeran la información.
IDataNativeQuery	from(String query, String alias) Asigna la/s entidad/es desde donde se extraeran la información.
boolean	getApplyDBFilter()
static Class	getClassModel(String packagePath, String entity)
String	getColumnExpr()
String[]	getColumnList() Lista de columnas
Long	getCount() Retorna la cantidad de registros que resultaria de ejecutar la sentencia SELECT generada por esta clase.
IDataLink	getDataLink()
String	getEntityExpr()
String[]	getEntityList()
protected String	getEntityWithSchema(String entity)
String	getFilterExpr()
String[]	getFilterExprList()
String	getFilterGroupExpr()
String[]	getFilterGroupExprList() Devuelve la lista de filtros en la expresion having
String	getFromExpr()
String	getGroupExpr()
String[]	getGroupList()
protected String	getJoinEntityExpr()
protected String	getJoinExpr()
String	getOrderExpr()
String[]	getOrderList()
protected String	getQueryCount()
Map<String,Object>	getQueryParams()
String	getQuerySentence()
IDataNativeQuery	groupBy(String columnGroup) Asigna la expresión group by
IDataNativeQuery	having(String filterExpr) Asigna la expresión having
IDataNativeQuery	join(IDataNativeQuery subquery, String alias, String joinExpr) Asigna la/s entidad/es que formarán parte del join
IDataNativeQuery	join(String entity, String joinExpr) Asigna la/s entidad/es que formarán parte del join
IDataNativeQuery	leftJoin(String entity, String joinExpr) Asigna la/s entidad/es que formarán parte del join
IDataNativeQuery	orderBy(String columnOrder) Asigna la expresión order by
protected void	populateQueryParams(Map<String,Object> params)
IDataNativeQuery	select(String columns) Asigna la lista de columnas
void	setApplyDBFilter(boolean apply)
protected static String[]	setColumnLabel(String columns) Devuelve una matriz conteniendo los nombres de las columnas del cursor resultante del query
void	setDataLink(IDataLink dao) Asigna el objeto de acceso a los datos.
protected void	setDefaultParams() Agrega valores de parametros constantes (ej.
IDataNativeQuery	setQueryParams(Map<String,Object> params) Asigna los parámetros de la sentencia
IDataNativeQuery	where(IDataExpression dataExpr) Asigna los filtros en la expresión where.
IDataNativeQuery	where(IDataExpression dataExpr, Map<String,Object> params) Asigna los filtros en la expresión where.
IDataNativeQuery	where(String filterExpr) Asigna los filtros en la expresión where.
IDataNativeQuery	where(String filterExpr, Map<String,Object> params) Asigna los filtros en la expresión where.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataNativeQuery

public DataNativeQuery()

Method Detail

select

public IDataNativeQuery select(String columns)

Asigna la lista de columnas

Specified by:

select in interface IDataNativeQuery

Parameters:

columns - Son las columnas de la sentencia select

Returns:

objeto dataNativeQuery con la asignación de las columnas

from

public IDataNativeQuery from(String entities)

Asigna la/s entidad/es desde donde se extraeran la información.

Specified by:

from in interface IDataNativeQuery

Parameters:

entities - es la lista de entidades (tablas o vistas) forman parte de from, inner join

Returns:

objeto dataNativeQuery con la asignación de las entidades

from

public IDataNativeQuery from(IDataNativeQuery query,
                             String alias)

Asigna la/s entidad/es desde donde se extraeran la información.

Specified by:

from in interface IDataNativeQuery

Parameters:

query - objeto IDataNativeQuery cuya sentencia es utilizada como subquery dentro de la clausula FROM.

Returns:

objeto dataNativeQuery con la asignación de las entidades

from

public IDataNativeQuery from(String query,
                             String alias)

Asigna la/s entidad/es desde donde se extraeran la información.

Specified by:

from in interface IDataNativeQuery

Parameters:

query - objeto IDataNativeQuery cuya sentencia es utilizada como subquery dentro de la clausula FROM.

Returns:

objeto dataNativeQuery con la asignación de las entidades

join

public IDataNativeQuery join(String entity,
                             String joinExpr)

Asigna la/s entidad/es que formarán parte del join

Specified by:

join in interface IDataNativeQuery

Parameters:

entity - es la lista de entidad (tabla o vista)

joinExpr - la expresión del join.

Returns:

objeto dataNativeQuery con la asignación de las entidades

join

public IDataNativeQuery join(IDataNativeQuery subquery,
                             String alias,
                             String joinExpr)

Asigna la/s entidad/es que formarán parte del join

Specified by:

join in interface IDataNativeQuery

Parameters:

joinExpr - la expresión del join.

Returns:

objeto dataNativeQuery con la asignación de las entidades

leftJoin

public IDataNativeQuery leftJoin(String entity,
                                 String joinExpr)

Asigna la/s entidad/es que formarán parte del join

Specified by:

leftJoin in interface IDataNativeQuery

Parameters:

entity - entidad (tabla o vista)

joinExpr - la expresión del join.

Returns:

objeto dataNativeQuery con la asignación de las entidades

where

public IDataNativeQuery where(String filterExpr)

Asigna los filtros en la expresión where.

Specified by:

where in interface IDataNativeQuery

Parameters:

filterExpr - son los filtros

Returns:

objeto dataNativeQuery con la asignación de la expresión

where

public IDataNativeQuery where(String filterExpr,
                              Map<String,Object> params)

Asigna los filtros en la expresión where.

Specified by:

where in interface IDataNativeQuery

Parameters:

filterExpr - son los filtros

params - son los parametros del query

Returns:

objeto dataNativeQuery con la asignación de la expresión

where

public IDataNativeQuery where(IDataExpression dataExpr)

Asigna los filtros en la expresión where.

Specified by:

where in interface IDataNativeQuery

Parameters:

dataExpr - son los filtros

Returns:

objeto dataNativeQuery con la asignación de la expresión

where

public IDataNativeQuery where(IDataExpression dataExpr,
                              Map<String,Object> params)

Asigna los filtros en la expresión where.

Specified by:

where in interface IDataNativeQuery

Parameters:

dataExpr - son los filtros

params - son los parametros del query

Returns:

objeto dataNativeQuery con la asignación de la expresión

getClassModel

public static Class getClassModel(String packagePath,
                                  String entity)

orderBy

public IDataNativeQuery orderBy(String columnOrder)

Asigna la expresión order by

Specified by:

orderBy in interface IDataNativeQuery

Parameters:

columnOrder - lista de columnas por la que se va a ordenar el select

Returns:

objeto dataNativeQuery con la asignación de la expresión

groupBy

public IDataNativeQuery groupBy(String columnGroup)

Asigna la expresión group by

Specified by:

groupBy in interface IDataNativeQuery

Parameters:

columnGroup - lista de columnas group by

Returns:

objeto dataNativeQuery con la asignación de la expresión

having

public IDataNativeQuery having(String filterExpr)

Asigna la expresión having

Specified by:

having in interface IDataNativeQuery

Parameters:

filterExpr - filtros having

Returns:

objeto dataNativeQuery con la asignación de la expresión

addParam

public IDataNativeQuery addParam(String key,
                                 Object value)

Agrega valores a los parámetros de la sentencia

Specified by:

addParam in interface IDataNativeQuery

Parameters:

key - nombre del parámetro

value - valor del parámetro

Returns:

objeto dataNativeQuery con la asignación de los parámetros

addParams

public IDataNativeQuery addParams(Map<String,Object> params)

Asigna los parámetros de la sentencia

Specified by:

addParams in interface IDataNativeQuery

Parameters:

params - Map conteniendo los parámetros

Returns:

objeto dataNativeQuery con la asignación de los parámetros

setQueryParams

public IDataNativeQuery setQueryParams(Map<String,Object> params)

Asigna los parámetros de la sentencia

Specified by:

setQueryParams in interface IDataNativeQuery

Parameters:

params - Map conteniendo los parámetros

Returns:

objeto dataNativeQuery con la asignación de los parámetros

createQuery

public void createQuery()

Crear la sentencia select a partir de todas los parámetros previos recibidos

Specified by:

createQuery in interface IDataNativeQuery

getFromExpr

public final String getFromExpr()

Specified by:

getFromExpr in interface IDataNativeQuery

getJoinExpr

protected final String getJoinExpr()

getEntityWithSchema

protected final String getEntityWithSchema(String entity)

createQuerySentence

public String createQuerySentence()

Crear la sentencia select a partir de todas los parámetros previos recibidos

Specified by:

createQuerySentence in interface IDataNativeQuery

setDefaultParams

protected void setDefaultParams()

Agrega valores de parametros constantes (ej. :true=true, :false=false etc, :idempresa)

execQuery

public List<IDataQueryModel> execQuery()
                                throws SessionError

Ejecuta la sentencia y devuelve una lista de registros

Specified by:

execQuery in interface IDataNativeQuery

Returns:

devuelve una lista de registros

Throws:

SessionError

execQuery

public List<IDataQueryModel> execQuery(int first,
                                       int maxResult)
                                throws SessionError

Ejecuta la sentencia y devuelve una lista de registros

Specified by:

execQuery in interface IDataNativeQuery

Parameters:

first -

maxResult -

Returns:

devuelve una lista de registros

Throws:

SessionError

execQuery

public List<IDataQueryModel> execQuery(IDataLink dataLink)
                                throws SessionError

Ejecuta la sentencia y devuelve una lista de registros

Specified by:

execQuery in interface IDataNativeQuery

Parameters:

dataLink - objeto acceso a los datos.

Returns:

devuelve una lista de registros

Throws:

SessionError

converToNativeQuery

public static final List<IDataQueryModel> converToNativeQuery(List<Object> source,
                                                              String columns)

Convierte una lista de objetos al tipo IDataQueryModel

Parameters:

source - lista de registros

columns - lista de las etiquetas de las columnas

Returns:

devuelve misma lista de registros pero como tipo IDataQueryModel

setColumnLabel

protected static String[] setColumnLabel(String columns)

Devuelve una matriz conteniendo los nombres de las columnas del cursor resultante del query

Parameters:

columns -

Returns:

convertToMatrix

protected static String[] convertToMatrix(String expr,
                                          String separator)

Convierte una expresión en una matriz

Parameters:

expr - expresión

separator - separadores normalmente comas.

Returns:

devuelve una matriz

populateQueryParams

protected void populateQueryParams(Map<String,Object> params)

getColumnExpr

public String getColumnExpr()

Specified by:

getColumnExpr in interface IDataNativeQuery

Returns:

devuelve las columnas (porción select) del la sentencia

getColumnList

public String[] getColumnList()

Lista de columnas

Specified by:

getColumnList in interface IDataNativeQuery

Returns:

getEntityExpr

public String getEntityExpr()

Specified by:

getEntityExpr in interface IDataNativeQuery

Returns:

entidades (tablas y/o vistas)

getEntityList

public String[] getEntityList()

Specified by:

getEntityList in interface IDataNativeQuery

Returns:

lista de entidades

getFilterExpr

public String getFilterExpr()

Specified by:

getFilterExpr in interface IDataNativeQuery

Returns:

filtros (expresión where)

getFilterExprList

public String[] getFilterExprList()

Specified by:

getFilterExprList in interface IDataNativeQuery

Returns:

lista de filtros (expresión where)

getOrderExpr

public String getOrderExpr()

Specified by:

getOrderExpr in interface IDataNativeQuery

Returns:

expresión order by

getOrderList

public String[] getOrderList()

Specified by:

getOrderList in interface IDataNativeQuery

Returns:

lista de columnas order by

getGroupExpr

public String getGroupExpr()

Specified by:

getGroupExpr in interface IDataNativeQuery

Returns:

expresión group by

getGroupList

public String[] getGroupList()

Specified by:

getGroupList in interface IDataNativeQuery

Returns:

lista de columnas del group by

getFilterGroupExpr

public String getFilterGroupExpr()

Specified by:

getFilterGroupExpr in interface IDataNativeQuery

Returns:

expresión having

getFilterGroupExprList

public String[] getFilterGroupExprList()

Devuelve la lista de filtros en la expresion having

Specified by:

getFilterGroupExprList in interface IDataNativeQuery

Returns:

lista de filtros en la expresion having

getQuerySentence

public String getQuerySentence()

Specified by:

getQuerySentence in interface IDataNativeQuery

Returns:

la sentencia resultante de los parámetros recibidos.

getQueryParams

public Map<String,Object> getQueryParams()

Specified by:

getQueryParams in interface IDataNativeQuery

Returns:

parámetros

getDataLink

public IDataLink getDataLink()

Specified by:

getDataLink in interface IDataNativeQuery

Returns:

devuelve el objeto para acceso a datos.

setDataLink

public void setDataLink(IDataLink dao)

Asigna el objeto de acceso a los datos.

Specified by:

setDataLink in interface IDataNativeQuery

Parameters:

dao - objeto para acceder a los datos.

getCount

public Long getCount()
              throws Exception

Retorna la cantidad de registros que resultaria de ejecutar la sentencia SELECT generada por esta clase.

Specified by:

getCount in interface IDataNativeQuery

Returns:

Throws:

Exception

getQueryCount

protected String getQueryCount()

getJoinEntityExpr

protected String getJoinEntityExpr()

getApplyDBFilter

public boolean getApplyDBFilter()

Specified by:

getApplyDBFilter in interface IDataNativeQuery

setApplyDBFilter

public void setApplyDBFilter(boolean apply)

Specified by:

setApplyDBFilter in interface IDataNativeQuery