aQute.bnd.service.reporter

Interface ReportGeneratorService

@ProviderType
public interface ReportGeneratorService

This plugin can generate a DTO report of an arbitrary object. One can implements the ReportEntryPlugin plugin for a specific object type to contribute to a report.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	generateReportOf(java.lang.Object source) Generate a DTO report of the source object.
java.util.Map<java.lang.String,java.lang.Object>	generateReportOf(java.lang.Object source, java.util.Locale locale) Generate a DTO report of the source object, data will be localized for the specified locale if any.
java.util.Map<java.lang.String,java.lang.Object>	generateReportOf(java.lang.Object source, java.util.Locale locale, java.lang.String filter) Generate a DTO report of the source object, data will be localized for the specified locale if any.
java.util.Map<java.lang.String,java.lang.Object>	generateReportOf(java.lang.Object source, java.lang.String filter) Generate a DTO report of the source object.

Method Detail

generateReportOf

java.util.Map<java.lang.String,java.lang.Object> generateReportOf(java.lang.Object source)

Generate a DTO report of the source object.

Parameters:

source - the source object from which the report is generated, if null an empty report is returned.

Returns:

the report, never null

generateReportOf

java.util.Map<java.lang.String,java.lang.Object> generateReportOf(java.lang.Object source,
                                                                  java.lang.String filter)

Generate a DTO report of the source object.

Parameters:

source - the source object from which the report is generated, if null an empty report is returned.

filter - a LDAP filter used to filter the ReportEntryPlugin plugins which will contribute to the report, if not specified all configured ReportEntryPlugin plugins that handle the source object type will contribute.

Returns:

the report, never null

generateReportOf

java.util.Map<java.lang.String,java.lang.Object> generateReportOf(java.lang.Object source,
                                                                  java.util.Locale locale)

Generate a DTO report of the source object, data will be localized for the specified locale if any.

Parameters:

source - the source object from which the report is generated, if null an empty report is returned.

locale - a locale to localized extracted data, if not specified data will be unlocalized.

Returns:

the report, never null

generateReportOf

java.util.Map<java.lang.String,java.lang.Object> generateReportOf(java.lang.Object source,
                                                                  java.util.Locale locale,
                                                                  java.lang.String filter)

Generate a DTO report of the source object, data will be localized for the specified locale if any.

Parameters:

source - the source object from which the report is generated, if null an empty report is returned.

locale - a locale to localized extracted data, if not specified data will be unlocalized.

filter - a LDAP filter used to filter the ReportEntryPlugin plugins which will contribute to the report, if not specified all configured ReportEntryPlugin plugins that handle the source object type will contribute.

Returns:

the report, never null