| java.lang.Object
 com.calipso.reportgenerator.common.ReportQuery
| ReportQuery | | public class ReportQuery implements Serializable(Code) | | Esta clase contiene la información necesaria para ejecutar una consulta a sobre los datos, especificando las,
agrupaciones, filtros, campos visibles, ordenamiento, etc.
|
| Constructor Summary | |
| public | ReportQuery(ReportSpec reportSpec)
| | public | ReportQuery(ReportSpec reportSpec, boolean defaultInitialize)
Inicializa una nueva Consulta permitiendo especificar si se desea que a las dimensiones y las métricas se les asignen
las propiedades por defecto que se obtienen de la definición del reporte.
Parameters:
reportSpec - Contiene la información necesaria para ubicar los datos de las dimensiones y las métricas dentrode las rows del DataSource.
Parameters:
defaultInitialize - true = valores de propiedades por defecto segun definición de reporte. | | public | ReportQuery(ReportSpec reportSpec, ReportView reportView)
|
| Method Summary | |
| public void | addFilters(Collection filters)
Agrega los filtros especificados al report spec. | | public void | clearQuery()
| | public void | excludeValue(int dimension, Object value)
| | public List | getAccumulableMetrics()
| | public List | getColumnDimensions()
| | protected ExpressionCubeFilter | getCubeFilter(Map params)
| | public CubeQuery | getCubeQuery()
Devuelve la query traducida a la forma que utiliza el módulo de cálculo de cubos. | | public int[] | getCubeVisibleMetricFields()
| | protected Map | getDimensionFilterValues()
| | public List | getDimensions()
| | public List | getDimensionsByLocation(DimensionDefinitionLocationType location)
Devuelve una lista con todas las dimensiones que agrupan según el parámetro location. | | public EnumerationCubeFilter | getEnumFilter()
| | public EnumerationCubeFilter | getExcludeGroupFilter()
| | public Set | getExcludedValues(int dimension)
| | protected List | getFilterDefinitions()
| | public int[] | getGroupingDimensionsIndexArray()
| | public List | getMetrics()
| | public List | getPageDimensions()
| | public Object | getParamValue(String key)
| | public Object | getParamValue(String filterName, String parameterName)
| | public Map | getParamValues()
| | public static Map | getParamValuesFromView(ViewParameterValues viewParameters, ReportSpec reportSpec)
| | public QueryDimension | getQueryDimensionFromName(String name)
| | public QueryMetric | getQueryMetricFromName(String name)
| | public EnumerationCubeFilter | getRankingFilter()
| | public ReportSpec | getReportSpec()
| | public List | getRowDimensions()
| | public StaticQuery | getStaticQuery()
Devuelve la query traducida a la forma que utiliza el módulo de cálculo de reportes estáticos. | | public List | getVisibleAccumulableMetrics()
| | public List | getVisibleMetrics()
| | public void | includeValue(int dimension, Object value)
| | public boolean | isValid()
| | public boolean | isVisibleTotals()
| | public void | removeFilters(Collection filters)
| | public void | setDimensionLocation(String name, DimensionDefinitionLocationType location)
| | public void | setDimensionLocationOrder(String name, int order)
| | public void | setDimensionLocationOrder(String name, int order, boolean updateOrders)
| | public void | setDimensionOrder(String name, DimensionDefinitionOrderType order)
| | public void | setDimensionProperties(String name, DimensionDefinitionLocationType location, DimensionDefinitionOrderType order, int locationOrder, String rankMetricName)
| | public void | setDimensionRankMetricName(String name, String rankMetricName)
| | public void | setExcludeGroupFilter(EnumerationCubeFilter excludeGroupFilter)
| | public void | setExcludedValues(int dimension, Collection excludedValues)
| | public void | setMetricOrder(String name, int order)
Especifica en que posición relativa a las métricas se ubica la métrica del nombre especificado. | | public void | setMetricProperties(String name, boolean visible, int order)
| | public void | setMetricVisible(String name, boolean visible)
| | public void | setParamValue(String key, Object value)
| | public void | setParamValue(String filterName, String parameterName, Object value)
| | public void | setParamValues(Map paramValues)
| | public void | setUniqueDimension(ReportDimensionSpec dimension)
| | public void | setUniqueMetricVisible(String rankMetricName)
| | public void | setVisibleTotals(boolean visibleTotals)
|
| ReportQuery | | public ReportQuery(ReportSpec reportSpec) throws InfoException(Code) | | Inicializa una nueva Consulta, asignandole a las dimensiones y a las métrcias las propiedades por defecto que se
obtienen de la definición de reporte
Parameters:
reportSpec - Contiene la información necesaria para ubicar los datos de las dimensiones y las métricas dentrode las rows del DataSource.
throws:
com.calipso.reportgenerator.common.InfoException - |
| ReportQuery | | public ReportQuery(ReportSpec reportSpec, boolean defaultInitialize) throws InfoException(Code) | | Inicializa una nueva Consulta permitiendo especificar si se desea que a las dimensiones y las métricas se les asignen
las propiedades por defecto que se obtienen de la definición del reporte.
Parameters:
reportSpec - Contiene la información necesaria para ubicar los datos de las dimensiones y las métricas dentrode las rows del DataSource.
Parameters:
defaultInitialize - true = valores de propiedades por defecto segun definición de reporte. false = ninguna métricavisible, ninguna dimension agrupa (Location = PAGE). |
| ReportQuery | | public ReportQuery(ReportSpec reportSpec, ReportView reportView) throws InfoException(Code) | | Inicializa la query y le aplica los valores del Report view indicado
Parameters:
reportSpec - Contiene la información necesaria para ubicar los datos de las dimensiones y las métricas dentrode las rows del DataSource.
Parameters:
reportView - Continen los valores especificos para la vista solicitada |
| addFilters | | public void addFilters(Collection filters)(Code) | | Agrega los filtros especificados al report spec.
Parameters:
filters - |
| clearQuery | | public void clearQuery()(Code) | | Hace que todas las dimensiones no intervengan en la agrupación (ni por ROW ni por COLUMN)
Inicializa los criterios de ordenamiento de los valores de dimensión en A (ascendente)
Asigna -1 al orden relativo de las dimensiones
Este método se utiliza para configurar una nueva query a partir de una query existente, la query
que se obtiene por defecto está inicializada con los valores prefijados en el ReportSourceDefinition
|
| excludeValue | | public void excludeValue(int dimension, Object value)(Code) | | Agrega un nuevo valor de dimension excluido
Parameters:
dimension -
Parameters:
value - |
| getAccumulableMetrics | | public List getAccumulableMetrics()(Code) | | Lista que contiene todos las métricas acumulables que el usuario puede activar (ver)
|
| getColumnDimensions | | public List getColumnDimensions()(Code) | | Lista que contiene todas las dimensiones que agrupan por columna
|
| getCubeFilter | | protected ExpressionCubeFilter getCubeFilter(Map params) throws InfoException(Code) | | Construye un filtro (post-filtro) a partir de las definiciones de filtro de la definición de reporte y los valores
de los parámetros enviados por el usuario
Parameters:
params - |
| getCubeVisibleMetricFields | | public int[] getCubeVisibleMetricFields()(Code) | | Devuelve un array de enteros que representan a los indices de la row donde se encuentran los valores de las métricas
visibles
|
| getDimensionFilterValues | | protected Map getDimensionFilterValues()(Code) | | Deveulve los valores de una dimension excluidos para el filtro enumerado
|
| getDimensions | | public List getDimensions()(Code) | | Lista que contiene todas las dimensiones involucradas en la query
|
| getDimensionsByLocation | | public List getDimensionsByLocation(DimensionDefinitionLocationType location)(Code) | | Devuelve una lista con todas las dimensiones que agrupan según el parámetro location.
Parameters:
location - ubicación de las dimensiones que se desea obtener. |
| getExcludedValues | | public Set getExcludedValues(int dimension)(Code) | | Deveuelve la lista de valores excluidos de una dimensión
Parameters:
dimension - |
| getGroupingDimensionsIndexArray | | public int[] getGroupingDimensionsIndexArray()(Code) | | devuelve un array que contiene
|
| getMetrics | | public List getMetrics()(Code) | | Lista que contiene todos las métricas que el usuario puede activar (ver)
|
| getPageDimensions | | public List getPageDimensions()(Code) | | Lista que contiene todas las dimensiones que estan disponibles para agrupar
|
| getParamValue | | public Object getParamValue(String key)(Code) | | Devuelve el valor un parámetro
Parameters:
key - identificador del parámetro (nombre del filtro + nombre del parámetro) valor del parámetro |
| getParamValue | | public Object getParamValue(String filterName, String parameterName)(Code) | | Devuelve el valor un parámetro
Parameters:
filterName -
Parameters:
parameterName - |
| getParamValues | | public Map getParamValues()(Code) | | Devuelve los valores de parámetros especificados en la query, este método solo debería ser llamado desde la clase
Report para la ejecución de la query, para especificar u obtener los valores de los parámetros de la
query se deben utilizar los métodos getParamValue y setParamValue
|
| getReportSpec | | public ReportSpec getReportSpec()(Code) | | Devuelve la estructura ReportSpec que sirve para obtener los indices de las dimensiones y las métricas en
la matriz que se llenó a partir de DataSource
|
| getRowDimensions | | public List getRowDimensions()(Code) | | Lista que contiene todas las dimensiones que agrupan por fila
|
| getVisibleAccumulableMetrics | | public List getVisibleAccumulableMetrics()(Code) | | Devuelve una lista que contiene las métricas acumulables visibles
|
| getVisibleMetrics | | public List getVisibleMetrics()(Code) | | Devuelve una lista que contiene las métricas visibles
|
| includeValue | | public void includeValue(int dimension, Object value)(Code) | | Elimina un valor de dimension excluido
Parameters:
dimension -
Parameters:
value - |
| isValid | | public boolean isValid()(Code) | | Se utiliza para verificar si las propiedades asignadas a las dimensiones y a las métricas determinan una query válida
|
| isVisibleTotals | | public boolean isVisibleTotals()(Code) | | |
| removeFilters | | public void removeFilters(Collection filters)(Code) | | Quita los filtros especificados del report spec
Parameters:
filters - |
| setDimensionLocationOrder | | public void setDimensionLocationOrder(String name, int order) throws InfoException(Code) | | Especifica el posición de la dimensión relativa a la localización
El valor de order solo sirve para ordenar (comparar), no es obligatorio especificar números correlativos
Parameters:
name -
Parameters:
order -
throws:
com.calipso.reportgenerator.common.InfoException - |
| setDimensionLocationOrder | | public void setDimensionLocationOrder(String name, int order, boolean updateOrders) throws InfoException(Code) | | Especifica el posición de la dimensión relativa a la localización, si el parámetro updateOrders es True, se reacomodan
los ordenes desde la dimensión especificada en adelante
El valor de order solo sirve para ordenar (comparar), no es obligatorio especificar números correlativos
Parameters:
name -
Parameters:
order -
throws:
com.calipso.reportgenerator.common.InfoException - |
| setDimensionProperties | | public void setDimensionProperties(String name, DimensionDefinitionLocationType location, DimensionDefinitionOrderType order, int locationOrder, String rankMetricName) throws InfoException(Code) | | Especifica todas las propiedades de la dimension que afectan la query
Parameters:
name -
Parameters:
location - ubicación de agrupación (pueder ser null, en ese caso conserva el valor anterior)
Parameters:
order - criterio de ordenamiento (pueder ser null, en ese caso conserva el valor anterior)
Parameters:
locationOrder - posición relativa a la localización (para conservar la posición anterior se debe pasar valor -1)
Parameters:
rankMetricName -
throws:
com.calipso.reportgenerator.common.InfoException - |
| setExcludedValues | | public void setExcludedValues(int dimension, Collection excludedValues)(Code) | | Asocia una lista de valores excluidos a una dimensión
Parameters:
dimension -
Parameters:
excludedValues - |
| setMetricOrder | | public void setMetricOrder(String name, int order) throws InfoException(Code) | | Especifica en que posición relativa a las métricas se ubica la métrica del nombre especificado.
El valor de order solo sirve para ordenar (comparar), no es obligatorio especificar números correlativos
Parameters:
name -
Parameters:
order -
throws:
com.calipso.reportgenerator.common.InfoException - |
| setMetricProperties | | public void setMetricProperties(String name, boolean visible, int order) throws InfoException(Code) | | Especifica todas las propiedades de la métrica que afectan a la query
Parameters:
name -
Parameters:
visible - para mostrar u ocultar los valores de la métrica
Parameters:
order - posición relativa a las métricas (si se quiere conservar el valor anterior parar el valor -1)
throws:
com.calipso.reportgenerator.common.InfoException - |
| setParamValue | | public void setParamValue(String key, Object value)(Code) | | Especifica el valor de un parámetro
Parameters:
key - identificador del parámetro
Parameters:
value - valor del parámetro |
| setParamValue | | public void setParamValue(String filterName, String parameterName, Object value)(Code) | | Especifica el valor de un parámetro
Parameters:
filterName -
Parameters:
parameterName -
Parameters:
value - |
| setParamValues | | public void setParamValues(Map paramValues)(Code) | | Especifica los valores de varios parámetros contenidos en paramValues que es un Map
donde cada clave es el identificador de un parámetro y cada objeto asociado es el valor de un parámetro
Parameters:
paramValues - |
| setUniqueDimension | | public void setUniqueDimension(ReportDimensionSpec dimension)(Code) | | Setea la dimension como unica visible para la query
Parameters:
dimension - |
| setUniqueMetricVisible | | public void setUniqueMetricVisible(String rankMetricName)(Code) | | Setea como unica metrica visible la especificada
Parameters:
rankMetricName - |
| setVisibleTotals | | public void setVisibleTotals(boolean visibleTotals)(Code) | | |
|
|