org.sleuthkit.autopsy.textsummarizer.TextSummarizer Interface Reference

Public Member Functions
String	getName ()
TextSummary	summarize (AbstractFile file, int summarySize) throws IOException

Detailed Description

Interface for implementation of summarizers for documents.

Definition at line 27 of file TextSummarizer.java.

Member Function Documentation

String org.sleuthkit.autopsy.textsummarizer.TextSummarizer.getName

(

)

Get the name of the TextSummarizer for identification purposes.

Returns

The name of the TextSummarizer.

TextSummary org.sleuthkit.autopsy.textsummarizer.TextSummarizer.summarize	(	AbstractFile	file,
		int	summarySize
	)		throws IOException

Summarize the provided abstract file into a summary with a size no greater than the size specified.

Parameters

file	The AbstractFile to summarize.
summarySize	The size of the summary to create.

Returns

The summary as a TextSummary object.

Exceptions

IOException

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

---

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

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