Autopsy  4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport Class Reference

Inherits org.sleuthkit.autopsy.datasourcesummary.uiutils.ExcelSpecialFormatExport.ExcelItemExportable, and org.sleuthkit.autopsy.datasourcesummary.uiutils.ExcelExport.ExcelSheetExport.

Public Member Functions

 BarChartExport (String keyColumnHeader, String valueFormatString, String chartTitle, List< BarChartSeries > categories)
 
 BarChartExport (String keyColumnHeader, String valueFormatString, String chartTitle, String sheetName, List< BarChartSeries > categories, int colOffset, int rowPadding, int colSize, int rowSize)
 
String getSheetName ()
 
void renderSheet (Sheet sheet, ExcelExport.WorksheetEnv env) throws ExcelExport.ExcelExportException
 
ItemDimensions write (Sheet sheet, int rowStart, int colStart, ExcelExport.WorksheetEnv env) throws ExcelExportException
 

Static Private Member Functions

static ExcelTableExport< Pair< Object, List< Double > >,?extends ExcelCellModelgetTableModel (List< BarChartSeries > categories, String keyColumnHeader, String chartTitle)
 

Private Attributes

final List< BarChartSeriescategories
 
final String chartTitle
 
final int colOffset
 
final int colSize
 
final String keyColumnHeader
 
final int rowPadding
 
final int rowSize
 
final String sheetName
 
final ExcelTableExport< Pair< Object, List< Double > >,?extends ExcelCellModeltableExport
 

Static Private Attributes

static final int DEFAULT_COL_OFFSET = 1
 
static final int DEFAULT_COL_SIZE = 10
 
static final int DEFAULT_ROW_PADDING = 1
 
static final int DEFAULT_ROW_SIZE = 15
 

Detailed Description

Class that creates an excel stacked bar chart along with data table.

Definition at line 60 of file BarChartExport.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.BarChartExport ( String  keyColumnHeader,
String  valueFormatString,
String  chartTitle,
List< BarChartSeries categories 
)

Main constructor that assumes some defaults (i.e. chart size follows defaults and sheet name is chart title).

Parameters
keyColumnHeaderThe header column name for the table descriptions (i.e. types: file types / artifact types).
valueFormatStringThe excel format string to use for values.
chartTitleThe title for the chart.
categoriesThe categories along with data.

Definition at line 157 of file BarChartExport.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.categories, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.chartTitle, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.DEFAULT_COL_OFFSET, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.DEFAULT_COL_SIZE, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.DEFAULT_ROW_PADDING, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.DEFAULT_ROW_SIZE, and org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.keyColumnHeader.

org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.BarChartExport ( String  keyColumnHeader,
String  valueFormatString,
String  chartTitle,
String  sheetName,
List< BarChartSeries categories,
int  colOffset,
int  rowPadding,
int  colSize,
int  rowSize 
)

Main constructor.

Parameters
keyColumnHeaderThe header column name for the table descriptions (i.e. types: file types / artifact types).
valueFormatStringThe excel format string to use for values.
chartTitleThe title for the chart.
sheetNameThe sheet name if used as a sheet export.
categoriesThe categories along with data.
colOffsetThe column spacing between the table and the chart.
rowPaddingThe padding between this and data above or below (if used as an ExcelItemExportable).
colSizeThe column size of the chart.
rowSizeThe row size of the chart.

Definition at line 180 of file BarChartExport.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.categories, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.chartTitle, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.colOffset, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.colSize, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.getTableModel(), org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.keyColumnHeader, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.rowPadding, org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.rowSize, and org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.sheetName.

Member Function Documentation

String org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.getSheetName ( )

Returns the name of the sheet to use with this item.

NOTE: there can be no duplicates in a workbook.

Returns
The name of the sheet to use with this item.

Implements org.sleuthkit.autopsy.datasourcesummary.uiutils.ExcelExport.ExcelSheetExport.

Definition at line 197 of file BarChartExport.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.sheetName.

static ExcelTableExport<Pair<Object, List<Double> >, ? extends ExcelCellModel> org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.getTableModel ( List< BarChartSeries categories,
String  keyColumnHeader,
String  chartTitle 
)
staticprivate

Creates an excel table model to be written to an excel sheet and used as a datasource for the chart.

Parameters
categoriesThe categories with their data.
keyColumnHeaderThe header column name for the table descriptions (i.e. types: file types / artifact types).
chartTitleThe title for the chart.
Returns
An excel table export to be used as the data source for the chart in the excel document.

Definition at line 73 of file BarChartExport.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.chartTitle, and org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.keyColumnHeader.

Referenced by org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.BarChartExport().

void org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.renderSheet ( Sheet  sheet,
ExcelExport.WorksheetEnv  env 
) throws ExcelExport.ExcelExportException

Renders this item to an excel worksheet.

Parameters
sheetThe worksheet.
envThe environment and preferences to use while exporting.
Exceptions
ExcelExportException

Implements org.sleuthkit.autopsy.datasourcesummary.uiutils.ExcelExport.ExcelSheetExport.

Definition at line 202 of file BarChartExport.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.write().

ItemDimensions org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.write ( Sheet  sheet,
int  rowStart,
int  colStart,
ExcelExport.WorksheetEnv  env 
) throws ExcelExportException

Member Data Documentation

final List<BarChartSeries> org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.categories
private
final String org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.chartTitle
private
final int org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.colOffset
private
final int org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.colSize
private
final int org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.DEFAULT_COL_OFFSET = 1
staticprivate
final int org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.DEFAULT_COL_SIZE = 10
staticprivate
final int org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.DEFAULT_ROW_PADDING = 1
staticprivate
final int org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.DEFAULT_ROW_SIZE = 15
staticprivate
final String org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.keyColumnHeader
private
final int org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.rowPadding
private
final int org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.rowSize
private
final String org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.sheetName
private
final ExcelTableExport<Pair<Object, List<Double> >, ? extends ExcelCellModel> org.sleuthkit.autopsy.datasourcesummary.uiutils.BarChartExport.tableExport
private

Definition at line 137 of file BarChartExport.java.


The documentation for this class was generated from the following file:

Copyright © 2012-2021 Basis Technology. Generated on: Thu Jul 8 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.