Query ( @enterprise 10.0 API)

java.lang.Object
- com.groiss.reporting.Query

```
public class Query
extends Object
```
Class describing a report. Holds all Informations given by Query-XML and Request.

Field Summary

Fields
Modifier and Type	Field and Description
`static List<Pair<String,String>>`	`ARETH_OPERATORS`
`static List<Pair<String,String>>`	`DATE_OPERATORS`
`static Pair<String,String>`	`EMPTY_OPERATOR`
`static List<Pair<String,String>>`	`NULL_OPERATORS`
`static List<Pair<String,String>>`	`SET_OPERATORS`
`static List<Pair<String,String>>`	`STRING_OPERATORS`

Constructor Summary

Constructors
Constructor and Description
`Query(Report q, Map<String,String[]> paramMap)` Constructs q query for internal use
`Query(String id, String title, Document xml, Date execution, HttpServletRequest req)`
`Query(String id, String title, Document xml, Date execution, HttpServletRequest req, Report sq)`
`Query(String id, String title, Document xml, Date execution, Map<String,String[]> paramMap, Report q)` Constructs a Query, builds the SQL Statement
`Query(String id, String title, Document xml, Date execution, Map<String,String[]> paramMap, Report q, boolean doSQLInit)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCondition(String tablename, String alias, String condition, String selection, List<?> condValues)` Add a condition to the query
`void`	`addCondition(String condId, String tablename, String alias, String condition, String selection, List<?> condValues)` Add a condition to the query
`void`	`addCondition(String condId, String tablename, String alias, String attrib, String condition, String selection, List<?> condValues)` Add a condition to the query
`void`	`addConditionForAttrib(String tablename, String alias, String attrib, String condition, String selection, List<?> condValues)` Add a condition to the query
`protected void`	`addConditions(Element cond)`
`void`	`addOrderByForAggregateValueData(Integer att)` use this method to order resultset to calculate AggregateValue Types correctly
`void`	`addOrderByForAggregateValueData(String att)` Deprecated. since 9.0.18429 use `addOrderByForAggregateValueData(Integer)` instead
`void`	`addPermissionRelevantAttribute(Element e)`
`boolean`	`addRowNumber()`
`int`	`addSelect(String tablename, String selectAttribute, String alias, String selection, boolean addToGroupBy, boolean addAliasAsPrefix)` Adds a select Attribute to the query.
`void`	`addSelectIndexOfAttrib(Element attribute, int name)` stores the attributenames gained from `addSelect(String, String, String, String, boolean, boolean)`
`void`	`addSelectNameOfAttrib(Element attribute, String name)` Deprecated. since 9.0.18429 use `addSelectIndexOfAttrib(Element, int)` instead
`void`	`addTempJoin(String key1, String key2, Element rel)`
`protected void`	`buildSQLStatement()`
`boolean`	`containsTable(String table, String alias)`
`boolean`	`finishedParamMask()`
`boolean`	`getAddArchive()`
`List<Element>`	`getAttributes()` returns a list of all attributes of this query
`String`	`getAttributeValue(Element e, String attribute)` get the attribute-value from a query.xml element
`int`	`getCondCountWithParams()`
`int`	`getConditionCount()` get the number of the current condition. is needed in `ReportingData.addConditionToQuery(Query, Element)` to gain the maybe already filled parameter at execution values from parametermap
`List<Pair<String,List<?>>>`	`getConditions(String attribute)` get a list of values that will be bound to the specified attribute (tablename.alias.attribute)
`StringBuilder`	`getConditionString()`
`Map<Integer,Element>`	`getCondNeedsParam()`
`String`	`getDisplayStringForAttribute(Element attr, boolean addSortPattern)` returns a displayname for the attribute
`String`	`getDispStringForAttriubtes(Element attr, boolean addSortPattern)` Deprecated. due to a typo in the method-name
`String`	`getDispStringForConditions(Element c)` returns a displayname for the condtion c
`Date`	`getExecutionTime()` the execution timestamp of the query
`ReportingExporter`	`getExporter()`
`static Pair<ReportingExporter,Map<String,String>>`	`getExporterInfos(Document xml)` get Exportinginformation from xml-document
`String`	`getExportingParam(String key)`
`String`	`getId()` returns the id of this query
`String`	`getLocale()`
`protected int`	`getMaxTableResult()`
`String`	`getMaxUnit()` get the max unit of timeintervals used in this query
`String`	`getMinUnit()` get the min unit of timeintervals used in this query
`String`	`getParam(String key)` Returns the parameter from Map... if param has several values, they are returned seperated by a semicolon
`Map<String,? extends Object>`	`getParamMap()` get the Parameter Map of this query
`String`	`getParamMask()`
`List<Element>`	`getPermissionRelevantAttributes()`
`Map<String,String>`	`getQueryInformations()`
`String`	`getQueryPlan()`
`ReportingData`	`getReportingDataInstance(Element attr)`
`protected static Map<String,String[]>`	`getReqParamMap(HttpServletRequest req)`
`Resource`	`getResource()`
`ResultModifier`	`getResultModifier()`
`Report`	`getRootStoredQuery()`
`List<Integer>`	`getSelectIndexOfAttribs(Element attribute)`
`List<String>`	`getSelectNamesOfAttribs(Element attribute)` Deprecated. since 9.0.18429 use `getSelectIndexOfAttribs(Element)` instead
`String`	`getSqlQueryString()` get the sql query string
`MultiMap<String,String>`	`getTableAndAliases()`
`TimeModel`	`getTimemodel()` get the timemodel used by this query
`String`	`getTimezone()`
`String`	`getTitle()`
`List<Object>`	`getValues()` get a List of values of the prepared statement
`List<Object>`	`getValues(String attribute)` get a list of values that will be bound to the specified attribute (tablename.alias.attribute)
`Document`	`getXMLDoc()` returns the xml document describing this query
`static boolean`	`isAttributeTypeClob(Entity e, Attribute a)`
`protected boolean`	`isDistinct()`
`protected boolean`	`isExecutable()`
`String`	`lockOperatorInParamMaskMode()`
`boolean`	`queryHasClobSelects()`
`void`	`setExportingParam(String key, String value)`
`protected void`	`setQueryPlan(String queryPlan)`
`void`	`setTitle(String title)` Set the displayed title of the query
`boolean`	`shallLockOperatorInParamMask()`
`String[]`	`splitIntoTableAndAlias(String key)`

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

