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

Public Member Functions
	PieChartExport (String keyColumnHeader, String valueColumnHeader, String valueFormatString, String chartTitle, List< PieChartItem > slices)

	PieChartExport (String keyColumnHeader, String valueColumnHeader, String valueFormatString, String chartTitle, String sheetName, List< PieChartItem > slices, 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

Private Attributes
final String	chartTitle

final int	colOffset

final int	colSize

final int	rowPadding

final int	rowSize

final String	sheetName

final ExcelTableExport< PieChartItem,?extends ExcelCellModel >	tableExport

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 = 20

Detailed Description

Class that creates an excel pie chart along with data table.

Definition at line 47 of file PieChartExport.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.PieChartExport	(	String	keyColumnHeader,
		String	valueColumnHeader,
		String	valueFormatString,
		String	chartTitle,
		List< PieChartItem >	slices
	)

Main constructor assuming defaults.

Parameters

keyColumnHeader	The header column name for the table descriptions (i.e. file types).
valueColumnHeader	The header column name for the values.
valueFormatString	The excel format string to use for values.
chartTitle	The title for the chart.
slices	The values for the pie slices.

Definition at line 72 of file PieChartExport.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.chartTitle, org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.DEFAULT_COL_OFFSET, org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.DEFAULT_COL_SIZE, org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.DEFAULT_ROW_PADDING, and org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.DEFAULT_ROW_SIZE.

org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.PieChartExport	(	String	keyColumnHeader,
		String	valueColumnHeader,
		String	valueFormatString,
		String	chartTitle,
		String	sheetName,
		List< PieChartItem >	slices,
		int	colOffset,
		int	rowPadding,
		int	colSize,
		int	rowSize
	)

Main constructor.

Parameters

keyColumnHeader	The header column name for the table descriptions (i.e. file types).
valueColumnHeader	The header column name for the values.
valueFormatString	The excel format string to use for values.
chartTitle	The title for the chart.
sheetName	The sheet name if used as a sheet export.
slices	The values for the pie slices.
colOffset	The column spacing between the table and the chart.
rowPadding	The padding between this and data above or below (if used as an ExcelItemExportable).
colSize	The column size of the chart.
rowSize	The row size of the chart.

Definition at line 96 of file PieChartExport.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.chartTitle, org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.colOffset, org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.colSize, org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.rowPadding, org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.rowSize, and org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.sheetName.

Member Function Documentation

String org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.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 117 of file PieChartExport.java.

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

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

Renders this item to an excel worksheet.

Parameters

sheet	The worksheet.
env	The environment and preferences to use while exporting.

Exceptions

ExcelExportException

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

Definition at line 122 of file PieChartExport.java.

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

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

Writes the item to the sheet in the special format export sheet.

Parameters

sheet	The sheet.
rowStart	The starting row to start writing.
colStart	The starting column to start writing.
env	The excel export context.

Returns: The dimensions of what has been written.

Exceptions

ExcelExportException

Implements org.sleuthkit.autopsy.datasourcesummary.uiutils.ExcelSpecialFormatExport.ExcelItemExportable.

Definition at line 127 of file PieChartExport.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.colOffset, org.sleuthkit.autopsy.datasourcesummary.uiutils.ExcelSpecialFormatExport.ItemDimensions.getColStart(), org.sleuthkit.autopsy.datasourcesummary.uiutils.ExcelSpecialFormatExport.ItemDimensions.getRowEnd(), org.sleuthkit.autopsy.datasourcesummary.uiutils.ExcelSpecialFormatExport.ItemDimensions.getRowStart(), org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.rowSize, and org.sleuthkit.autopsy.datasourcesummary.uiutils.ExcelTableExport< T, C extends ExcelCellModel >.write().

Referenced by org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.renderSheet().

Member Data Documentation

final String org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.chartTitle

private

Definition at line 59 of file PieChartExport.java.

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

final int org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.colOffset

private

Definition at line 55 of file PieChartExport.java.

Referenced by org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.PieChartExport(), and org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.write().

final int org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.colSize

private

Definition at line 57 of file PieChartExport.java.

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

final int org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.DEFAULT_COL_OFFSET = 1

staticprivate

Definition at line 52 of file PieChartExport.java.

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

final int org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.DEFAULT_COL_SIZE = 10

staticprivate

Definition at line 50 of file PieChartExport.java.

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

final int org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.DEFAULT_ROW_PADDING = 1

staticprivate

Definition at line 51 of file PieChartExport.java.

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

final int org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.DEFAULT_ROW_SIZE = 20

staticprivate

Definition at line 49 of file PieChartExport.java.

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

final int org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.rowPadding

private

Definition at line 56 of file PieChartExport.java.

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

final int org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.rowSize

private

Definition at line 58 of file PieChartExport.java.

Referenced by org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.PieChartExport(), and org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.write().

final String org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.sheetName

private

Definition at line 60 of file PieChartExport.java.

Referenced by org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.getSheetName(), and org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.PieChartExport().

final ExcelTableExport<PieChartItem, ? extends ExcelCellModel> org.sleuthkit.autopsy.datasourcesummary.uiutils.PieChartExport.tableExport

private

Definition at line 54 of file PieChartExport.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/datasourcesummary/uiutils/PieChartExport.java

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation