Package com.inet.report.cache
Class ReportCacheKey
java.lang.Object
com.inet.report.cache.ReportCacheKey
- All Implemented Interfaces:
Serializable
This class represents a unique key for a report output. The object is not mutable.
- See Also:
-
Constructor Summary
ConstructorDescriptionReportCacheKey
(String report, String parameter, String format, long vgen) Creates a new ReportCacheKey. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares the values of this ReportCacheKey with those of the other ReportCacheKey.Returns the export format of the report.Returns the report relevant parameters.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.toString()
Returns a String representation of this ReportCacheKey.
-
Constructor Details
-
ReportCacheKey
public ReportCacheKey(String report, String parameter, 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_PDFvgen
- default value is 0.- Throws:
ReportException
- when the report is empty- Since:
- 6.0
-
-
Method Details
-
hashCode
public int hashCode()Summary of report-hashcode and parameter-hashcode. -
equals
Compares the values of this ReportCacheKey with those of the other ReportCacheKey. -
getReport
Returns the report name (file path) of the report.- Returns:
- The report name (file path) of the report.
- Since:
- 6.0
-
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
Returns the export format of the report.- Returns:
- The export format of the report.
- Since:
- 6.0
-
toString
Returns a String representation of this ReportCacheKey.
-