org.sleuthkit.autopsy.corecomponents.DataResultViewerTable Class Reference

Inherits org.sleuthkit.autopsy.corecomponents.AbstractDataResultViewer.

Inherited by org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributesSearchResultsViewerTable.

Classes
class	ColumnSortInfo
class	CountCellRenderer
class	HasCommentCellRenderer
enum	HasCommentStatus
class	IconRendererTableListener
class	PagingSupport
enum	Score
class	ScoreCellRenderer
class	TableListener

Public Member Functions
	DataResultViewerTable ()
	DataResultViewerTable (ExplorerManager explorerManager)
	DataResultViewerTable (ExplorerManager explorerManager, String title)
void	clearComponent ()
DataResultViewer	createInstance ()
default void	expandNode (Node node)
Component	getComponent ()
ExplorerManager	getExplorerManager ()
String	getTitle ()
boolean	isSupported (Node candidateRootNode)
default void	resetComponent ()
default void	setContentViewer (DataContent contentViewer)
void	setNode (Node rootNode)
void	setSelectedNodes (Node[] selected)

Protected Member Functions
void	addTreeExpansionListener (TreeExpansionListener listener)
TableColumnModel	getColumnModel ()
void	setColumnWidths ()

Private Member Functions
synchronized void	assignColumns (List< Property<?>> props)
void	compactPropertiesMap ()
void	exportCSVButtonActionPerformed (java.awt.event.ActionEvent evt)
void	gotoPageTextFieldActionPerformed (java.awt.event.ActionEvent evt)
void	initComponents ()
void	initializePagingSupport ()
synchronized List< Node.Property<?> >	loadColumnOrder ()
synchronized void	loadColumnSorting ()
synchronized void	loadColumnVisibility ()
void	pageNextButtonActionPerformed (java.awt.event.ActionEvent evt)
void	pagePrevButtonActionPerformed (java.awt.event.ActionEvent evt)
void	populateColumnMap ()
void	setupTable ()
synchronized void	storeColumnOrder ()
synchronized void	storeColumnSorting ()
synchronized void	storeColumnVisibility ()

Private Attributes
final Map< String, ETableColumn >	columnMap
javax.swing.JButton	exportCSVButton
javax.swing.JLabel	gotoPageLabel
javax.swing.JTextField	gotoPageTextField
final IconRendererTableListener	iconRendererListener
final Map< String, PagingSupport >	nodeNameToPagingSupportMap = new ConcurrentHashMap<>()
final Outline	outline
org.openide.explorer.view.OutlineView	outlineView
final TableListener	outlineViewListener
javax.swing.JLabel	pageLabel
javax.swing.JButton	pageNextButton
javax.swing.JLabel	pageNumLabel
javax.swing.JButton	pagePrevButton
javax.swing.JLabel	pagesLabel
PagingSupport	pagingSupport = null
final Map< Integer, Property<?> >	propertiesMap
Node	rootNode
final String	title

Static Private Attributes
static final ImageIcon	COMMENT_ICON = new ImageIcon(ImageUtilities.loadImage(NOTEPAD_ICON_PATH, false))
static final String	FIRST_COLUMN_LABEL = Bundle.DataResultViewerTable_firstColLbl()
static final ImageIcon	INTERESTING_SCORE_ICON = new ImageIcon(ImageUtilities.loadImage(YELLOW_CIRCLE_ICON_PATH, false))
static final Logger	LOGGER = Logger.getLogger(DataResultViewerTable.class.getName())
static final ImageIcon	NOTABLE_ICON_SCORE = new ImageIcon(ImageUtilities.loadImage(RED_CIRCLE_ICON_PATH, false))
static final String	NOTEPAD_ICON_PATH = "org/sleuthkit/autopsy/images/notepad16.png"
static final String	RED_CIRCLE_ICON_PATH = "org/sleuthkit/autopsy/images/red-circle-exclamation.png"
static final long	serialVersionUID = 1L
static final String	YELLOW_CIRCLE_ICON_PATH = "org/sleuthkit/autopsy/images/yellow-circle-yield.png"

Detailed Description

A tabular result viewer that displays the children of the given root node using an OutlineView.

Instances of this class should use the explorer manager of an ancestor top component to connect the lookups of the nodes displayed in the OutlineView to the actions global context. The explorer manager can be supplied during construction, but the typical use case is for the result viewer to find the ancestor top component's explorer manager at runtime.

