com.groiss.reporting.data

Interface ReportingData

All Superinterfaces:

Comparable<ReportingExportable>, ReportingExportable

All Known Subinterfaces:

NumericValue

All Known Implementing Classes:

DateReportingData, DefaultReportingData, HasClassAttributePersistentData, OEPersistentData, PersistentData, TimeInterval, UserPersistentData

public interface ReportingData
extends ReportingExportable

Interface ReportingData Inteface for all ReportingData, which does not fit to Standard Datatypes

Method Summary

Modifier and Type	Method and Description
default void	addClientConditionWidgetOptions(JSONObject json, boolean isParamAtExec) Deprecated.
default void	addClientConditionWidgetOptions(JSONObject json, boolean isParamAtExec, Element condition) add clientcondition attributes to attribute store
void	addConditionToQuery(Query q, Element c) Adds the XMLAttribute as a conditon to the query.
void	addSelectAttributeToQuery(Query q, Element select) Adds the XMLAttribute as a select attribute to the query.
Collection<ReportingExportable>	completeSeries(Set<ReportingExportable> series, Query q) invoked for matrix-style reports to be able to add missing entries in the given series
Attribute	getAttribute()
Entity	getEntity()
List<Pair<String,String>>	getOperatorList(boolean comesFromParamMask)
void	setAttribute(Attribute a)
void	setEntity(Entity e)
void	setValue(ResultSet rs, Element selectAttribute, Query q) Sets the value of this object.

Methods inherited from interface com.groiss.reporting.export.ReportingExportable

compareTo, getColumnRenderer, getSortText, getValue, setValue, toHtml, toJson, toText

Method Detail

getAttribute

Attribute getAttribute()

Returns:

the attribute of schema, which refers to this object

setAttribute

void setAttribute(Attribute a)

Parameters:

a - - set the attribute of schema which refers to this object

getEntity

Entity getEntity()

Returns:

the entity of schema, which contains the attribute

setEntity

void setEntity(Entity e)

Parameters:

e - - set the entity

addSelectAttributeToQuery

void addSelectAttributeToQuery(Query q,
                               Element select)

Adds the XMLAttribute as a select attribute to the query. Has to call Query.addSelect(String, String, String, String, boolean, boolean) and Query.addSelectNameOfAttrib(Element, String)!

Parameters:

q - - the query Object, where select attribute is added

select - - the xml element of type attribute

addConditionToQuery

void addConditionToQuery(Query q,
                         Element c)

Adds the XMLAttribute as a conditon to the query. Has to call Query.addCondition(String, String, String, String, List)

Parameters:

q - - the query Object, where condtion has to be added

c - - the xml element of type condition

setValue

void setValue(ResultSet rs,
              Element selectAttribute,
              Query q)

Sets the value of this object. Value is gained from result set with attributenames. @see com.groiss.reporting.engine.Query#getSelectNamesOfAttribs(Element)

Parameters:

rs - - the result set of the query

selectAttribute - - the xml-element attribute of the query

q - - the query object

addClientConditionWidgetOptions

@Deprecated
default void addClientConditionWidgetOptions(JSONObject json,
                                                         boolean isParamAtExec)

Deprecated.

Parameters:

json - the json object of this attribute

isParamAtExec - indicates if method is called in normal condition or param-at-execution mode

addClientConditionWidgetOptions

default void addClientConditionWidgetOptions(JSONObject json,
                                             boolean isParamAtExec,
                                             Element condition)

add clientcondition attributes to attribute store

Parameters:

json - the json object of this attribute

isParamAtExec - indicates if method is called in normal condition or param-at-execution mode

condition - the optional <condition> element. can be used to mimic special behavior for parameter-at-execution scenarios

getOperatorList

List<Pair<String,String>> getOperatorList(boolean comesFromParamMask)

Parameters:

comesFromParamMask - true if list is taken for parameter of execution.

Returns:

a list of pairs of string representing the available operators. the key string of the pair is the xml representation of the operator, the second string the i18n value.

completeSeries

Collection<ReportingExportable> completeSeries(Set<ReportingExportable> series,
                                               Query q)

invoked for matrix-style reports to be able to add missing entries in the given series

Parameters:

series - the current values from the DB

q - the query

Returns:

the full series (e.g. for dates all dates from t1-t2, for persistents all elements of a certain type etc.)