Autopsy  4.10.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.corecomponents.DataResultTopComponent Class Reference

Inherits TopComponent, org.sleuthkit.autopsy.corecomponentinterfaces.DataResult, and Provider.

Public Member Functions

 DataResultTopComponent (String title)
 
 DataResultTopComponent (boolean isMain, String title)
 
boolean canClose ()
 
void componentActivated ()
 
void componentClosed ()
 
void componentOpened ()
 
ExplorerManager getExplorerManager ()
 
int getPersistenceType ()
 
String getPreferredID ()
 
Node getRootNode ()
 
List< DataResultViewergetViewers ()
 
boolean isMain ()
 
void open ()
 
void resetTabs (Node node)
 
void setNode (Node selectedNode)
 
void setPath (String pathText)
 
void setSelectedNodes (Node[] selected)
 
void setTitle (String title)
 

Static Public Member Functions

static DataResultTopComponent createInstance (String title, String description, Node node, int childNodeCount)
 
static DataResultTopComponent createInstance (String title, String description, Node node, int childNodeCount, Collection< DataResultViewer > viewers)
 
static DataResultTopComponent createInstance (String title)
 
static DataResultTopComponent createInstance (String title, String mode, String description, Node node, int childNodeCount, DataContentTopComponent contentViewTopComponent)
 
static List< String > getActiveComponentIds ()
 
static void initInstance (String description, Node node, int childNodeCount, DataResultTopComponent resultViewTopComponent)
 

Protected Member Functions

String preferredID ()
 

Private Member Functions

 DataResultTopComponent (boolean isMain, String title, String mode, Collection< DataResultViewer > viewers, DataContentTopComponent contentViewTopComponent)
 
void customizeComponent (String title)
 
void initComponents ()
 
void setNumberOfChildNodes (int childNodeCount)
 

Private Attributes

final String customModeName
 
final DataResultPanel dataResultPanel
 
final ExplorerManager explorerManager
 
final boolean isMain
 

Static Private Attributes

static final List< String > activeComponentIds = Collections.synchronizedList(new ArrayList<String>())
 
static final Logger logger = Logger.getLogger(DataResultTopComponent.class.getName())
 

Detailed Description

A DataResultTopComponent object is a NetBeans top component that provides multiple views of the application data represented by a NetBeans Node. It is a result view component (implements DataResult) that contains a result view panel (DataResultPanel), which is also a result view component. The result view panel is a JPanel with a JTabbedPane child component that contains a collection of result viewers. Each result viewer (implements DataResultViewer) presents a different view of the current node. Result viewers are usually JPanels that display the child nodes of the current node using a NetBeans explorer view child component. The result viewers are either supplied during construction of the result view top component or provided by the result viewer extension point (service providers that implement DataResultViewer).

Result view top components are typically docked into the upper right hand side of the main application window (editor mode), and are linked to the content view in the lower right hand side of the main application window (output mode) by the result view panel. The panel passes single node selections in the active result viewer to the content view.

The "main" result view top component receives its current node as a selection from the case tree view in the top component (DirectoryTreeYopComponent) docked into the left hand side of the main application window.

Result view top components are explorer manager providers to connect the lookups of the nodes displayed in the NetBeans explorer views of the result viewers to the actions global context.

Definition at line 73 of file DataResultTopComponent.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.DataResultTopComponent ( String  title)

Creates a result view top component that provides multiple views of the application data represented by a NetBeans Node. The result view will be the "main" result view and will docked into the upper right hand side of the main application window (editor mode) and will be linked to the content view in the lower right hand side of the main application window (output mode). Its result viewers are provided by the result viewer extension point (service providers that implement DataResultViewer).

IMPORTANT: The "main" result view top component receives its current node as a selection from the case tree view in the top component (DirectoryTreeTopComponent) docked into the left hand side of the main application window. This constructor is RESERVED for the use of the DirectoryTreeTopComponent singleton only. DO NOT USE OTHERWISE.

Parameters
titleThe title for the top component, appears on the top component's tab.

Definition at line 214 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataContentTopComponent.findInstance().

org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.DataResultTopComponent ( boolean  isMain,
String  title,
String  mode,
Collection< DataResultViewer viewers,
DataContentTopComponent  contentViewTopComponent 
)
private

Constructs a result view top component that provides multiple views of the application data represented by a NetBeans Node.

Parameters
isMainWhether or not this is the "main" result view top component.
titleThe title for the top component, appears on the top component's tab.
modeThe NetBeans Window system mode into which this top component should be docked. If null, the editor mode will be used by default.
viewersA collection of result viewers. If empty, the result viewers provided by the results viewer extension point will be used.
contentViewTopComponentA content view to which this result view will be linked, possibly null.

Definition at line 236 of file DataResultTopComponent.java.

org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.DataResultTopComponent ( boolean  isMain,
String  title 
)

Creates a partially initialized result view top component that provides multiple views of the application data represented by a NetBeans Node. The result view will be docked into the upper right hand side of the main application window (editor mode) and will be linked to the content view in the lower right hand side of the main application window (output mode). Its result viewers are provided by the result viewer extension point (service providers that implement DataResultViewer).

IMPORTANT: Initialization MUST be completed by calling initInstance.

Parameters
isMainIgnored.
titleThe title for the top component, appears on the top component's tab.
Deprecated:
Use an appropriate overload of createIntance instead.

Definition at line 448 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataContentTopComponent.findInstance().

Member Function Documentation

boolean org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.canClose ( )
void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.componentActivated ( )
void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.componentClosed ( )

Definition at line 342 of file DataResultTopComponent.java.

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.componentOpened ( )
static DataResultTopComponent org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.createInstance ( String  title,
String  description,
Node  node,
int  childNodeCount 
)
static

Creates a result view top component that provides multiple views of the application data represented by a NetBeans Node. The result view will be docked into the upper right hand side of the main application window (editor mode) and will be linked to the content view in the lower right hand side of the main application window (output mode). Its result viewers are provided by the result viewer extension point (service providers that implement DataResultViewer).

Parameters
titleThe title for the top component, appears on the top component's tab.
descriptionDescriptive text about the node displayed, appears on the top component's tab
nodeThe node to display.
childNodeCountThe cardinality of the node's children.
Returns
The result view top component.

Definition at line 100 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataContentTopComponent.findInstance().

static DataResultTopComponent org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.createInstance ( String  title,
String  description,
Node  node,
int  childNodeCount,
Collection< DataResultViewer viewers 
)
static

Creates a result view top component that provides multiple views of the application data represented by a NetBeans Node. The result view will be docked into the upper right hand side of the main application window (editor mode) and will be linked to the content view in the lower right hand side of the main application window (output mode).

Parameters
titleThe title for the top component, appears on the top component's tab.
descriptionDescriptive text about the node displayed, appears on the top component's tab
nodeThe node to display.
childNodeCountThe cardinality of the node's children.
viewersA collection of result viewers to use instead of the result viewers provided by the results viewer extension point.
Returns
The result view top component.

Definition at line 125 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataContentTopComponent.findInstance().

static DataResultTopComponent org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.createInstance ( String  title)
static

Creates a partially initialized result view top component that provides multiple views of the application data represented by a NetBeans Node. The result view will be docked into the upper right hand side of the main application window (editor mode) and will be linked to the content view in the lower right hand side of the main application window (output mode). Its result viewers are provided by the result viewer extension point (service providers that implement DataResultViewer).

IMPORTANT: Initialization MUST be completed by calling initInstance.

Parameters
titleThe title for the result view top component, appears on the top component's tab.
Returns
The partially initialized result view top component.

Definition at line 147 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataContentTopComponent.findInstance().

static DataResultTopComponent org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.createInstance ( String  title,
String  mode,
String  description,
Node  node,
int  childNodeCount,
DataContentTopComponent  contentViewTopComponent 
)
static

Creates a result view top component that provides multiple views of the application data represented by a NetBeans Node. The result view will be docked into a custom mode and linked to the supplied content view. Its result viewers are provided by the result viewer extension point (service providers that implement DataResultViewer).

Parameters
titleThe title for the top component, appears on the top component's tab.
modeThe NetBeans Window system mode into which this top component should be docked.
descriptionDescriptive text about the node displayed, appears on the top component's tab
nodeThe node to display.
childNodeCountThe cardinality of the node's children.
contentViewTopComponentA content view to which this result view will be linked.
Returns
The result view top component.

