com.cloupia.model.cIM.pagination

Class PaginatedReportHandler

java.lang.Object

com.cloupia.model.cIM.pagination.PaginatedReportHandler

All Implemented Interfaces:

PaginationProviderIf, TabularReportGeneratorIf

Direct Known Subclasses:

PaginatedChangeRecordReportHandler, PaginatedChargebackPerGroupReportHandler, PaginatedChargebackPerVDCReportHandler, PaginatedChargebackReportHandler, PaginatedCloudnameEventReportHandler, PaginatedCloudnameReportHandler, PaginatedGroupReportHandler, PaginatedIdReportHandler, PaginatedLoginIdReportHandler, PaginatedSRIdReportHandler, PaginatedVdcIdReportHandler, VMPaginatedReportHandler

public abstract class PaginatedReportHandler
extends java.lang.Object
implements PaginationProviderIf, TabularReportGeneratorIf

This is the base implementation of PaginationProviderIf, it handles most of the base logic to retrieve rows and row count. Implementation of sub query generation is deferred to classes that extend this one.

Constructor Summary

Constructors

Constructor and Description
PaginatedReportHandler()

Method Summary

Modifier and Type	Method and Description
TabularReport	createTabularReport(java.lang.String reportName, ReportContext context, TabularReportMetadata md, java.util.List<?> data)
TabularReport	getPage(java.lang.String reportName, ReportContext rc, java.lang.Class modelClass, Query query, SortCriteria[] sort, int startIndex, int endIndex, boolean isExport)
TabularReport	getPage(java.lang.String reportName, ReportContext rc, Query query, SortCriteria[] sort, int startIndex, int endIndex, boolean isExport) Returns the set of rows matching the given query between start and end.
int	getPageCount(java.lang.String reportName, ReportContext rc, Query query, SortCriteria sort, int rowsPerPage)
int	getRowCount(java.lang.String reportName, ReportContext rc, Query query, SortCriteria sort) Returns the total number of rows matching the given query.
int	getRowCount(java.lang.String reportName, ReportContext rc, ReportRegistryEntry entry, Query query, SortCriteria sort)
TabularReportMetadata	getTabularReportMetadata(java.lang.String reportName, java.lang.Class modelClass)
TabularReportMetadata	getTabularReportMetadata(java.lang.String reportName, ReportContext rc) Returns the column definitions and any ui customizations for the given report.
TabularReport	getTabularReportReport(ReportRegistryEntry reportEntry, ReportContext context) The method is the main method that will be called for displaying tabular data.
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cloupia.model.cIM.pagination.PaginationProviderIf

appendContextSubQuery

Constructor Detail

PaginatedReportHandler

public PaginatedReportHandler()

Method Detail

getPage

public TabularReport getPage(java.lang.String reportName,
                             ReportContext rc,
                             Query query,
                             SortCriteria[] sort,
                             int startIndex,
                             int endIndex,
                             boolean isExport)
                      throws java.lang.Exception

Description copied from interface: PaginationProviderIf

Returns the set of rows matching the given query between start and end. The rows should be wrapped inside a TabularReport and sorted in the given criteria.

Specified by:

getPage in interface PaginationProviderIf

Parameters:

reportName - Name of the report to gather rows for.

rc - The report context to retrieve rows with.

query - Any additional clauses to tack on to the base query.

sort - The sort order for columns.

startIndex - The starting index to get rows for.

endIndex - The ending index to get rows for.

Returns:

Throws:

java.lang.Exception

getPage

public TabularReport getPage(java.lang.String reportName,
                             ReportContext rc,
                             java.lang.Class modelClass,
                             Query query,
                             SortCriteria[] sort,
                             int startIndex,
                             int endIndex,
                             boolean isExport)
                      throws java.lang.Exception

Throws:

java.lang.Exception

createTabularReport

public TabularReport createTabularReport(java.lang.String reportName,
                                         ReportContext context,
                                         TabularReportMetadata md,
                                         java.util.List<?> data)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getPageCount

public int getPageCount(java.lang.String reportName,
                        ReportContext rc,
                        Query query,
                        SortCriteria sort,
                        int rowsPerPage)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getRowCount

public int getRowCount(java.lang.String reportName,
                       ReportContext rc,
                       Query query,
                       SortCriteria sort)
                throws java.lang.Exception

Description copied from interface: PaginationProviderIf

Returns the total number of rows matching the given query.

Specified by:

getRowCount in interface PaginationProviderIf

Parameters:

reportName - Name of report to get row count for.

rc - The report context to retrieve rows with.

query - Any additional clauses to tack on to base query.

sort - Sort order, but is irrelevant in this case.

Returns:

Throws:

java.lang.Exception

getRowCount

public int getRowCount(java.lang.String reportName,
                       ReportContext rc,
                       ReportRegistryEntry entry,
                       Query query,
                       SortCriteria sort)
                throws java.lang.Exception

Throws:

java.lang.Exception

getTabularReportMetadata

public TabularReportMetadata getTabularReportMetadata(java.lang.String reportName,
                                                      ReportContext rc)

Description copied from interface: PaginationProviderIf

Returns the column definitions and any ui customizations for the given report.

Specified by:

getTabularReportMetadata in interface PaginationProviderIf

Parameters:

reportName - Name of report to get metadata for.

rc - The report context to get metadata for.

Returns:

getTabularReportMetadata

public TabularReportMetadata getTabularReportMetadata(java.lang.String reportName,
                                                      java.lang.Class modelClass)

getTabularReportReport

public TabularReport getTabularReportReport(ReportRegistryEntry reportEntry,
                                            ReportContext context)
                                     throws java.lang.Exception

Description copied from interface: TabularReportGeneratorIf

The method is the main method that will be called for displaying tabular data. The heading information and the data need to be populated by this method into the model. The model is attached to the report and used when displaying the data The Open Automation framework generates the parameters based on the input entered when creating the report in Open Automation module.

Specified by:

getTabularReportReport in interface TabularReportGeneratorIf

Parameters:

reportEntry - This class has the info about the report (Report Name, Report Label, menu...)

context - Context information for this report (Passed from the context from Open Automation report)

Returns:

Report that has the data

Throws:

java.lang.Exception

See Also:

TabularReport, TabularReportInternalModel, ReportRegistryEntry, ReportContext

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception