Inherits org.sleuthkit.datamodel.blackboardutils.ArtifactHelperBase.

Public Member Functions
	GeoArtifactsHelper (SleuthkitCase caseDb, String moduleName, String programName, Content srcContent, Long ingestJobId)

	GeoArtifactsHelper (SleuthkitCase caseDb, String moduleName, String programName, Content srcContent)

BlackboardArtifact	addArea (String areaName, GeoAreaPoints areaPoints, List< BlackboardAttribute > moreAttributes) throws TskCoreException, BlackboardException

BlackboardArtifact	addRoute (String routeName, Long creationTime, GeoWaypoints wayPoints, List< BlackboardAttribute > moreAttributes) throws TskCoreException, BlackboardException

BlackboardArtifact	addTrack (String trackName, GeoTrackPoints trackPoints, List< BlackboardAttribute > moreAttributes) throws TskCoreException, BlackboardException

Detailed Description

A class that helps modules to create geolocation artifacts.

Definition at line 38 of file GeoArtifactsHelper.java.

Constructor & Destructor Documentation

org.sleuthkit.datamodel.blackboardutils.GeoArtifactsHelper.GeoArtifactsHelper	(	SleuthkitCase	caseDb,
		String	moduleName,
		String	programName,
		Content	srcContent,
		Long	ingestJobId
	)

Constructs an instance of a class that helps modules to create geolocation artifacts.

Parameters

caseDb	The case database.
moduleName	The name of the module creating the artifacts.
programName	The name of the user application associated with the geolocation data to be recorded as artifacts, may be null. If a program name is supplied, it will be added to each artifact that is created as a TSK_PROG_NAME attribute.
srcContent	The source/parent content of the artifacts.
ingestJobId	The numeric identifier of the ingest job within which the artifacts are being created, may be null.

Definition at line 65 of file GeoArtifactsHelper.java.

org.sleuthkit.datamodel.blackboardutils.GeoArtifactsHelper.GeoArtifactsHelper	(	SleuthkitCase	caseDb,
		String	moduleName,
		String	programName,
		Content	srcContent
	)

Constructs an instance of a class that helps modules to create geolocation artifacts.

Parameters

caseDb	The case database.
moduleName	The name of the module creating the artifacts.
programName	The name of the user application associated with the geolocation data to be recorded as artifacts, may be null. If a program name is supplied, it will be added to each artifact that is created as a TSK_PROG_NAME attribute.
srcContent	The source/parent content of the artifacts.

Deprecated:: Use GeoArtifactsHelper(SleuthkitCase caseDb, String moduleName, String programName, Content srcContent, Long ingestJobId) instead.

Definition at line 88 of file GeoArtifactsHelper.java.

Member Function Documentation

BlackboardArtifact org.sleuthkit.datamodel.blackboardutils.GeoArtifactsHelper.addArea	(	String	areaName,
		GeoAreaPoints	areaPoints,
		List< BlackboardAttribute >	moreAttributes
	)		throws TskCoreException, BlackboardException

Adds a TSK_GPS_AREA artifact to the case database. A Global Positioning System (GPS) area artifact records an area on the map outlines by an ordered set of GPS coordinates.

Parameters

areaName	The name of the GPS area, may be null.
areaPoints	The points that make up the outline of the area. This list should be non-null and non-empty.
moreAttributes	Additional attributes for the TSK_GPS_AREA artifact, may be null.

Returns: The TSK_GPS_AREA artifact that was added to the case database.

Exceptions

TskCoreException	If there is an error creating the artifact.
BlackboardException	If there is a error posting the artifact to the blackboard.
IllegalArgumentException	If the area points provided are null or empty.

Definition at line 224 of file GeoArtifactsHelper.java.

References org.sleuthkit.datamodel.Content.newDataArtifact(), org.sleuthkit.datamodel.blackboardutils.attributes.BlackboardJsonAttrUtil.toAttribute(), org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.TSK_NAME, and org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.TSK_PROG_NAME.

BlackboardArtifact org.sleuthkit.datamodel.blackboardutils.GeoArtifactsHelper.addRoute	(	String	routeName,
		Long	creationTime,
		GeoWaypoints	wayPoints,
		List< BlackboardAttribute >	moreAttributes
	)		throws TskCoreException, BlackboardException

Adds a TSK_GPS_ROUTE artifact to the case database. A Global Positioning System (GPS) route artifact records one or more waypoints entered into a GPS-enabled device as a route to be navigated from waypoint to waypoint. A waypoint is a location in a geographic coordinate system with latitude, longitude and altitude (elevation) axes.

Parameters

routeName	The name of the GPS route, may be null.
creationTime	The time at which the route was created as milliseconds from the Java epoch of 1970-01-01T00:00:00Z, may be null.
wayPoints	The waypoints that make up the route. This list should be non-null and non-empty.
moreAttributes	Additional attributes for the TSK_GPS_ROUTE artifact, may be null.

Returns: The TSK_GPS_ROUTE artifact that was added to the case database.

Exceptions

TskCoreException	If there is an error creating the artifact.
BlackboardException	If there is a error posting the artifact to the blackboard.
IllegalArgumentException	If the waypoints provided are null or empty.

Definition at line 170 of file GeoArtifactsHelper.java.

References org.sleuthkit.datamodel.Content.newDataArtifact(), org.sleuthkit.datamodel.blackboardutils.attributes.BlackboardJsonAttrUtil.toAttribute(), org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME, org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.TSK_NAME, and org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.TSK_PROG_NAME.

BlackboardArtifact org.sleuthkit.datamodel.blackboardutils.GeoArtifactsHelper.addTrack	(	String	trackName,
		GeoTrackPoints	trackPoints,
		List< BlackboardAttribute >	moreAttributes
	)		throws TskCoreException, BlackboardException

Adds a TSK_GPS_TRACK artifact to the case database. A Global Positioning System (GPS) track artifact records the track, or path, of a GPS-enabled device as a connected series of track points. A track point is a location in a geographic coordinate system with latitude, longitude and altitude (elevation) axes.

Parameters

trackName	The name of the GPS track, may be null.
trackPoints	The track points that make up the track. This list should be non-null and non-empty.
moreAttributes	Additional attributes for the TSK_GPS_TRACK artifact, may be null.

Returns: The TSK_GPS_TRACK artifact that was added to the case database.

Exceptions

TskCoreException	If there is an error creating the artifact.
BlackboardException	If there is a error posting the artifact to the blackboard.
IllegalArgumentException	If the trackpoints provided are null or empty.

Definition at line 114 of file GeoArtifactsHelper.java.

References org.sleuthkit.datamodel.Content.newDataArtifact(), org.sleuthkit.datamodel.blackboardutils.attributes.BlackboardJsonAttrUtil.toAttribute(), org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.TSK_NAME, and org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.TSK_PROG_NAME.

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

/home/carriersleuth/repos/sleuthkit/bindings/java/src/org/sleuthkit/datamodel/blackboardutils/GeoArtifactsHelper.java

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation