Inherits org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.

Classes
class	GeolocationViewModel

Public Member Functions
	GeolocationPanel ()

	GeolocationPanel (GeolocationSummary whereUsedData)

void	close ()

Protected Member Functions
void	fetchInformation (DataSource dataSource)

void	fetchInformation (List< DataFetchComponents< DataSource,?>> dataFetchComponents, DataSource dataSource)

MenuItem	getArtifactNavigateItem (BlackboardArtifact artifact)

synchronized DataSource	getDataSource ()

MenuItem	getFileNavigateItem (String path)

MenuItem	getFileNavigateItem (AbstractFile file)

void	notifyParentClose ()

void	onNewDataSource (DataSource dataSource)

void	onNewDataSource (List< DataFetchComponents< DataSource,?>> dataFetchComponents, List<?extends LoadableComponent<?>> loadableComponents, DataSource dataSource)

void	submit (List<?extends SwingWorker<?,?>> workers)

Static Protected Member Functions
static< T > ExcelSheetExport	convertToExcel (ExcelExportFunction< T > excelConverter, T data, String sheetName)

static< T > ExcelSheetExport	getExport (DataFetcher< DataSource, T > dataFetcher, ExcelExportFunction< T > excelConverter, String sheetName, DataSource ds)

static< T > T	getFetchResult (DataFetcher< DataSource, T > dataFetcher, String sheetName, DataSource ds)

static< T, CextendsExcelCellModel > ExcelSheetExport	getTableExport (List< ColumnModel< T, C >> columnsModel, String sheetName, List< T > data)

static< T, CextendsExcelCellModel > ExcelSheetExport	getTableExport (DataFetcher< DataSource, List< T >> dataFetcher, List< ColumnModel< T, C >> columnsModel, String sheetName, DataSource ds)

Private Member Functions
void	commonViewInGeolocationBtnActionPerformed (java.awt.event.ActionEvent evt)

GeolocationViewModel	convertToViewModel (CityData cityData)

void	disableNavButtons ()

List< Pair< String, Integer > >	formatList (CityCountsList countsList)

Pair< String, Integer >	formatRecord (CityRecordCount cityCount)

void	handleData (DataFetchResult< GeolocationViewModel > result)

void	initComponents ()

void	openGeolocationWindow (DataSource dataSource, Integer daysLimit)

void	recentViewInGeolocationBtnActionPerformed (java.awt.event.ActionEvent evt)

void	showCityContent (DataFetchResult< List< Pair< String, Integer >>> result, JTablePanel< Pair< String, Integer >> table, JButton goToGeolocation)

Static Private Member Functions
static String	getCityName (CityRecord record)

Private Attributes
javax.swing.JButton	commonViewInGeolocationBtn

final List< DataFetchComponents< DataSource,?> >	dataFetchComponents

final DataFetcher< DataSource, GeolocationViewModel >	geolocationFetcher

final IngestRunningLabel	ingestRunningLabel = new IngestRunningLabel()

final Logger	logger = Logger.getLogger(GeolocationPanel.class.getName())

final JTablePanel< Pair< String, Integer > >	mostCommonTable

final JTablePanel< Pair< String, Integer > >	mostRecentTable

javax.swing.JButton	recentViewInGeolocationBtn

final List< JTablePanel<?> >	tables = Arrays.asList(mostCommonTable, mostRecentTable)

final GeolocationSummary	whereUsedData

Static Private Attributes
static final ColumnModel< Pair< String, Integer >, DefaultCellModel<?> >	CITY_COL

static final ColumnModel< Pair< String, Integer >, DefaultCellModel<?> >	COUNT_COL

static final int	DAYS_COUNT = 30

static final List< ColumnModel< Pair< String, Integer >, DefaultCellModel<?> > >	DEFAULT_TEMPLATE

static final int	MAX_COUNT = 10

static final long	serialVersionUID = 1L

Detailed Description

A tab shown in data source summary displaying information about a data source's geolocation data.

Definition at line 68 of file GeolocationPanel.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.GeolocationPanel ( )

Main constructor.

Definition at line 157 of file GeolocationPanel.java.

org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.GeolocationPanel ( GeolocationSummary whereUsedData )

Main constructor.

Parameters

whereUsedData The GeolocationSummary instance to use.

Definition at line 166 of file GeolocationPanel.java.

References org.sleuthkit.autopsy.datasourcesummary.datamodel.GeolocationSummary.getCityCounts().

Member Function Documentation

void org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.close ( )

Definition at line 366 of file GeolocationPanel.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.IngestRunningLabel.unregister().

void org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.commonViewInGeolocationBtnActionPerformed ( java.awt.event.ActionEvent evt )

private

Definition at line 494 of file GeolocationPanel.java.

static <T> ExcelSheetExport org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.convertToExcel	(	ExcelExportFunction< T >	excelConverter,
		T	data,
		String	sheetName
	)

staticprotectedinherited

Helper method that converts data into an excel sheet export handling possible excel exceptions.

Parameters

excelConverter	Function to convert data to an excel sheet export.
data	The data. If data is null, null will be returned.
sheetName	The name(s) of the sheet (to be used in the error message).

Returns: The excel sheet export.

Definition at line 513 of file BaseDataSourceSummaryPanel.java.

GeolocationViewModel org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.convertToViewModel ( CityData cityData )

private

Converts CityData from GeolocationSummary into data that can be directly put into table in this panel.

Parameters

cityData The city data.

Returns: The view model data.

Definition at line 272 of file GeolocationPanel.java.

References org.sleuthkit.autopsy.datasourcesummary.datamodel.GeolocationSummary.CityData.getMostCommon(), and org.sleuthkit.autopsy.datasourcesummary.datamodel.GeolocationSummary.CityData.getMostRecent().

void org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.disableNavButtons ( )

private

Disables navigation buttons.

Definition at line 335 of file GeolocationPanel.java.

void org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.fetchInformation ( DataSource dataSource )

protected

Definition at line 341 of file GeolocationPanel.java.

void org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.fetchInformation	(	List< DataFetchComponents< DataSource,?>>	dataFetchComponents,
		DataSource	dataSource
	)

protectedinherited

Utility method to be called when solely updating information (not showing a loading screen) that creates swing workers from the data source argument and data fetch components and then submits them to run.

Parameters

dataFetchComponents	The components to be run.
dataSource	The data source argument.

Definition at line 431 of file BaseDataSourceSummaryPanel.java.

List<Pair<String, Integer> > org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.formatList ( CityCountsList countsList )

private

Formats a list of records to be displayed in a table (specifically, includes the count of points where no closest city could be determined as 'unknown').

Parameters

countsList The CityCountsList object representing the data to be displayed in the table.

Returns: The list of city/count tuples to be displayed as a row.

Definition at line 245 of file GeolocationPanel.java.

References org.sleuthkit.autopsy.datasourcesummary.datamodel.GeolocationSummary.CityCountsList.getCounts(), and org.sleuthkit.autopsy.datasourcesummary.datamodel.GeolocationSummary.CityCountsList.getOtherCount().

Pair<String, Integer> org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.formatRecord ( CityRecordCount cityCount )

private

Formats one record to be displayed as a row in the table (specifically, formats the city name).

Parameters

cityCount The CityRecordCount representing a row.

Returns: The city/count pair to be displayed as a row.

Definition at line 226 of file GeolocationPanel.java.

References org.sleuthkit.autopsy.datasourcesummary.datamodel.GeolocationSummary.CityRecordCount.getCityRecord(), and org.sleuthkit.autopsy.datasourcesummary.datamodel.GeolocationSummary.CityRecordCount.getCount().

MenuItem org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.getArtifactNavigateItem ( BlackboardArtifact artifact )

protectedinherited

Given the relevant artifact, navigates to the artifact in the tree and closes data source summary dialog if open.

Parameters

artifact The artifact.

Returns: The menu item for a go to artifact menu item.

Definition at line 260 of file BaseDataSourceSummaryPanel.java.

static String org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.getCityName ( CityRecord record )

staticprivate

Retrieves the city name to display from the record.

Parameters

record The record for the city to display.

Returns: The display name (city, country).

Definition at line 199 of file GeolocationPanel.java.

References org.sleuthkit.autopsy.datasourcesummary.datamodel.CityRecord.getCityName(), org.sleuthkit.autopsy.datasourcesummary.datamodel.CityRecord.getCountry(), and org.sleuthkit.autopsy.datasourcesummary.datamodel.CityRecord.getState().

synchronized DataSource org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.getDataSource ( )

protectedinherited

Returns: The current data source.

Definition at line 391 of file BaseDataSourceSummaryPanel.java.

static <T> ExcelSheetExport org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.getExport	(	DataFetcher< DataSource, T >	dataFetcher,
		ExcelExportFunction< T >	excelConverter,
		String	sheetName,
		DataSource	ds
	)

staticprotectedinherited

Returns an excel sheet export given the fetching of data or null if no export created.

Parameters

dataFetcher	The means of fetching data.
excelConverter	The means of converting data to excel.
sheetName	The name of the sheet (for error handling reporting).
ds	The data source to use for fetching data.

Returns: The excel sheet export or null if no export could be generated.

Definition at line 538 of file BaseDataSourceSummaryPanel.java.

static <T> T org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.getFetchResult	(	DataFetcher< DataSource, T >	dataFetcher,
		String	sheetName,
		DataSource	ds
	)

staticprotectedinherited

Runs a data fetcher and returns the result handling any possible errors with a log message.

Parameters

dataFetcher	The means of fetching the data.
sheetName	The name of the sheet.
ds	The data source.

Returns: The fetched data.

Definition at line 473 of file BaseDataSourceSummaryPanel.java.

MenuItem org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.getFileNavigateItem ( String path )

protectedinherited

Creates a menu item to navigate to a file.

Parameters

path	The path to the file.

Returns: The menu item or null if file cannot be found in data source.

Definition at line 308 of file BaseDataSourceSummaryPanel.java.

MenuItem org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.getFileNavigateItem ( AbstractFile file )

protectedinherited

Given the relevant file, navigates to the file in the tree and closes data source summary dialog if open.

Parameters

file The file.

Returns: The menu item list for a go to artifact menu item.

Definition at line 336 of file BaseDataSourceSummaryPanel.java.

static <T,CextendsExcelCellModel> ExcelSheetExport org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.getTableExport	(	List< ColumnModel< T, C >>	columnsModel,
		String	sheetName,
		List< T >	data
	)

staticprotectedinherited

Returns an excel table export of the data or null if no export created.

Parameters

columnsModel	The model for the columns.
sheetName	The name for the sheet.
data	The data to be exported.

Returns: The excel table export or null if no export could be generated.

Definition at line 554 of file BaseDataSourceSummaryPanel.java.

static <T,CextendsExcelCellModel> ExcelSheetExport org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.getTableExport	(	DataFetcher< DataSource, List< T >>	dataFetcher,
		List< ColumnModel< T, C >>	columnsModel,
		String	sheetName,
		DataSource	ds
	)

staticprotectedinherited

Returns an excel table export of the data or null if no export created.

Parameters

dataFetcher	The means of fetching data for the data source and the export.
columnsModel	The model for the columns.
sheetName	The name for the sheet.
ds	The data source.

Returns: The excel export or null if no export created.

Definition at line 572 of file BaseDataSourceSummaryPanel.java.

void org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.handleData ( DataFetchResult< GeolocationViewModel > result )

private

Means of rendering data to be shown in the tables.

Parameters

result The result of fetching data for a data source and processing into view model data.

Definition at line 188 of file GeolocationPanel.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.DataFetchResult< R >.getSubResult().

void org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.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 378 of file GeolocationPanel.java.

void org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.notifyParentClose ( )

protectedinherited

Sends event that parent should close.

Definition at line 373 of file BaseDataSourceSummaryPanel.java.

void org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.onNewDataSource ( DataSource dataSource )

protected

Definition at line 347 of file GeolocationPanel.java.

void org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.onNewDataSource	(	List< DataFetchComponents< DataSource,?>>	dataFetchComponents,
		List<?extends LoadableComponent<?>>	loadableComponents,
		DataSource	dataSource
	)

protectedinherited

Utility method that shows a loading screen with loadable components, create swing workers from the datafetch components and data source argument and submits them to be executed.

Parameters

dataFetchComponents	The components to register.
loadableComponents	The components to set to a loading screen.
dataSource	The data source argument.

Definition at line 591 of file BaseDataSourceSummaryPanel.java.

void org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.openGeolocationWindow	(	DataSource	dataSource,
		Integer	daysLimit
	)

private

Action to open the geolocation window.

Parameters

dataSource	The data source for which the window should filter.
daysLimit	The limit for how recently the waypoints should be (for most recent table) or null for most recent filter to not be set (for most common table).

Definition at line 303 of file GeolocationPanel.java.

References org.sleuthkit.autopsy.datasourcesummary.datamodel.GeolocationSummary.getGeoTypes(), org.sleuthkit.autopsy.geolocation.OpenGeolocationAction.performAction(), and org.sleuthkit.autopsy.geolocation.GeolocationTopComponent.setFilterState().

void org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.recentViewInGeolocationBtnActionPerformed ( java.awt.event.ActionEvent evt )

private

Definition at line 490 of file GeolocationPanel.java.

void org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.showCityContent	(	DataFetchResult< List< Pair< String, Integer >>>	result,
		JTablePanel< Pair< String, Integer >>	table,
		JButton	goToGeolocation
	)

private

Shows data in a particular table.

Parameters

result	The result to be displayed in the table.
table	The table where the data will be displayed.
goToGeolocation	The corresponding geolocation navigation button.

Definition at line 287 of file GeolocationPanel.java.

References org.sleuthkit.autopsy.datasourcesummary.uiutils.DataFetchResult< R >.ResultType.SUCCESS.

void org.sleuthkit.autopsy.datasourcesummary.ui.BaseDataSourceSummaryPanel.submit ( List<?extends SwingWorker<?,?>> workers )

protectedinherited

Submits the following swing workers for execution in sequential order. If there are any previous workers, those workers are cancelled.

Parameters

workers The workers to submit for execution.

Definition at line 401 of file BaseDataSourceSummaryPanel.java.

Member Data Documentation

final ColumnModel<Pair<String, Integer>, DefaultCellModel<?> > org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.CITY_COL

staticprivate

Initial value:

= new ColumnModel<>(
            Bundle.GeolocationPanel_cityColumn_title(),
            (pair) -> new DefaultCellModel<>(pair.getLeft()),
            300
    )

Definition at line 115 of file GeolocationPanel.java.

javax.swing.JButton org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.commonViewInGeolocationBtn

private

Definition at line 500 of file GeolocationPanel.java.

final ColumnModel<Pair<String, Integer>, DefaultCellModel<?> > org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.COUNT_COL

staticprivate

Initial value:

= new ColumnModel<>(
            Bundle.GeolocationPanel_countColumn_title(),
            (pair) -> new DefaultCellModel<>(pair.getRight()),
            100
    )

Definition at line 122 of file GeolocationPanel.java.

final List<DataFetchComponents<DataSource, ?> > org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.dataFetchComponents

private

Definition at line 146 of file GeolocationPanel.java.

final int org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.DAYS_COUNT = 30

staticprivate

Definition at line 111 of file GeolocationPanel.java.

final List<ColumnModel<Pair<String, Integer>, DefaultCellModel<?> > > org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.DEFAULT_TEMPLATE

staticprivate

Initial value:

= Arrays.asList(
            CITY_COL,
            COUNT_COL
    )

Definition at line 128 of file GeolocationPanel.java.

final DataFetcher<DataSource, GeolocationViewModel> org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.geolocationFetcher

private

Definition at line 152 of file GeolocationPanel.java.

final IngestRunningLabel org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.ingestRunningLabel = new IngestRunningLabel()

private

Definition at line 148 of file GeolocationPanel.java.

final Logger org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.logger = Logger.getLogger(GeolocationPanel.class.getName())

private

Definition at line 143 of file GeolocationPanel.java.

final int org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.MAX_COUNT = 10

staticprivate

Definition at line 112 of file GeolocationPanel.java.

final JTablePanel<Pair<String, Integer> > org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.mostCommonTable

private

Initial value:

= JTablePanel.getJTablePanel(DEFAULT_TEMPLATE)

.setKeyFunction((pair) -> pair.getLeft())

Definition at line 134 of file GeolocationPanel.java.

final JTablePanel<Pair<String, Integer> > org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.mostRecentTable

private

Initial value:

= JTablePanel.getJTablePanel(DEFAULT_TEMPLATE)

.setKeyFunction((pair) -> pair.getLeft())

Definition at line 137 of file GeolocationPanel.java.

javax.swing.JButton org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.recentViewInGeolocationBtn

private

Definition at line 501 of file GeolocationPanel.java.

final long org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.serialVersionUID = 1L

staticprivate

Definition at line 110 of file GeolocationPanel.java.

final List<JTablePanel<?> > org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.tables = Arrays.asList(mostCommonTable, mostRecentTable)

private

Definition at line 141 of file GeolocationPanel.java.

final GeolocationSummary org.sleuthkit.autopsy.datasourcesummary.ui.GeolocationPanel.whereUsedData

private

Definition at line 150 of file GeolocationPanel.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/datasourcesummary/ui/GeolocationPanel.java

Classes

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation