Autopsy  4.1
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer Class Reference

Inherits org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Classes

class  NextFindActionListener
 
class  NextPageActionListener
 
class  PrevFindActionListener
 
class  PrevPageActionListener
 
class  SourceChangeActionListener
 

Public Member Functions

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

Private Member Functions

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

Private Attributes

volatile Node currentNode = null
 
IndexedText currentSource = null
 
ExtractedContentPanel panel
 

Static Private Attributes

static final long INVALID_DOCUMENT_ID = 0L
 
static final Logger logger = Logger.getLogger(ExtractedContentViewer.class.getName())
 
static final BlackboardAttribute.Type TSK_ASSOCIATED_ARTIFACT_TYPE = new BlackboardAttribute.Type(TSK_ASSOCIATED_ARTIFACT)
 

Detailed Description

A content viewer that displays the indexed text associated with a file or an artifact, possibly marked up with HTML to highlight keyword hits.

Definition at line 53 of file ExtractedContentViewer.java.

Constructor & Destructor Documentation

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

Constructs a content viewer that displays the indexed text associated with a file or an artifact, possibly marked up with HTML to highlight keyword hits.

Definition at line 69 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 251 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 256 of file ExtractedContentViewer.java.

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

Gets the object ID to use as the document ID for accessing any indexed text for the given node.

Parameters
nodeThe node.
Returns
The document ID or zero, which is an invalid document ID.

If the node is a Blackboard artifact node for anything other than a keyword hit, the document ID for the text extracted from the artifact (the concatenation of its attributes) is the artifact ID, a large, negative integer. If it is a keyword hit, see if there is an associated artifact. If there is, get the associated artifact's ID and return it.

Definition at line 368 of file ExtractedContentViewer.java.

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 241 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 246 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
nodeNode 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 318 of file ExtractedContentViewer.java.

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
nodeNode to check for support
Returns
True if the node can be displayed / processed, else false

Is there any marked up indexed text in the look up of this node? This will be the case if the node is for a keyword hit artifact produced by either an ad hoc keyword search result (keyword search toolbar widgets) or a keyword search by the keyword search ingest module.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 277 of file ExtractedContentViewer.java.

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.nextPage ( )
private
void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.previousPage ( )
private
void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.resetComponent ( )

Resets the contents of the viewer / component.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 269 of file ExtractedContentViewer.java.

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.scrollToCurrentHit ( )
private
void org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.setNode ( Node  selectedNode)
inherited
void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.setNode ( final Node  node)

Sets the node displayed by the content viewer.

Parameters
nodeThe node to display

Definition at line 78 of file ExtractedContentViewer.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

void org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.setPanel ( List< IndexedText >  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 337 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 350 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 508 of file ExtractedContentViewer.java.

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

Definition at line 504 of file ExtractedContentViewer.java.

Member Data Documentation

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

Definition at line 61 of file ExtractedContentViewer.java.

IndexedText org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.currentSource = null
private

Definition at line 62 of file ExtractedContentViewer.java.

final long org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.INVALID_DOCUMENT_ID = 0L
staticprivate

Definition at line 57 of file ExtractedContentViewer.java.

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

Definition at line 55 of file ExtractedContentViewer.java.

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

Definition at line 60 of file ExtractedContentViewer.java.

final BlackboardAttribute.Type org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.TSK_ASSOCIATED_ARTIFACT_TYPE = new BlackboardAttribute.Type(TSK_ASSOCIATED_ARTIFACT)
staticprivate

Definition at line 58 of file ExtractedContentViewer.java.


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

Copyright © 2012-2016 Basis Technology. Generated on: Mon Jan 2 2017
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.