- Field Detail
  - NULL_OPERATORS
```
public static final List<Pair<String,String>> NULL_OPERATORS
```
  - DATE_OPERATORS
```
public static final List<Pair<String,String>> DATE_OPERATORS
```
  - ARETH_OPERATORS
```
public static final List<Pair<String,String>> ARETH_OPERATORS
```
  - SET_OPERATORS
```
public static final List<Pair<String,String>> SET_OPERATORS
```
  - STRING_OPERATORS
```
public static final List<Pair<String,String>> STRING_OPERATORS
```
  - EMPTY_OPERATOR
```
public static final Pair<String,String> EMPTY_OPERATOR
```
- Constructor Detail
  - Query
```
public Query(String id,
             String title,
             Document xml,
             Date execution,
             HttpServletRequest req)
```
    Parameters:
    
    id - the id of the query
    
    title - the title to show in result
    
    xml - the xml document defining the report
    
    execution - timestamp which is taken as execution time to calculate time intevals
    
    req - - the HttpServletRequest parameter Map is used for Query(String, String, Document, Date, Map, Report)
    
    See Also:
    
    Query(String, String, Document, Date, Map, Report)
  - Query
```
public Query(String id,
             String title,
             Document xml,
             Date execution,
             HttpServletRequest req,
             Report sq)
```
    Parameters:
    
    id - the id of the query
    
    title - the title to show in result
    
    xml - the xml document defining the report
    
    execution - timestamp which is taken as execution time to calculate time intevals
    
    req - the HttpServletRequest parameter Map is used for Query(String, String, Document, Date, Map, Report)
    
    sq - the storedquery object defining this report
    
    See Also:
    
    Query(String, String, Document, Date, Map, Report)
  - Query
```
public Query(Report q,
             Map<String,String[]> paramMap)
```
    Constructs q query for internal use
    
    Parameters:
    
    q - the StoredQuery
    
    paramMap - a map of parameters to execute the query
  - Query
```
public Query(String id,
             String title,
             Document xml,
             Date execution,
             Map<String,String[]> paramMap,
             Report q)
```
    Constructs a Query, builds the SQL Statement
    
    Parameters:
    
    id - the id of query
    
    title - the query title
    
    xml - the xml documents descibing the query
    
    execution - the timestamp of execution
    
    paramMap - a map with parameters (e.g. params at execution), usually all request params are stored in this map
  - Query
```
public Query(String id,
             String title,
             Document xml,
             Date execution,
             Map<String,String[]> paramMap,
             Report q,
             boolean doSQLInit)
```
- Method Detail
  - getXMLDoc
```
public Document getXMLDoc()
```
    returns the xml document describing this query
  - getId
