Module is.codion.common.db

Package is.codion.common.db.report

Class AbstractReport<T,R,P>

java.lang.Object

is.codion.common.db.report.AbstractReport<T,R,P>

Type Parameters:

T - the report type

R - the report result type

P - the report parameters type

All Implemented Interfaces:

Report<T,R,P>

public abstract class AbstractReport<T,R,P>
extends Object
implements Report<T,R,P>

A base class for wrapping reports, handles caching.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	reportPath

Fields inherited from interface is.codion.common.db.report.Report

CACHE_REPORTS, REPORT_PATH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractReport(String reportPath, boolean cacheReport)	Instantiates a new AbstractReport.

Method Summary

Modifier and Type	Method	Description
void	clearCache()	Clears the report cache, if caching is not enabled calling this method has no effect
boolean	equals(Object obj)
protected String	fullReportPath()	This default implementation uses Report.fullReportPath(String).
int	hashCode()
boolean	isCached()
protected T	loadAndCacheReport()	Returns the underlying report, either from the cache, if enabled or via Report.loadReport().
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface is.codion.common.db.report.Report

fillReport, loadReport

Field Detail

reportPath

protected final String reportPath

Constructor Detail

AbstractReport

protected AbstractReport(String reportPath,
                         boolean cacheReport)

Instantiates a new AbstractReport.

Parameters:

reportPath - the report path, relative to the central report path Report.REPORT_PATH.

cacheReport - true if the report should be cached when loaded

Method Detail

toString

public final String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

isCached

public final boolean isCached()

Specified by:

isCached in interface Report<T,R,P>

Returns:

true if this report has been cached

clearCache

public final void clearCache()

Description copied from interface: Report

Clears the report cache, if caching is not enabled calling this method has no effect

Specified by:

clearCache in interface Report<T,R,P>

fullReportPath

protected String fullReportPath()

This default implementation uses Report.fullReportPath(String).

Returns:

a unique path for this report

loadAndCacheReport

protected final T loadAndCacheReport()
                              throws ReportException

Returns the underlying report, either from the cache, if enabled or via Report.loadReport().

Returns:

the report

Throws:

ReportException - in case of an exception

See Also:

Report.CACHE_REPORTS