Definition at line 103 of file DataResultViewerTable.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.DataResultViewerTable

(

)

Constructs a tabular result viewer that displays the children of the given root node using an OutlineView. The viewer should have an ancestor top component to connect the lookups of the nodes displayed in the OutlineView to the actions global context. The explorer manager will be discovered at runtime.

Definition at line 143 of file DataResultViewerTable.java.

org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.DataResultViewerTable

(

ExplorerManager

explorerManager

)

Constructs a tabular result viewer that displays the children of a given root node using an OutlineView. The viewer should have an ancestor top component to connect the lookups of the nodes displayed in the OutlineView to the actions global context.

Parameters

explorerManager

The explorer manager of the ancestor top component.

Definition at line 156 of file DataResultViewerTable.java.

org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.DataResultViewerTable	(	ExplorerManager	explorerManager,
		String	title
	)

Constructs a tabular result viewer that displays the children of a given root node using an OutlineView with a given title. The viewer should have an ancestor top component to connect the lookups of the nodes displayed in the OutlineView to the actions global context.

Parameters

explorerManager	The explorer manager of the ancestor top component.
title	The title.

Definition at line 170 of file DataResultViewerTable.java.

Member Function Documentation

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.addTreeExpansionListener ( TreeExpansionListener  listener )

protected

Adds a tree expansion listener to the OutlineView of this tabular results viewer.

Parameters

listener

The listener

Definition at line 391 of file DataResultViewerTable.java.

Referenced by org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributesSearchResultsViewerTable.CommonAttributesSearchResultsViewerTable().

synchronized void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.assignColumns ( List< Property<?>>  props )

private

Definition at line 606 of file DataResultViewerTable.java.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.clearComponent

(

)

Frees the resources that have been allocated by this tabular results viewer, in preparation for permanently disposing of it.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.

Definition at line 830 of file DataResultViewerTable.java.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.compactPropertiesMap ( )

private

Makes properties map 0-indexed and re-arranges elements to make sure the indexes are continuous.

Definition at line 798 of file DataResultViewerTable.java.

DataResultViewer org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.createInstance

(

)

Creates a new instance of a tabular result viewer that displays the children of a given root node using an OutlineView. This method exists to make it possible to use the default service provider instance of this class in the "main" results view of the application, while using distinct instances in other places in the UI.

Returns

A new instance of a tabular result viewer,

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.

Definition at line 254 of file DataResultViewerTable.java.

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.expandNode ( Node  node )

inherited

Sets the node for which this result viewer should provide a view of the underlying application data model object, and expands the node.

Parameters

node

The node.

Deprecated:

This API is not used by the application.

Definition at line 126 of file DataResultViewer.java.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.exportCSVButtonActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 1498 of file DataResultViewerTable.java.

References org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.Message.info(), and org.sleuthkit.autopsy.directorytree.ExportCSVAction.saveNodesToCSV().

TableColumnModel org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.getColumnModel ( )

protected

Definition at line 598 of file DataResultViewerTable.java.

Referenced by org.sleuthkit.autopsy.commonpropertiessearch.CommonAttributesSearchResultsViewerTable.setColumnWidths().

Component org.sleuthkit.autopsy.corecomponents.AbstractDataResultViewer.getComponent ( )

inherited

Gets the Swing component for this viewer.

Returns

The component.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.

Definition at line 87 of file AbstractDataResultViewer.java.

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

inherited

Definition at line 70 of file AbstractDataResultViewer.java.

References org.sleuthkit.autopsy.corecomponents.AbstractDataResultViewer.explorerManager.

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultViewerThumbnail.PageUpdater.childrenAdded(), org.sleuthkit.autopsy.corecomponents.DataResultViewerThumbnail.NodeSelectionListener.propertyChange(), org.sleuthkit.autopsy.corecomponents.AbstractDataResultViewer.setSelectedNodes(), and org.sleuthkit.autopsy.corecomponents.DataResultViewerThumbnail.switchPage().

String org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.getTitle

(

)

Gets the title of this tabular result viewer.

Returns

title of tab.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.

Definition at line 265 of file DataResultViewerTable.java.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.gotoPageTextFieldActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 1492 of file DataResultViewerTable.java.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.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 1370 of file DataResultViewerTable.java.

