org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer Class Reference

Inherits org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Classes
class	IsDirVisitor
class	NextFindActionListener
class	NextPageActionListener
class	PrevFindActionListener
class	PrevPageActionListener
class	SourceChangeActionListener

Public Member Functions
	ExtractedContentViewer ()
void	setNode (final Node selectedNode)
String	getTitle ()
String	getToolTip ()
DataContentViewer	createInstance ()
synchronized Component	getComponent ()
void	resetComponent ()
boolean	isSupported (Node node)
int	isPreferred (Node node)
void	setNode (Node selectedNode)

Private Member Functions
void	scrollToCurrentHit ()
void	setPanel (List< TextMarkup > sources)
boolean	solrHasContent (Long objectId)
Long	getDocumentId (Node node)
void	updateSearchControls ()
void	updatePageControls ()
void	nextPage ()
void	previousPage ()

Private Attributes
ExtractedContentPanel	panel
volatile Node	currentNode = null
TextMarkup	currentSource = null
final IsDirVisitor	isDirVisitor = new IsDirVisitor()

Static Private Attributes
static final Logger	logger = Logger.getLogger(ExtractedContentViewer.class.getName())

Detailed Description

Displays marked-up (HTML) content for a Node. The sources are all the MarkupSource items in the selected Node's lookup, plus the content that Solr extracted (if there is any).

Definition at line 50 of file ExtractedContentViewer.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.ExtractedContentViewer

(

)

Definition at line 59 of file ExtractedContentViewer.java.

Member Function Documentation

DataContentViewer org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.createInstance

(

)

Create and return a new instance of your viewer. The reason that this is needed is because the specific viewer modules will be found via NetBeans Lookup and the type will only be DataContentViewer. This method is used to get an instance of your specific type.

Returns

A new instance of the viewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 146 of file ExtractedContentViewer.java.

synchronized Component org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.getComponent

(

)

Return the Swing Component to display. Implementations of this method that extend JPanel and do a 'return this;'. Otherwise return an internal instance of the JPanel.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 151 of file ExtractedContentViewer.java.

Long org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.getDocumentId ( Node  node )

private

Get the correct document id for the given node. If the node contains a HighlightedTextMarkup object, its object id will have been set. Otherwise the document id is obtained from the Content object.

Parameters

node

Returns

Either the artifact id, file id or 0.

Definition at line 260 of file ExtractedContentViewer.java.

References org::sleuthkit::datamodel::Content.getId().

String org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.getTitle

(

)

Returns the title of this viewer to display in the tab.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 136 of file ExtractedContentViewer.java.

String org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.getToolTip

(

)

Returns a short description of this viewer to use as a tool tip for its tab.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 141 of file ExtractedContentViewer.java.

int org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.isPreferred

(

Node

node

)

Checks whether the given viewer is preferred for the Node. This is a bit subjective, but the idea is that Autopsy wants to display the most relevant tab. The more generic the viewer, the lower the return value should be. This will only be called on viewers that support the given node.

Parameters

node	Node to check for preference

Returns

an int (0-10) higher return means the viewer has higher priority 0 means not supported 1 to 2 means the module will display all file types (such as the hex viewer) 3-10 are prioritized by Content viewer developer. Modules that operate on very few file types should be towards 10.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 194 of file ExtractedContentViewer.java.

References org::sleuthkit::datamodel::BlackboardArtifact.getArtifactTypeID(), and org::sleuthkit::datamodel::BlackboardArtifact::ARTIFACT_TYPE.TSK_KEYWORD_HIT.

boolean org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.isSupported

(

Node

node

)

Checks whether the given node is supported by the viewer. This will be used to enable or disable the tab for the viewer.

Parameters

node	Node to check for support

Returns

True if the node can be displayed / processed, else false

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 172 of file ExtractedContentViewer.java.

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.nextPage ( )

private

Definition at line 376 of file ExtractedContentViewer.java.

References org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.scrollToCurrentHit().

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.previousPage ( )

private

Definition at line 409 of file ExtractedContentViewer.java.

References org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.scrollToCurrentHit().

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.resetComponent

(

)

Resets the contents of the viewer / component.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 164 of file ExtractedContentViewer.java.

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.scrollToCurrentHit ( )

private

Definition at line 125 of file ExtractedContentViewer.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.nextPage(), and org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.previousPage().

void org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.setNode ( Node  selectedNode )

inherited

Autopsy will call this when this panel is focused with the file that should be analyzed. When called with null, must clear all references to previous nodes.

Implemented in org.sleuthkit.autopsy.corecomponents.DataContentViewerString, org.sleuthkit.autopsy.corecomponents.DataContentViewerHex, org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact, org.sleuthkit.autopsy.contentviewers.Metadata, and org.sleuthkit.autopsy.corecomponents.DataContentViewerMedia.

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.setNode

(

final Node

selectedNode

)

Definition at line 64 of file ExtractedContentViewer.java.

References org::sleuthkit::datamodel::Content.accept(), and org::sleuthkit::datamodel::Content.getSize().

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.setPanel ( List< TextMarkup >  sources )

private

Set the MarkupSources for the panel to display (safe to call even if the panel hasn't been created yet)

Parameters

sources

Definition at line 212 of file ExtractedContentViewer.java.

boolean org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.solrHasContent ( Long  objectId )

private

Check if Solr has extracted content for a given node

Parameters

objectId

Returns

true if Solr has content, else false

Definition at line 239 of file ExtractedContentViewer.java.

References org.sleuthkit.autopsy.keywordsearch.KeywordSearch.getServer(), and org.sleuthkit.autopsy.keywordsearch.Server.queryIsIndexed().

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.updatePageControls ( )

private

Definition at line 372 of file ExtractedContentViewer.java.

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.updateSearchControls ( )

private

Definition at line 368 of file ExtractedContentViewer.java.

Member Data Documentation

volatile Node org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.currentNode = null

private

Definition at line 54 of file ExtractedContentViewer.java.

TextMarkup org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.currentSource = null

private

Definition at line 55 of file ExtractedContentViewer.java.

final IsDirVisitor org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.isDirVisitor = new IsDirVisitor()

private

Definition at line 56 of file ExtractedContentViewer.java.

final Logger org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.logger = Logger.getLogger(ExtractedContentViewer.class.getName())

staticprivate

Definition at line 52 of file ExtractedContentViewer.java.

ExtractedContentPanel org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.panel

private

Definition at line 53 of file ExtractedContentViewer.java.

---

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

• /home/carriersleuth/repos/autopsy/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/ExtractedContentViewer.java