```
public String getId()
```
    returns the id of this query
  - getTimemodel
```
public TimeModel getTimemodel()
```
    get the timemodel used by this query
  - getMaxUnit
```
public String getMaxUnit()
```
    get the max unit of timeintervals used in this query
  - getMinUnit
```
public String getMinUnit()
```
    get the min unit of timeintervals used in this query
  - getConditionCount
```
public int getConditionCount()
```
    get the number of the current condition. is needed in ReportingData.addConditionToQuery(Query, Element) to gain the maybe already filled parameter at execution values from parametermap
  - getParamMap
```
public Map<String,? extends Object> getParamMap()
```
    get the Parameter Map of this query
  - getParam
```
public String getParam(String key)
```
    Returns the parameter from Map... if param has several values, they are returned seperated by a semicolon
    
    Parameters:
    
    key - - the param name
    
    Returns:
    
    the Parameter
  - addConditions
```
protected void addConditions(Element cond)
```
  - addSelect
```
public int addSelect(String tablename,
                     String selectAttribute,
                     String alias,
                     String selection,
                     boolean addToGroupBy,
                     boolean addAliasAsPrefix)
```
    Adds a select Attribute to the query. Returns the attribut name for every select, bechaus if the similar select is required twice in query, it is selected only once.
    
    Parameters:
    
    tablename - - the tablename in database
    
    selectAttribute - - the sql select statement
    
    alias - - the used tablealias
    
    selection - - an additional (additional to the selection defined in schema) selection to the table if needed
    
    addToGroupBy - - false if sqlaggr is the selected aggregation. false otherwise
    
    addAliasAsPrefix - - true if tablealias shoulb be added in front of selectAttribute. false otherwise
    
    Returns:
    
    the attribute for the select
  - addCondition
```
public void addCondition(String tablename,
                         String alias,
                         String condition,
                         String selection,
                         List<?> condValues)
```
    Add a condition to the query
    
    Parameters:
    
    tablename - - the tablename in database
    
    alias - - the used tablealias
    
    condition - - the condition string
    
    selection - - an additional (additional to the selection defined in schema) selection to the table if needed
    
    condValues - - a vector with values for the prepared statement. There has to be an element in the vector for each ? in condition
  - addConditionForAttrib
```
public void addConditionForAttrib(String tablename,
                                  String alias,
                                  String attrib,
                                  String condition,
                                  String selection,
                                  List<?> condValues)
```
    Add a condition to the query
    
    Parameters:
    
    tablename - - the tablename in database
    
    alias - - the used tablealias
    
    condition - - the condition string
    
    selection - - an additional (additional to the selection defined in schema) selection to the table if needed
    
    condValues - - a vector with values for the prepared statement. There has to be an element in the vector for each ? in condition
  - addCondition
```
public void addCondition(String condId,
                         String tablename,
                         String alias,
                         String condition,
                         String selection,
                         List<?> condValues)
```
    Add a condition to the query
    
    Parameters:
    
    condId - - conditionId
    
    tablename - - the tablename in database
    
    alias - - the used tablealias
    
    condition - - the condition string
    
    selection - - an additional (additional to the selection defined in schema) selection to the table if needed
    
    condValues - - a vector with values for the prepared statement. There has to be an element in the vector for each ? in condition
  - addCondition
```
public void addCondition(String condId,
                         String tablename,
                         String alias,
                         String attrib,
                         String condition,
                         String selection,
                         List<?> condValues)
```
    Add a condition to the query
    
    Parameters:
    
    condId - - conditionId
    
    tablename - - the tablename in database
    
    alias - - the used tablealias
    
    condition - - the condition string
    
    selection - - an additional (additional to the selection defined in schema) selection to the table if needed
    
    condValues - - a vector with values for the prepared statement. There has to be an element in the vector for each ? in condition
  - addOrderByForAggregateValueData
```
@Deprecated
public void addOrderByForAggregateValueData(String att)
```
    Deprecated. since 9.0.18429 use addOrderByForAggregateValueData(Integer) instead
  - addOrderByForAggregateValueData
```
public void addOrderByForAggregateValueData(Integer att)
```
    use this method to order resultset to calculate AggregateValue Types correctly
  - containsTable
```
public boolean containsTable(String table,
                             String alias)
```
    Parameters:
    
    table - - the tablename in database
    
    alias - - the used tablealias
    
    Returns:
    
    true if table is already added with thos alias
  - addTempJoin
```
public void addTempJoin(String key1,
                        String key2,
                        Element rel)
```
  - getSqlQueryString
