com.neurosys.bi.reporting

Class ReporterMeta<PARAM_META>

java.lang.Object

com.neurosys.bi.reporting.ReporterMeta<PARAM_META>

Type Parameters:

PARAM_META - as The Meta information to describe the input params

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthorizableReporterMeta

public class ReporterMeta<PARAM_META>
extends Object
implements Serializable

A Report can require input and params etc; also other display meta data for rendering. These can be augumented to the UI or exporting interface by an instance of this class.

Author:

Arjun Dhar

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReporterMeta()
ReporterMeta(Reporter reporter)
ReporterMeta(ReporterMeta reporterMeta)

Method Summary

Modifier and Type	Method and Description
Map<Object,Object>	getAttributes() For each Column displayName in the Reporter define any specific attributes for presentation Key is fieldName/Column Index and value could be a String, Transformer,PARAM_META type
List<PARAM_META>	getBulkActions() Any Bulk actions to perform on the Report
Map<Integer,Object>	getColumnToEntityValueMapping() Each column position (starting @ 0) needs to be mapped to the entity name or a Transformer(entity) or even a FacetMeta to tell the presentation layer which Column maps to which field / value(output from the Transformer, in case on complex relations) Additionally a FacetMeta (value object) can be Authorizable also
String	getDisplayName() Display Name corresponding to the Reporter
Map<ExportType,ExportMeta>	getExportableFormats() The export process may require some additional information supplied by ExportMeta Map of Key is ExportType and Value of type ExportMeta
String	getId() Handle to this ReporterMeta
List<PARAM_META>	getInputParamsMetas() The REPORTER may demand input parameters; we can define the input parameters and present them using additional info from PARAM_META (like FacetMeta) Example for a SEARCH PANEL to accept INPUT Search terms for "First Name": PARAM_META = com.neurosys.template.model.Template$FacetMeta <property name="name" value="0" /> <!-- Index in params array, since Entity is Object array type --> <property name="displayName" value="First Name" /> <property name="type" value="INPUT" /> <property name="submitTransformer"><bean class="com.neurosys.etl.common.transformers.PrefixSuffixTransformer"> <!-- To support LIKE clause --> <property name="prefix" value="%" /> <property name="suffix" value="%" />
ReporterMeta<PARAM_META>	getNoParamsReporterMeta() If inputParamsMetas is not null; then by default to generate a Report params are needed.
Class	getRecordType() What is the nature of the records returned.
Reporter	getReporter() The actual backend service / component responsible for Reporting
List<Object>	getRowDecorators() A Row Decorator mentions the fieldName(s)/Column(s) whose value will be used to change the state of the row, like highlight etc.
void	setAttributes(Map<Object,Object> attributes) For each Column displayName in the Reporter define any specific attributes for presentation Key is fieldName/Column Index and value could be a String, Transformer,PARAM_META type
void	setBulkActions(List<PARAM_META> bulkActions) Any Bulk actions to perform on the Report
void	setColumnToEntityValueMapping(Map<Integer,Object> columnToEntityValueMapping) Each column position (starting @ 0) needs to be mapped to the entity name or a Transformer(entity) or even a FacetMeta to tell the presentation layer which Column maps to which field / value(output from the Transformer, in case on complex relations) Additionally a FacetMeta (value object) can be Authorizable also
void	setDisplayName(String displayName) Display Name corresponding to the Reporter
void	setExportableFormats(Map<ExportType,ExportMeta> exportableFormats) The export process may require some additional information supplied by ExportMeta Map of Key is ExportType and Value of type ExportMeta
void	setId(String id) Handle to this ReporterMeta
void	setInputParamsMetas(List<PARAM_META> inputParamsMetas) The REPORTER may demand input parameters; we can define the input parameters and present them using additional info from PARAM_META (like FacetMeta) Example for a SEARCH PANEL to accept INPUT Search terms for "First Name": PARAM_META = com.neurosys.template.model.Template$FacetMeta <property name="name" value="0" /> <!-- Index in params array, since Entity is Object array type --> <property name="displayName" value="First Name" /> <property name="type" value="INPUT" /> <property name="submitTransformer"><bean class="com.neurosys.etl.common.transformers.PrefixSuffixTransformer"> <!-- To support LIKE clause --> <property name="prefix" value="%" /> <property name="suffix" value="%" />
void	setNoParamsReporterMeta(ReporterMeta<PARAM_META> noParamsReporterMeta) If inputParamsMetas is not null; then by default to generate a Report params are needed.
void	setRecordType(Class recordType) What is the nature of the records returned.
void	setReporter(Reporter reporter) The actual backend service / component responsible for Reporting
void	setRowDecorators(List<Object> rowDecorators) A Row Decorator mentions the fieldName(s)/Column(s) whose value will be used to change the state of the row, like highlight etc.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReporterMeta

public ReporterMeta()

ReporterMeta

public ReporterMeta(Reporter reporter)

ReporterMeta

public ReporterMeta(ReporterMeta reporterMeta)

Method Detail

getExportableFormats

public Map<ExportType,ExportMeta> getExportableFormats()

The export process may require some additional information supplied by ExportMeta

Map of Key is ExportType and Value of type ExportMeta

Can be null:

true - Dont know / Dont care

setExportableFormats

public void setExportableFormats(Map<ExportType,ExportMeta> exportableFormats)

The export process may require some additional information supplied by ExportMeta

Map of Key is ExportType and Value of type ExportMeta

Can be null:

true - Dont know / Dont care

getAttributes

public Map<Object,Object> getAttributes()

For each Column displayName in the Reporter define any specific attributes for presentation
Key is fieldName/Column Index and value could be a String, Transformer,PARAM_META type

Can be null:

true

setAttributes

public void setAttributes(Map<Object,Object> attributes)

For each Column displayName in the Reporter define any specific attributes for presentation
Key is fieldName/Column Index and value could be a String, Transformer,PARAM_META type

Can be null:

true

getRowDecorators

public List<Object> getRowDecorators()

A Row Decorator mentions the fieldName(s)/Column(s) whose value will be used to change the state of the row, like highlight etc. Depends on implementation. The model here simply indicates to the reporter that it needs to decorate the Row with information based from certain fields

Can be null:

true

setRowDecorators

public void setRowDecorators(List<Object> rowDecorators)

A Row Decorator mentions the fieldName(s)/Column(s) whose value will be used to change the state of the row, like highlight etc. Depends on implementation. The model here simply indicates to the reporter that it needs to decorate the Row with information based from certain fields

Can be null:

true

getReporter

public Reporter getReporter()

The actual backend service / component responsible for Reporting

setReporter

public void setReporter(Reporter reporter)

The actual backend service / component responsible for Reporting

getInputParamsMetas

public List<PARAM_META> getInputParamsMetas()

The REPORTER may demand input parameters; we can define the input parameters and present them using additional info from PARAM_META (like FacetMeta)
Example for a SEARCH PANEL to accept INPUT Search terms for "First Name":
PARAM_META = com.neurosys.template.model.Template$FacetMeta
<property name="name" value="0" /> <!-- Index in params array, since Entity is Object array type -->
<property name="displayName" value="First Name" />
<property name="type" value="INPUT" />
<property name="submitTransformer"><bean class="com.neurosys.etl.common.transformers.PrefixSuffixTransformer"> <!-- To support LIKE clause -->
<property name="prefix" value="%" />
<property name="suffix" value="%" />

See Also:

noParamsReporterMeta

Can be null:

true

setInputParamsMetas

public void setInputParamsMetas(List<PARAM_META> inputParamsMetas)

The REPORTER may demand input parameters; we can define the input parameters and present them using additional info from PARAM_META (like FacetMeta)
Example for a SEARCH PANEL to accept INPUT Search terms for "First Name":
PARAM_META = com.neurosys.template.model.Template$FacetMeta
<property name="name" value="0" /> <!-- Index in params array, since Entity is Object array type -->
<property name="displayName" value="First Name" />
<property name="type" value="INPUT" />
<property name="submitTransformer"><bean class="com.neurosys.etl.common.transformers.PrefixSuffixTransformer"> <!-- To support LIKE clause -->
<property name="prefix" value="%" />
<property name="suffix" value="%" />

See Also:

noParamsReporterMeta

Can be null:

true

getNoParamsReporterMeta

public ReporterMeta<PARAM_META> getNoParamsReporterMeta()

If inputParamsMetas is not null; then by default to generate a Report params are needed. However by setting this optional field we can present a Default Report that requires no params on init to show an initial display.

See Also:

inputParamsMetas

Can be null:

true

setNoParamsReporterMeta

public void setNoParamsReporterMeta(ReporterMeta<PARAM_META> noParamsReporterMeta)

If inputParamsMetas is not null; then by default to generate a Report params are needed. However by setting this optional field we can present a Default Report that requires no params on init to show an initial display.

See Also:

inputParamsMetas

Can be null:

true

getDisplayName

public String getDisplayName()

Display Name corresponding to the Reporter

setDisplayName

public void setDisplayName(String displayName)

Display Name corresponding to the Reporter

getId

public String getId()

Handle to this ReporterMeta

setId

public void setId(String id)

Handle to this ReporterMeta

getColumnToEntityValueMapping

public Map<Integer,Object> getColumnToEntityValueMapping()

Each column position (starting @ 0) needs to be mapped to the entity name or a Transformer(entity) or even a FacetMeta to tell the presentation layer which Column maps to which field / value(output from the Transformer, in case on complex relations)

Additionally a FacetMeta (value object) can be Authorizable also

setColumnToEntityValueMapping

public void setColumnToEntityValueMapping(Map<Integer,Object> columnToEntityValueMapping)

Each column position (starting @ 0) needs to be mapped to the entity name or a Transformer(entity) or even a FacetMeta to tell the presentation layer which Column maps to which field / value(output from the Transformer, in case on complex relations)

Additionally a FacetMeta (value object) can be Authorizable also

getRecordType

public Class getRecordType()

What is the nature of the records returned. This can be useful when the core entities have to be used for some activity and the type is not knowns before the results are obtained.

Can be null:

true - if we don't care to do much with the generated reported results except display them or only care to use the records after they are derived from the Reporter

setRecordType

public void setRecordType(Class recordType)

What is the nature of the records returned. This can be useful when the core entities have to be used for some activity and the type is not knowns before the results are obtained.

Can be null:

true - if we don't care to do much with the generated reported results except display them or only care to use the records after they are derived from the Reporter

getBulkActions

public List<PARAM_META> getBulkActions()

Any Bulk actions to perform on the Report

setBulkActions

public void setBulkActions(List<PARAM_META> bulkActions)

Any Bulk actions to perform on the Report