Inherits org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.

Public Member Functions
	SnapShotReportWriter (Case currentCase, Path reportFolderPath, String reportName, ZoomState zoomState, Date generationDate, BufferedImage snapshot)

Path	writeReport () throws IOException

Protected Member Functions
void	fillTemplateAndWrite (final String templateLocation, final String templateName, Object context, final Path outPutFile) throws IOException

Case	getCurrentCase ()

Path	getReportFolderPath ()

String	getReportName ()

void	writeSnapShotHTMLFile () throws IOException

Private Attributes
final BufferedImage	image

final ZoomState	zoomState

Detailed Description

Generate and write the Timeline snapshot report to disk.

Definition at line 35 of file SnapShotReportWriter.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.SnapShotReportWriter	(	Case	currentCase,
		Path	reportFolderPath,
		String	reportName,
		ZoomState	zoomState,
		Date	generationDate,
		BufferedImage	snapshot
	)

Constructor

Parameters

currentCase	The Case to write a report for.
reportFolderPath	The Path to the folder that will contain the report.
reportName	The name of the report.
zoomState	The ZoomState in effect when the snapshot was taken.
generationDate	The generation Date of the report.
snapshot	A snapshot of the view to include in the report.

Definition at line 52 of file SnapShotReportWriter.java.

References org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.zoomState.

Member Function Documentation

void org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.fillTemplateAndWrite	(	final String	templateLocation,
		final String	templateName,
		Object	context,
		final Path	outPutFile
	)		throws IOException

protectedinherited

Fill in the mustache template at the given location using the values from the given context object and save it to the given outPutFile.

Parameters

templateLocation	The location of the template. suitible for use with Class.getResourceAsStream
templateName	The name of the tempalte. (Used by mustache to cache templates?)
context	The contect to use to fill in the template values.
outPutFile	The filled in tempalte will be saced at this Path.

Exceptions

IOException If there is a problem saving the filled in template to disk.

Definition at line 186 of file UiSnapShotReportWriter.java.

Referenced by org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeIndexHTML(), org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSnapShotHTMLFile(), org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.writeSnapShotHTMLFile(), and org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeSummaryHTML().

Case org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getCurrentCase ( )

protectedinherited

Get the case for this report.

Returns: Current case object

Definition at line 118 of file UiSnapShotReportWriter.java.

References org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.currentCase.

Referenced by org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.writeSnapShotHTMLFile().

Path org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getReportFolderPath ( )

protectedinherited

Get the folder path for the report.

Returns: Report folder path

Definition at line 109 of file UiSnapShotReportWriter.java.

References org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.reportFolderPath.

Referenced by org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSnapShotHTMLFile(), and org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.writeSnapShotHTMLFile().

String org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getReportName ( )

protectedinherited

Get the name for the report.

Returns: Returns the reportName

Definition at line 100 of file UiSnapShotReportWriter.java.

References org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.reportName.

Referenced by org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSnapShotHTMLFile(), and org.sleuthkit.autopsy.communications.snapshot.CommSnapShotReportWriter.writeSnapShotHTMLFile().

Path org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeReport ( ) throws IOException

inherited

Generate and write the report to disk.

Returns: The Path to the "main file" of the report. This is the file that Autopsy shows in the results view when the Reports Node is selected in the DirectoryTree.

Exceptions

IOException If there is a problem writing the report.

Definition at line 84 of file UiSnapShotReportWriter.java.

References org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.copyResources(), org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeIndexHTML(), org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeSnapShotHTMLFile(), and org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.writeSummaryHTML().

Referenced by org.sleuthkit.autopsy.communications.VisualizationPanel.createReport().

void org.sleuthkit.autopsy.timeline.snapshot.SnapShotReportWriter.writeSnapShotHTMLFile ( ) throws IOException

protected

Generate and write the html page that shows the snapshot and the ZoomState

Exceptions

IOException If there is a problem writing the html file to disk.

Definition at line 64 of file SnapShotReportWriter.java.

References org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.fillTemplateAndWrite(), org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getReportFolderPath(), org.sleuthkit.autopsy.report.uisnapshot.UiSnapShotReportWriter.getReportName(), and org.sleuthkit.autopsy.timeline.zooming.ZoomState.getTimeRange().