fr.opensagres.xdocreport.document.registry

Class XDocReportRegistry

java.lang.Object

fr.opensagres.xdocreport.core.registry.AbstractRegistry<IXDocReportFactoryDiscovery>

fr.opensagres.xdocreport.document.registry.XDocReportRegistry

All Implemented Interfaces:

ITemplateCacheInfoProvider, java.io.Serializable

public class XDocReportRegistry
extends AbstractRegistry<IXDocReportFactoryDiscovery>
implements ITemplateCacheInfoProvider, java.io.Serializable

Registry for loading and caching IXDocReport instances.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XDocReportRegistry()

Method Summary

Modifier and Type	Method and Description
void	checkReportId(java.lang.String reportId) Check if registry can register the report with this id.
void	clear() Clear the cached reports.
protected ICacheStorage<java.lang.String,IXDocReport>	createCache() Create the storage cache to store instances of IXDocReport.
IXDocReport	createReport(java.io.InputStream sourceStream)
IXDocReport	createReport(XDocArchive documentArchive)
protected void	doDispose()
boolean	existsReport(java.lang.String reportId) Returns true if report identified with the given id exists in the registry and false otherwise.
java.lang.String	generateUniqueReportId(java.lang.String reportId) Generate unique report id.
java.util.Collection<IXDocReport>	getCachedReports() Returns cached report IXDocReport;
MimeMapping	getMimeMapping(java.lang.String fileExtension) Returns mime mapping for the file extension.
static XDocReportRegistry	getRegistry()
IXDocReport	getReport(java.lang.String reportId) Returns the report identified with the given id.
java.util.Collection<IXDocReportFactoryDiscovery>	getReportFactoryDiscoveries() Returns list of report factory discoveries.
IEntryInfo	getTemplateCacheInfo(java.lang.String reportId, java.lang.String entryName)
IXDocReport	loadReport(java.io.InputStream sourceStream) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, boolean cacheReport) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, ITemplateEngine templateEngine) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, ITemplateEngine templateEngine, boolean cacheReport) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, java.lang.String reportId) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, java.lang.String reportId, boolean cacheReport) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, java.lang.String reportId, ITemplateEngine templateEngine) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, java.lang.String reportId, ITemplateEngine templateEngine, boolean cacheReport) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, java.lang.String reportId, java.lang.String templateEngineKind) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, java.lang.String reportId, java.lang.String templateEngineKind, boolean cacheReport) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, java.lang.String reportId, TemplateEngineKind templateEngineKind) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, java.lang.String reportId, TemplateEngineKind templateEngineKind, boolean cacheReport) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, TemplateEngineKind templateEngineKind) Load report.
IXDocReport	loadReport(java.io.InputStream sourceStream, TemplateEngineKind templateEngineKind, boolean cacheReport) Load report.
protected boolean	registerInstance(IXDocReportFactoryDiscovery instance)
void	registerReport(IXDocReport report) Register report and throws XDocReportException if it already exists a report in the registry with the same id .
void	registerReport(IXDocReport report, boolean force) Register report.
void	setClearTimeout(long timeout) Clear cache with timeout.
void	unregisterReport(IXDocReport report) Unregister report.
void	unregisterReport(java.lang.String reportId) Unregister report identified with the given id.

Methods inherited from class fr.opensagres.xdocreport.core.registry.AbstractRegistry

dispose, initialize, initializeIfNeeded, onEndInitialization, onStartInitialization

Methods inherited from class java.lang.Object

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

Constructor Detail

XDocReportRegistry

public XDocReportRegistry()

Method Detail

createCache

protected ICacheStorage<java.lang.String,IXDocReport> createCache()

Create the storage cache to store instances of IXDocReport.

Returns:

getRegistry

public static XDocReportRegistry getRegistry()

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream)
                       throws java.io.IOException,
                              XDocReportException

Load report. Note : this function does't cache the report.

Parameters:

sourceStream -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              boolean cacheReport)
                       throws java.io.IOException,
                              XDocReportException

Load report.

Parameters:

sourceStream -

cacheReport -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              java.lang.String reportId)
                       throws java.io.IOException,
                              XDocReportException

Load report. Note : this function cache the report.

Parameters:

sourceStream -

reportId -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              java.lang.String reportId,
                              boolean cacheReport)
                       throws java.io.IOException,
                              XDocReportException

Load report.

Parameters:

sourceStream -

reportId -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              java.lang.String reportId,
                              ITemplateEngine templateEngine)
                       throws java.io.IOException,
                              XDocReportException

Load report. Note : this function cache the report.

Parameters:

sourceStream -

reportId -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              java.lang.String reportId,
                              ITemplateEngine templateEngine,
                              boolean cacheReport)
                       throws java.io.IOException,
                              XDocReportException

Load report.

Parameters:

sourceStream -

reportId -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              java.lang.String reportId,
                              java.lang.String templateEngineKind)
                       throws java.io.IOException,
                              XDocReportException

Load report. Note : this function cache the report.

Parameters:

sourceStream -

reportId -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              java.lang.String reportId,
                              java.lang.String templateEngineKind,
                              boolean cacheReport)
                       throws java.io.IOException,
                              XDocReportException

Load report.

Parameters:

sourceStream -

reportId -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              java.lang.String reportId,
                              TemplateEngineKind templateEngineKind)
                       throws java.io.IOException,
                              XDocReportException

Load report. Note : this function cache the report.

Parameters:

sourceStream -

reportId -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              java.lang.String reportId,
                              TemplateEngineKind templateEngineKind,
                              boolean cacheReport)
                       throws java.io.IOException,
                              XDocReportException

Load report.

Parameters:

sourceStream -

reportId -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              ITemplateEngine templateEngine)
                       throws java.io.IOException,
                              XDocReportException

Load report. Note : this function does't cache the report.

Parameters:

sourceStream -

templateEngine -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              ITemplateEngine templateEngine,
                              boolean cacheReport)
                       throws java.io.IOException,
                              XDocReportException

Load report.

Parameters:

sourceStream -

templateEngine -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              TemplateEngineKind templateEngineKind)
                       throws java.io.IOException,
                              XDocReportException

Load report. Note : this function does't cache the report.

Parameters:

sourceStream -

templateEngineKind -

Returns:

Throws:

java.io.IOException

XDocReportException

loadReport

public IXDocReport loadReport(java.io.InputStream sourceStream,
                              TemplateEngineKind templateEngineKind,
                              boolean cacheReport)
                       throws java.io.IOException,
                              XDocReportException

Load report.

Parameters:

sourceStream -

templateEngineKind -

Returns:

Throws:

java.io.IOException

XDocReportException

createReport

public IXDocReport createReport(java.io.InputStream sourceStream)
                         throws java.io.IOException,
                                XDocReportException

Throws:

java.io.IOException

XDocReportException

createReport

public IXDocReport createReport(XDocArchive documentArchive)
                         throws java.io.IOException,
                                XDocReportException

Throws:

java.io.IOException

XDocReportException

registerReport

public void registerReport(IXDocReport report)
                    throws XDocReportException

Register report and throws XDocReportException if it already exists a report in the registry with the same id .

Parameters:

report -

Throws:

XDocReportException

registerReport

public void registerReport(IXDocReport report,
                           boolean force)
                    throws XDocReportException

Register report.

Parameters:

report - the report to register

force - true if report must be forced (if report already exists with the same id) and false otherwise (throw XDocReportException if report exists with the same id).

Throws:

XDocReportException

checkReportId

public void checkReportId(java.lang.String reportId)
                   throws XDocReportException

Check if registry can register the report with this id.

Parameters:

reportId -

Throws:

XDocReportException

getReport

public IXDocReport getReport(java.lang.String reportId)

Returns the report identified with the given id.

Parameters:

reportId -

Returns:

existsReport

public boolean existsReport(java.lang.String reportId)

Returns true if report identified with the given id exists in the registry and false otherwise.

Specified by:

existsReport in interface ITemplateCacheInfoProvider

Parameters:

reportId -

Returns:

unregisterReport

public void unregisterReport(java.lang.String reportId)

Unregister report identified with the given id.

Parameters:

reportId -

unregisterReport

public void unregisterReport(IXDocReport report)

Unregister report.

Parameters:

report -

getReportFactoryDiscoveries

public java.util.Collection<IXDocReportFactoryDiscovery> getReportFactoryDiscoveries()

Returns list of report factory discoveries.

Returns:

getCachedReports

public java.util.Collection<IXDocReport> getCachedReports()

Returns cached report IXDocReport;

Returns:

setClearTimeout

public void setClearTimeout(long timeout)

Clear cache with timeout. If this method is called, you must call AbstractRegistry.dispose() method at the end of your program to stop the timer Thread.

Parameters:

timeout -

clear

public void clear()

Clear the cached reports.

getMimeMapping

public MimeMapping getMimeMapping(java.lang.String fileExtension)
                           throws java.io.IOException,
                                  XDocReportException

Returns mime mapping for the file extension.

Parameters:

fileExtension -

Returns:

Throws:

java.io.IOException

XDocReportException

generateUniqueReportId

public java.lang.String generateUniqueReportId(java.lang.String reportId)

Generate unique report id.

Parameters:

reportId -

Returns:

getTemplateCacheInfo

public IEntryInfo getTemplateCacheInfo(java.lang.String reportId,
                                       java.lang.String entryName)

Specified by:

getTemplateCacheInfo in interface ITemplateCacheInfoProvider

doDispose

protected void doDispose()

Specified by:

doDispose in class AbstractRegistry<IXDocReportFactoryDiscovery>

registerInstance

protected boolean registerInstance(IXDocReportFactoryDiscovery instance)

Specified by:

registerInstance in class AbstractRegistry<IXDocReportFactoryDiscovery>