```
public String getSqlQueryString()
```
    get the sql query string
  - getValues
```
public List<Object> getValues()
```
    get a List of values of the prepared statement
  - getQueryPlan
```
public String getQueryPlan()
```
  - setQueryPlan
```
protected void setQueryPlan(String queryPlan)
```
  - getValues
```
public List<Object> getValues(String attribute)
```
    get a list of values that will be bound to the specified attribute (tablename.alias.attribute)
    
    Parameters:
    
    attribute -
    
    Returns:
  - getConditions
```
public List<Pair<String,List<?>>> getConditions(String attribute)
```
    get a list of values that will be bound to the specified attribute (tablename.alias.attribute)
    
    Parameters:
    
    attribute -
    
    Returns:
  - getAttributes
```
public List<Element> getAttributes()
```
    returns a list of all attributes of this query
    
    Returns:
    
    a list of DOM elements
  - getSelectIndexOfAttribs
```
public List<Integer> getSelectIndexOfAttribs(Element attribute)
```
    Parameters:
    
    attribute - - the attribute
    
    Returns:
    
    a List of attribute Index to read them from the ResultSet
  - getSelectNamesOfAttribs
```
@Deprecated
public List<String> getSelectNamesOfAttribs(Element attribute)
```
    Deprecated. since 9.0.18429 use getSelectIndexOfAttribs(Element) instead
    
    Parameters:
    
    attribute - - the attribute
    
    Returns:
    
    a Vector of attribute names to read them from the ResultSet
  - addSelectNameOfAttrib
```
@Deprecated
public void addSelectNameOfAttrib(Element attribute,
                                              String name)
```
    Deprecated. since 9.0.18429 use addSelectIndexOfAttrib(Element, int) instead
    
    stores the attributenames gained from addSelect(String, String, String, String, boolean, boolean)
    
    Parameters:
    
    attribute - - the attribute, which caused this select statement
    
    name - - the attribute name in the sql query
  - addSelectIndexOfAttrib
```
public void addSelectIndexOfAttrib(Element attribute,
                                   int name)
```
    stores the attributenames gained from addSelect(String, String, String, String, boolean, boolean)
    
    Parameters:
    
    attribute - - the attribute, which caused this select statement
    
    name - - the attribute index in the sql query
  - buildSQLStatement
```
protected void buildSQLStatement()
```
  - splitIntoTableAndAlias
```
public String[] splitIntoTableAndAlias(String key)
```
  - getTableAndAliases
```
public MultiMap<String,String> getTableAndAliases()
```
    Returns:
    
    the tableAndAliases
  - getExecutionTime
```
public Date getExecutionTime()
```
    the execution timestamp of the query
  - getAddArchive
```
public boolean getAddArchive()
```
    Returns:
    
    true if query includes data from archive schema
  - getCondNeedsParam
```
public Map<Integer,Element> getCondNeedsParam()
```
    Returns:
    
    a map with all conditions needing parameter at execution input
  - getConditionString
```
public StringBuilder getConditionString()
```
    Returns:
    
    a string represanting the query's condtions.
  - getDispStringForAttriubtes
```
@Deprecated
public final String getDispStringForAttriubtes(Element attr,
                                                           boolean addSortPattern)
```
    Deprecated. due to a typo in the method-name
    
    Parameters:
    
    attr -
    
    addSortPattern -
    
    Returns:
    
    See Also:
    
    getDisplayStringForAttribute(Element, boolean)
  - getDisplayStringForAttribute
```
public String getDisplayStringForAttribute(Element attr,
                                           boolean addSortPattern)
```
    returns a displayname for the attribute
    
    Parameters:
    
    attr - - attribute
    
    addSortPattern - - if true the sortpaterns %ASC%, %DESC% and %NONE% are added to the displayname
    
    Returns:
    
    an I18N string for the attribute
  - getDispStringForConditions
```
public String getDispStringForConditions(Element c)
```
    returns a displayname for the condtion c
    
    Parameters:
    
    c - - condition
    
    Returns:
    
    an I18N string for the condition
  - getExporter
```
public ReportingExporter getExporter()
```
    Returns:
    
    the exporter object of this query
  - getExportingParam
```
public String getExportingParam(String key)
```
    Parameters:
    
    key - - the name of the exporting parameter
    
    Returns:
    
    the valuo of this parameter
  - setExportingParam
```
public void setExportingParam(String key,
                              String value)
```
  - getExporterInfos
```
public static Pair<ReportingExporter,Map<String,String>> getExporterInfos(Document xml)
```
    get Exportinginformation from xml-document
    
    Parameters:
    
    xml -
    
    Returns:
    
    a Pair of ReportingExporter instance and key-value map of paramters
  - getAttributeValue