References org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.FIRST_COLUMN_LABEL.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.initializePagingSupport ( )

private

Set up a change listener so we know when the user changes the page size

If multiple nodes have been viewed we have to notify all of them about the change in page size.

Definition at line 218 of file DataResultViewerTable.java.

References org.sleuthkit.autopsy.core.UserPreferences.addChangeListener(), org.sleuthkit.autopsy.core.UserPreferences.RESULTS_TABLE_PAGE_SIZE, and org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.PagingSupport.togglePageControls().

boolean org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.isSupported

(

Node

candidateRootNode

)

Indicates whether a given node is supported as a root node for this tabular viewer.

Parameters

candidateRootNode

The candidate root node.

Returns

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.

Definition at line 278 of file DataResultViewerTable.java.

synchronized List<Node.Property<?> > org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.loadColumnOrder ( )

private

Gets a list of child properties (columns) in the order persisted in the preference file. Also initialized the properties map with the column order.

Returns

a List<Node.Property<?>> of the properties in the persisted order.

Definition at line 752 of file DataResultViewerTable.java.

synchronized void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.loadColumnSorting ( )

private

Reads and applies the column sorting information persisted to the preferences file. Must be called after loadColumnOrder, since it depends on the properties map being initialized, and after assignColumns, since it cannot set the sort on columns that have not been added to the table.

Definition at line 701 of file DataResultViewerTable.java.

synchronized void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.loadColumnVisibility ( )

private

Reads and applies the column visibility information persisted to the preferences file.

Definition at line 727 of file DataResultViewerTable.java.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.pageNextButtonActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 1488 of file DataResultViewerTable.java.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.pagePrevButtonActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 1484 of file DataResultViewerTable.java.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.populateColumnMap ( )

private

Definition at line 497 of file DataResultViewerTable.java.

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.resetComponent ( )

inherited

Resets the state of the Swing component for this viewer to its default state.

Implemented in org.sleuthkit.autopsy.corecomponents.DataResultViewerThumbnail.

Definition at line 107 of file DataResultViewer.java.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.setColumnWidths ( )

protected

Definition at line 516 of file DataResultViewerTable.java.

default void org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.setContentViewer ( DataContent  contentViewer )

inherited

Sets a custom content viewer to which nodes selected in this result viewer should be pushed via DataContent.setNode.

Parameters

contentViewer

The content viewer.

Deprecated:

This API is not used by the application.

Definition at line 138 of file DataResultViewer.java.

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.setNode

(

Node

rootNode

)

Sets the current root node of this tabular result viewer.

Parameters

rootNode

The node to set as the current root node, possibly null.

Check to see if we have previously created a paging support class for this node.

This is the only somewhat reliable way I could find to reset the cursor after a page change. When you change page the old children nodes will be removed and new ones added.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.

Definition at line 289 of file DataResultViewerTable.java.

References org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.TableListener.listenToVisibilityChanges(), and org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.PagingSupport.updateControls().

void org.sleuthkit.autopsy.corecomponents.AbstractDataResultViewer.setSelectedNodes ( Node[]  selectedNodes )

inherited

Requests selection of the given child nodes of the node passed to setNode. This method should be implemented as a no-op for result viewers that do not display the child nodes of a given root node using a NetBeans explorer view set up to use a given explorer manager.

Parameters

selectedNodes

The child nodes to select.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer.

Definition at line 78 of file AbstractDataResultViewer.java.

References org.sleuthkit.autopsy.corecomponents.AbstractDataResultViewer.getExplorerManager().

void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.setupTable ( )

private

Sets up the Outline view of this tabular result viewer by creating column headers based on the children of the current root node. The persisted column order, sorting and visibility is used.

Definition at line 400 of file DataResultViewerTable.java.

References org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.TableListener.listenToVisibilityChanges(), and org.sleuthkit.autopsy.datamodel.NodeSelectionInfo.matches().

synchronized void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.storeColumnOrder ( )

private

Persists the current column ordering for the child OutlineView of this tabular result viewer using a preferences file.

Definition at line 652 of file DataResultViewerTable.java.

synchronized void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.storeColumnSorting ( )

private

Persists the current column sorting information using a preferences file.