Definition at line 190 of file DataResultTopComponent.java.

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.customizeComponent ( String  title)
private
static List<String> org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getActiveComponentIds ( )
static

Get a listing of the preferred identifiers of all the result view top components that have been created.

Returns
The listing.

Definition at line 271 of file DataResultTopComponent.java.

ExplorerManager org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getExplorerManager ( )

Definition at line 261 of file DataResultTopComponent.java.

int org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getPersistenceType ( )

Definition at line 276 of file DataResultTopComponent.java.

String org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getPreferredID ( )

Gets the preferred identifier for this result view panel in the window system.

Returns
The preferred identifier.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 354 of file DataResultTopComponent.java.

Node org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getRootNode ( )
List<DataResultViewer> org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.getViewers ( )

Get child viewers within this DataResult

Returns

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 299 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultPanel.getViewers().

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.initComponents ( )
private

This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.

Definition at line 412 of file DataResultTopComponent.java.

static void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.initInstance ( String  description,
Node  node,
int  childNodeCount,
DataResultTopComponent  resultViewTopComponent 
)
static

Initializes a partially initialized result view top component.

Parameters
descriptionDescriptive text about the node displayed, appears on the top component's tab
nodeThe node to display.
childNodeCountThe cardinality of the node's children.
resultViewTopComponentThe partially initialized result view top component.

Definition at line 162 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.open(), org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setNode(), org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setNumberOfChildNodes(), and org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setPath().

boolean org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.isMain ( )

Gets whether or not this result view panel is the "main" result view panel used to view the child nodes of a node selected in the application tree view (DirectoryTreeTopComponent) that is normally docked into the left hand side of the main window.

Returns
True or false.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 374 of file DataResultTopComponent.java.

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.open ( )
String org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.preferredID ( )
protected

Definition at line 349 of file DataResultTopComponent.java.

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.resetTabs ( Node  node)

Sets the node for which this result view component should provide multiple views of the underlying application data.

Parameters
nodeThe node, may be null. If null, the call to this method is equivalent to a call to resetComponent on this result view component's result viewers.
Deprecated:
Use setNode instead.

Definition at line 463 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultPanel.setNode().

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setNode ( Node  node)

Sets the node for which this result view component should provide multiple views of the underlying application data.

Parameters
nodeThe node, may be null. If null, the call to this method is equivalent to a call to resetComponent on this result view component's result viewers.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 359 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultPanel.setNode().

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.initInstance().

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setNumberOfChildNodes ( int  childNodeCount)
private

Sets the cardinality of the current node's children

Parameters
childNodeCountThe cardinality of the node's children.

Definition at line 402 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultPanel.setNumberOfChildNodes().

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.initInstance().

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setPath ( String  pathText)

Sets the descriptive text about the source of the nodes displayed in this result view component.

Parameters
pathTextThe text to display.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 369 of file DataResultTopComponent.java.

References org.sleuthkit.autopsy.corecomponents.DataResultPanel.setPath().

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.initInstance().

void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setSelectedNodes ( Node[]  selected)
void org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.setTitle ( String  title)

Sets the title of this result view component.

Parameters
titleThe title.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResult.

Definition at line 364 of file DataResultTopComponent.java.

Member Data Documentation

final List<String> org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.activeComponentIds = Collections.synchronizedList(new ArrayList<String>())
staticprivate

Definition at line 76 of file DataResultTopComponent.java.

final String org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.customModeName
private

Definition at line 78 of file DataResultTopComponent.java.

final DataResultPanel org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.dataResultPanel
private

Definition at line 80 of file DataResultTopComponent.java.

final ExplorerManager org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.explorerManager
private

Definition at line 79 of file DataResultTopComponent.java.

final boolean org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.isMain
private

Definition at line 77 of file DataResultTopComponent.java.

final Logger org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.logger = Logger.getLogger(DataResultTopComponent.class.getName())
staticprivate

Definition at line 75 of file DataResultTopComponent.java.


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

Copyright © 2012-2018 Basis Technology. Generated on: Fri Mar 22 2019
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.