Autopsy  4.1
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | List of all members
org.sleuthkit.autopsy.datamodel.TextMarkupLookup Interface Reference

Inherited by org.sleuthkit.autopsy.keywordsearch.HighlightedText.

Public Member Functions

TextMarkupLookup createInstance (long objectId, String keyword, boolean isRegex, String originalQuery)

Detailed Description

This interface acts as a sort of bridge between the Autopsy Core NetBeans Module (NBM) and the Autopsy KeywordSearch NBM. It is used to get indexed text marked up with HTML to highlight search hits for a particular keyword.

Here is an example of how it works. It is used to put highlighted markup into the Lookups of the BlackboardArtifactNodes for keyword search hit artifacts. The BlackboardArtifactNode code that populates the node's Lookup asks the default global Lookup for an instance of TextMarkupLookup. The org.sleuthkit.autopsy.keywordsearch.HighlightedText class is the sole implementation of the interface, so the BlackboardArtifactNode gets a default constructed instance of HighlightedText. This otherwise useless instance is then used to call createInstance with parameters that are used to employ the Solr highlighting capability to create the markup. The TextMarkupLookup object goes in the BlackboardArtifactNode Lookup for later use by the ExtractedContentViewer, a DataContentViewer in the KeywordSearch NBM.

Definition at line 39 of file

Member Function Documentation

TextMarkupLookup org.sleuthkit.autopsy.datamodel.TextMarkupLookup.createInstance ( long  objectId,
String  keyword,
boolean  isRegex,
String  originalQuery 

Factory method for getting an object that encapsulates indexed text marked up (HTML) to highlight search hits for a particular keyword.

objectIdID of the object (file or artifact) that is the source of the indexed text.
keywordThe keyword to be highlighted in the text.
isRegexWhether or not the query that follows is a regex.
originalQueryThe query that produces the keyword hit.
An object that encapsulates indexed text marked up (HTML) to highlight search hits for a particular keyword.

Referenced by org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.getHighlightLookup().

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

Copyright © 2012-2016 Basis Technology. Generated on: Tue Oct 25 2016
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.