```
public String getAttributeValue(Element e,
                                String attribute)
```
    get the attribute-value from a query.xml element
    
    Parameters:
    
    e - the element (attribute, condition,...)
    
    attribute - the attribute-id
    
    Returns:
    
    the value
  - getTitle
```
public String getTitle()
```
    Returns:
    
    the I18N keys of the title of this query
  - isExecutable
```
protected boolean isExecutable()
```
    Returns:
    
    true if query is already executeable...
  - isDistinct
```
protected boolean isDistinct()
```
    Returns:
    
    true if query does not display equal rows twice...
  - getReqParamMap
```
protected static Map<String,String[]> getReqParamMap(HttpServletRequest req)
```
  - addRowNumber
```
public boolean addRowNumber()
```
    Returns:
    
    true if report should include row numbers
  - getParamMask
```
public String getParamMask()
```
  - getCondCountWithParams
```
public int getCondCountWithParams()
```
    Returns:
    
    the index of the last parameter of execution condition
  - lockOperatorInParamMaskMode
```
public String lockOperatorInParamMaskMode()
```
    Returns:
    
    TRUE if operator shall be readonly in parammask HIDE if operator shall be hidden in parammask FALSE otherwise
  - shallLockOperatorInParamMask
```
public boolean shallLockOperatorInParamMask()
```
    Returns:
    
    true if operator shall be readonly in parammask
  - getTimezone
```
public String getTimezone()
```
  - getLocale
```
public String getLocale()
```
  - getResource
```
public Resource getResource()
```
  - setTitle
```
public void setTitle(String title)
```
    Set the displayed title of the query
    
    Parameters:
    
    title - - the title string. this String is given to Resource.localize of the Query, so you may use I18N Keys.
  - queryHasClobSelects
```
public boolean queryHasClobSelects()
```
  - isAttributeTypeClob
```
public static boolean isAttributeTypeClob(Entity e,
                                          Attribute a)
```
  - getMaxTableResult
```
protected int getMaxTableResult()
```
    Returns:
    
    maximum number of result rows
  - getQueryInformations
```
public Map<String,String> getQueryInformations()
```
    Returns:
    
    a map of informations about this report
  - getResultModifier
```
public ResultModifier getResultModifier()
```
    Returns:
  - getRootStoredQuery
```
public Report getRootStoredQuery()
```
    Returns:
    
    the root stored query which was the base for this query object null if query object does not origin from a stored query but is an adhoc query.
  - finishedParamMask
```
public boolean finishedParamMask()
```
    Returns:
    
    true if the query has shown param mask already (so no pram mask will be shown)
  - getReportingDataInstance
```
public ReportingData getReportingDataInstance(Element attr)
```
    Parameters:
    
    attr -
    
    Returns:
  - addPermissionRelevantAttribute
```
public void addPermissionRelevantAttribute(Element e)
```
  - getPermissionRelevantAttributes
```
public List<Element> getPermissionRelevantAttributes()
```

Class Query

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NULL_OPERATORS

DATE_OPERATORS

ARETH_OPERATORS

SET_OPERATORS

STRING_OPERATORS

EMPTY_OPERATOR

Constructor Detail

Query

Query

Query

Query

Query

Method Detail

getXMLDoc

getId

getTimemodel

getMaxUnit

getMinUnit

getConditionCount

getParamMap

getParam

addConditions

addSelect

addCondition

addConditionForAttrib

addCondition

addCondition

addOrderByForAggregateValueData

addOrderByForAggregateValueData

containsTable

addTempJoin

getSqlQueryString

getValues

getQueryPlan

setQueryPlan

getValues

getConditions

getAttributes

getSelectIndexOfAttribs

getSelectNamesOfAttribs

addSelectNameOfAttrib

addSelectIndexOfAttrib

buildSQLStatement

splitIntoTableAndAlias

getTableAndAliases

getExecutionTime

getAddArchive

getCondNeedsParam

getConditionString

getDispStringForAttriubtes

getDisplayStringForAttribute

getDispStringForConditions

getExporter

getExportingParam

setExportingParam

getExporterInfos

getAttributeValue

getTitle

isExecutable

isDistinct

getReqParamMap

addRowNumber

getParamMask

getCondCountWithParams

lockOperatorInParamMaskMode

shallLockOperatorInParamMask

getTimezone

getLocale

getResource

setTitle

queryHasClobSelects

isAttributeTypeClob

getMaxTableResult

getQueryInformations