org.sleuthkit.autopsy.textsummarizer.TextSummary Class Reference

Public Member Functions
	TextSummary (String summary, Image image, int countOfImages)
int	getNumberOfImages ()
Image	getSampleImage ()
String	getSummaryText ()

Private Attributes
final int	numberOfImages
final Image	sampleImage
final String	summaryText

Detailed Description

Class to contain all information necessary to display a summary for a file.s

Definition at line 26 of file TextSummary.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.textsummarizer.TextSummary.TextSummary	(	String	summary,
		Image	image,
		int	countOfImages
	)

Create a new TextSummary object.

Parameters

summary	- The text portion of the summary.
image	- The Image portion of the summary
countOfImages	- The number of images including the one provided in the document.

Definition at line 40 of file TextSummary.java.

Member Function Documentation

int org.sleuthkit.autopsy.textsummarizer.TextSummary.getNumberOfImages

(

)

Returns

the numberOfImages

Definition at line 63 of file TextSummary.java.

References org.sleuthkit.autopsy.textsummarizer.TextSummary.numberOfImages.

Image org.sleuthkit.autopsy.textsummarizer.TextSummary.getSampleImage

(

)

Returns

the sampleImage

Definition at line 56 of file TextSummary.java.

References org.sleuthkit.autopsy.textsummarizer.TextSummary.sampleImage.

String org.sleuthkit.autopsy.textsummarizer.TextSummary.getSummaryText

(

)

Returns

the summaryText

Definition at line 49 of file TextSummary.java.

References org.sleuthkit.autopsy.textsummarizer.TextSummary.summaryText.

Referenced by org.sleuthkit.autopsy.discovery.search.FileSearch.summarize().

Member Data Documentation

final int org.sleuthkit.autopsy.textsummarizer.TextSummary.numberOfImages

private

Definition at line 30 of file TextSummary.java.

Referenced by org.sleuthkit.autopsy.textsummarizer.TextSummary.getNumberOfImages().

final Image org.sleuthkit.autopsy.textsummarizer.TextSummary.sampleImage

private

Definition at line 29 of file TextSummary.java.

Referenced by org.sleuthkit.autopsy.textsummarizer.TextSummary.getSampleImage().

final String org.sleuthkit.autopsy.textsummarizer.TextSummary.summaryText

private

Definition at line 28 of file TextSummary.java.

Referenced by org.sleuthkit.autopsy.textsummarizer.TextSummary.getSummaryText().

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/textsummarizer/TextSummary.java