Class ReportPlugin

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, InputLocationTracker

    public class ReportPlugin
    extends ConfigurationContainer
    implements java.io.Serializable, java.lang.Cloneable
    The <plugin> element contains informations required for a report plugin.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form
    • Constructor Detail

      • ReportPlugin

        public ReportPlugin()
    • Method Detail

      • addReportSet

        public void addReportSet​(ReportSet reportSet)
        Method addReportSet.
        Parameters:
        reportSet -
      • getArtifactId

        public java.lang.String getArtifactId()
        Get the artifact ID of the reporting plugin in the repository.
        Returns:
        String
      • getGroupId

        public java.lang.String getGroupId()
        Get the group ID of the reporting plugin in the repository.
        Returns:
        String
      • getReportSets

        public java.util.List<ReportSet> getReportSets()
        Method getReportSets.
        Returns:
        List
      • getVersion

        public java.lang.String getVersion()
        Get the version of the reporting plugin to be used.
        Returns:
        String
      • removeReportSet

        public void removeReportSet​(ReportSet reportSet)
        Method removeReportSet.
        Parameters:
        reportSet -
      • setArtifactId

        public void setArtifactId​(java.lang.String artifactId)
        Set the artifact ID of the reporting plugin in the repository.
        Parameters:
        artifactId -
      • setGroupId

        public void setGroupId​(java.lang.String groupId)
        Set the group ID of the reporting plugin in the repository.
        Parameters:
        groupId -
      • setReportSets

        public void setReportSets​(java.util.List<ReportSet> reportSets)
        Set multiple specifications of a set of reports, each having (possibly) different configuration. This is the reporting parallel to an execution in the build.
        Parameters:
        reportSets -
      • setVersion

        public void setVersion​(java.lang.String version)
        Set the version of the reporting plugin to be used.
        Parameters:
        version -
      • flushReportSetMap

        public void flushReportSetMap()
        Reset the reportSetMap field to null
      • getReportSetsAsMap

        public java.util.Map<java.lang.String,​ReportSet> getReportSetsAsMap()
        Returns:
        a Map of reportSets field with ReportSet#getId() as key
        See Also:
        ReportSet.getId()
      • getKey

        public java.lang.String getKey()
        Returns:
        the key of the report plugin, ie groupId:artifactId
      • constructKey

        public static java.lang.String constructKey​(java.lang.String groupId,
                                                    java.lang.String artifactId)
        Parameters:
        groupId - The group ID of the plugin in the repository
        artifactId - The artifact ID of the reporting plugin in the repository
        Returns:
        the key of the report plugin, ie groupId:artifactId