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

Inherited by org.sleuthkit.autopsy.contentviewers.Metadata, org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact, org.sleuthkit.autopsy.corecomponents.DataContentViewerHex, org.sleuthkit.autopsy.corecomponents.DataContentViewerMedia, org.sleuthkit.autopsy.corecomponents.DataContentViewerString, org.sleuthkit.autopsy.examples.SampleContentViewer, and org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.

Public Member Functions

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

Detailed Description

Interface that DataContentViewer modules must implement. These modules analyze an individual file that the user has selected and display results in some form of JPanel. We find it easiest to use the NetBeans IDE to first make a "JPanel Form" class and then have it implement DataContentViewer. This allows you to easily use the UI builder for the layout.

Definition at line 32 of file DataContentViewer.java.

Member Function Documentation

DataContentViewer org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.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

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

Component org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.getComponent ( )
String org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.getTitle ( )
String org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.getToolTip ( )
int org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.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.

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

boolean org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.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

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

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

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

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