Package com.inet.report.cache
Interface EngineFactory
- All Known Implementing Classes:
EngineFactoryImpl
public interface EngineFactory
An instance of this interface creates a
ReportCacheKey
and Engine
based on the properties.
The Cache
is calling the current factory to build keys and engines.
You can implement your EngineFactory
to create or modify an Engine
with RDC. You can set your
implementation with Cache.setEngineFactory(EngineFactory)
.
The created key must be unique for the created Engine
.-
Method Summary
Modifier and TypeMethodDescriptioncreateEngine
(Properties props) Creates anEngine
based on the properties.getKey
(Properties props) Creates an unique key for theEngine
thatcreateEngine(Properties)
returns.
-
Method Details
-
createEngine
Creates anEngine
based on the properties.- Parameters:
props
- contains parameters for theEngine
. e.g. "export_fmt" =Engine.EXPORT_PDF
. The properties should not modified.- Returns:
- the created
Engine
- Throws:
ReportException
- will be thrown when setting parameters for theEngine
failed- Since:
- 6.0
-
getKey
Creates an unique key for theEngine
thatcreateEngine(Properties)
returns. This value can benull
. If the value isnull
then the default key generation algorithm is used.- Parameters:
props
- contains parameters for theEngine
. Every value that modify theEngine
should be part of the key. The properties should not be modified.- Returns:
- the created
ReportCacheKey
- Throws:
ReportException
- will be thrown when the parameters are incomplete.- Since:
- 6.0
-