com.inet.report.cache

Class ReportCacheKey

java.lang.Object

com.inet.report.cache.ReportCacheKey

All Implemented Interfaces:

java.io.Serializable

public final class ReportCacheKey
extends java.lang.Object
implements java.io.Serializable

This class represents a unique key for a report output. The object is not mutable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReportCacheKey(java.lang.String report, java.lang.String parameter, java.lang.String format, long vgen) Creates a new ReportCacheKey.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compares the values of this ReportCacheKey with those of the other ReportCacheKey.
java.lang.String	getFormat() Returns the export format of the report.
java.lang.String	getParameter() Returns the report relevant parameters.
java.lang.String	getReport() Returns the report name (file path) of the report.
long	getVGen() Returns the value of the property "vgen".
int	hashCode() Summary of report-hashcode and parameter-hashcode.
java.lang.String	toString() Returns a String representation of this ReportCacheKey.

Constructor Detail

ReportCacheKey

public ReportCacheKey(java.lang.String report,
                      java.lang.String parameter,
                      java.lang.String format,
                      long vgen)
               throws ReportException

Creates a new ReportCacheKey. The parameter report cannot be null or empty.

Parameters:

report - e.g "file:C:/i-net Clear Reports/reports/test.rpt"

parameter - The parameters for the report as a string, key-value pairs paired with the equal sign and separated by ampersands, e.g. "vgen=141513&init=pdf&..."

format - the export format for the report. e.g Engine.EXPORT_PDF

vgen - default value is 0.

Throws:

ReportException - when the report is empty

Since:

6.0

Method Detail

hashCode

public int hashCode()

Summary of report-hashcode and parameter-hashcode.

Overrides:

hashCode in class java.lang.Object

Returns:

the summary of report-hashcode and parameter-hashcode

Since:

6.0

equals

public boolean equals(java.lang.Object o)

Compares the values of this ReportCacheKey with those of the other ReportCacheKey.

Overrides:

equals in class java.lang.Object

Parameters:

o - a ReportCacheKey

Returns:

false if Object is not instanceof ReportCacheKey or the values are different; true if all values are equals

Since:

6.0

getReport

public java.lang.String getReport()

Returns the report name (file path) of the report.

Returns:

The report name (file path) of the report.

Since:

6.0

getParameter

public java.lang.String getParameter()

Returns the report relevant parameters.

Returns:

The report relevant parameters as a string, paired with the equal sign and separated by ampersands, e.g. "vgen=0&init=pdf&..."

Since:

6.0

getVGen

public long getVGen()

Returns the value of the property "vgen".

Returns:

The value of the property "vgen".

Since:

6.0

getFormat

public java.lang.String getFormat()

Returns the export format of the report.

Returns:

The export format of the report.

Since:

6.0

toString

public java.lang.String toString()

Returns a String representation of this ReportCacheKey.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this ReportCacheKey.

Since:

6.0