Definition at line 669 of file DataResultViewerTable.java.

synchronized void org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.storeColumnVisibility ( )

private

Persists the current column visibility information for the child OutlineView of this tabular result viewer using a preferences file.

Definition at line 626 of file DataResultViewerTable.java.

Member Data Documentation

final Map<String, ETableColumn> org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.columnMap

private

Definition at line 117 of file DataResultViewerTable.java.

final ImageIcon org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.COMMENT_ICON = new ImageIcon(ImageUtilities.loadImage(NOTEPAD_ICON_PATH, false))

staticprivate

Definition at line 111 of file DataResultViewerTable.java.

javax.swing.JButton org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.exportCSVButton

private

Definition at line 1508 of file DataResultViewerTable.java.

final String org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.FIRST_COLUMN_LABEL = Bundle.DataResultViewerTable_firstColLbl()

staticprivate

Definition at line 115 of file DataResultViewerTable.java.

Referenced by org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.initComponents().

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.gotoPageLabel

private

Definition at line 1509 of file DataResultViewerTable.java.

javax.swing.JTextField org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.gotoPageTextField

private

Definition at line 1510 of file DataResultViewerTable.java.

final IconRendererTableListener org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.iconRendererListener

private

Definition at line 121 of file DataResultViewerTable.java.

final ImageIcon org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.INTERESTING_SCORE_ICON = new ImageIcon(ImageUtilities.loadImage(YELLOW_CIRCLE_ICON_PATH, false))

staticprivate

Definition at line 112 of file DataResultViewerTable.java.

final Logger org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.LOGGER = Logger.getLogger(DataResultViewerTable.class.getName())

staticprivate

Definition at line 106 of file DataResultViewerTable.java.

final Map<String, PagingSupport> org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.nodeNameToPagingSupportMap = new ConcurrentHashMap<>()

private

Multiple nodes may have been visited in the context of this DataResultViewerTable. We keep track of the page state for these nodes in the following map.

Definition at line 129 of file DataResultViewerTable.java.

final ImageIcon org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.NOTABLE_ICON_SCORE = new ImageIcon(ImageUtilities.loadImage(RED_CIRCLE_ICON_PATH, false))

staticprivate

Definition at line 113 of file DataResultViewerTable.java.

final String org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.NOTEPAD_ICON_PATH = "org/sleuthkit/autopsy/images/notepad16.png"

staticprivate

Definition at line 108 of file DataResultViewerTable.java.

final Outline org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.outline

private

Definition at line 119 of file DataResultViewerTable.java.

org.openide.explorer.view.OutlineView org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.outlineView

private

Definition at line 1511 of file DataResultViewerTable.java.

final TableListener org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.outlineViewListener

private

Definition at line 120 of file DataResultViewerTable.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.pageLabel

private

Definition at line 1512 of file DataResultViewerTable.java.

javax.swing.JButton org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.pageNextButton

private

Definition at line 1513 of file DataResultViewerTable.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.pageNumLabel

private

Definition at line 1514 of file DataResultViewerTable.java.

javax.swing.JButton org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.pagePrevButton

private

Definition at line 1515 of file DataResultViewerTable.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.pagesLabel

private

Definition at line 1516 of file DataResultViewerTable.java.

PagingSupport org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.pagingSupport = null

private

The paging support instance for the current node.

Definition at line 134 of file DataResultViewerTable.java.

final Map<Integer, Property<?> > org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.propertiesMap

private

Definition at line 118 of file DataResultViewerTable.java.

final String org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.RED_CIRCLE_ICON_PATH = "org/sleuthkit/autopsy/images/red-circle-exclamation.png"

staticprivate

Definition at line 109 of file DataResultViewerTable.java.

Node org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.rootNode

private

Definition at line 122 of file DataResultViewerTable.java.

final long org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.serialVersionUID = 1L

staticprivate

Definition at line 105 of file DataResultViewerTable.java.

final String org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.title

private

Definition at line 116 of file DataResultViewerTable.java.

final String org.sleuthkit.autopsy.corecomponents.DataResultViewerTable.YELLOW_CIRCLE_ICON_PATH = "org/sleuthkit/autopsy/images/yellow-circle-yield.png"

staticprivate

Definition at line 110 of file DataResultViewerTable.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/corecomponents/DataResultViewerTable.java