Class SecurityInspectorReport<TRow,TColumnGroup,TColumnItem,TEntryReport>
java.lang.Object
org.jenkinsci.plugins.securityinspector.model.SecurityInspectorReport<TRow,TColumnGroup,TColumnItem,TEntryReport>
- Type Parameters:
TRow- Class of the Rows in the reportTColumnGroup- Class of the column group definitionsTColumnItem- Class of item reports within a groupTEntryReport- Class of the stored entries
- Direct Known Subclasses:
PermissionReport
public abstract class SecurityInspectorReport<TRow,TColumnGroup,TColumnItem,TEntryReport>
extends Object
Basic class for reports being generated by the plugin. This class implements
the following report format:
- The report is being returned as a table
- Columns are grouped into several groups
- Rows are not grouped
- Author:
- Ksenia Nenasheva
-
Method Summary
Modifier and TypeMethodDescriptionprotected final voidfillRowByResult(TRow row, TEntryReport result) voidfinal voidgenerateReport(Set<TRow> rows, Set<TColumnItem> columns, Set<TColumnGroup> groups) abstract StringgetColumnTitle(TColumnItem column) Retrieves a title for the specified column.org.apache.commons.collections.map.MultiKeyMapfinal TEntryReportgetEntry(TRow row, TColumnItem column) protected abstract TEntryReportgetEntryReport(TRow row, TColumnItem item) Retrieves an entry for the specified row and column values.abstract TColumnGroupgetGroupOfItem(TColumnItem item) Retrieve a group for an item.abstract StringgetGroupTitle(TColumnGroup group) Retrieves a title for the specified group.abstract Collection<TColumnItem> getItemsOfGroup(TColumnGroup group) Retrieves items for a group.protected final String[][]abstract StringGet report target name (e.g.abstract StringReturns display name for the row grouping cell.getRows()abstract StringgetRowTitle(TRow row) Retrieves a title for the specified row.abstract booleanisEntryReportOk(TRow row, TColumnItem column, TEntryReport reportEntry) Verifies that the generated entry is correct.
-
Method Details
-
getReportTargetName
Get report target name (e.g. user or job)- Returns:
- localisable full display name
-
getEntries
@Nonnull public org.apache.commons.collections.map.MultiKeyMap getEntries() -
getGroups
-
getRows
-
getColumns
-
getEntry
-
forRow
-
generateReport
public final void generateReport(@Nonnull Set<TRow> rows, @Nonnull Set<TColumnItem> columns, @Nonnull Set<TColumnGroup> groups) -
fillRowByResult
-
getRowComparator
-
getColumnComparator
-
getGroupOfItem
Retrieve a group for an item.- Parameters:
item- Item to be analyzed- Returns:
- Assigned group. Never
null
-
getItemsOfGroup
Retrieves items for a group.- Parameters:
group- Group- Returns:
- Collection of items. May be empty, but never
null
-
getEntryReport
@Nonnull protected abstract TEntryReport getEntryReport(@Nonnull TRow row, @Nonnull TColumnItem item) Retrieves an entry for the specified row and column values.- Parameters:
row- Rowitem- Column- Returns:
- Entry for the report table
-
getRowColumnHeader
Returns display name for the row grouping cell.- Returns:
- Localizable text for the column header
-
getRowTitle
Retrieves a title for the specified row.- Parameters:
row- Row- Returns:
- Localizable text title
-
getGroupTitle
Retrieves a title for the specified group.- Parameters:
group- Group- Returns:
- Localizable text title
-
getColumnTitle
Retrieves a title for the specified column.- Parameters:
column- Column- Returns:
- Localizable text title
-
isEntryReportOk
public abstract boolean isEntryReportOk(@Nonnull TRow row, @Nonnull TColumnItem column, @Nonnull TEntryReport reportEntry) Verifies that the generated entry is correct.- Parameters:
row- Rowcolumn- ColumnreportEntry- Generated report entry- Returns:
trueif the check passed
-
getReportInMatrix
-
getReportInCSV
-