org.sleuthkit.autopsy.discovery.search.Group Class Reference

Inherits Comparable< Group >.

Classes
enum	GroupSortingAlgorithm

Public Member Functions
	Group (Group.GroupSortingAlgorithm groupSortingType, DiscoveryKeyUtils.GroupKey groupKey)
int	compareTo (Group otherGroup)
String	getDisplayName ()
DiscoveryKeyUtils.GroupKey	getGroupKey ()
List< Result >	getResults ()
void	sortResults (ResultsSorter sorter)

Static Private Member Functions
static int	compareGroupsByGroupKey (Group group1, Group group2)
static int	compareGroupsBySize (Group group1, Group group2)

Private Attributes
final String	displayName
final DiscoveryKeyUtils.GroupKey	groupKey
final Group.GroupSortingAlgorithm	groupSortingType
final List< Result >	results

Detailed Description

Class for storing results that belong to a particular group.

Definition at line 29 of file Group.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.discovery.search.Group.Group	(	Group.GroupSortingAlgorithm	groupSortingType,
		DiscoveryKeyUtils.GroupKey	groupKey
	)

Create a Group object with its first result.

Parameters

groupSortingType	The method for sorting the group
groupKey	The GroupKey for this group

Definition at line 42 of file Group.java.

References org.sleuthkit.autopsy.discovery.search.Group.groupKey, and org.sleuthkit.autopsy.discovery.search.Group.groupSortingType.

Member Function Documentation

static int org.sleuthkit.autopsy.discovery.search.Group.compareGroupsByGroupKey ( Group  group1, Group  group2  )

staticprivate

Compare two groups based on the group key.

Parameters

group1	The first group to be compared.
group2	The second group to be compared.

Returns

-1 if group1 should be displayed before group2, 1 otherwise.

Definition at line 119 of file Group.java.

References org.sleuthkit.autopsy.discovery.search.Group.getGroupKey().

Referenced by org.sleuthkit.autopsy.discovery.search.Group.compareGroupsBySize(), and org.sleuthkit.autopsy.discovery.search.Group.compareTo().

static int org.sleuthkit.autopsy.discovery.search.Group.compareGroupsBySize ( Group  group1, Group  group2  )

staticprivate

Compare two groups based on the group size. Falls back on the group key if the groups are the same size.

Parameters

group1	The first group to be compared.
group2	The second group to be compared.

Returns

-1 if group1 should be displayed before group2, 1 otherwise.

Definition at line 132 of file Group.java.

References org.sleuthkit.autopsy.discovery.search.Group.compareGroupsByGroupKey(), and org.sleuthkit.autopsy.discovery.search.Group.getResults().

Referenced by org.sleuthkit.autopsy.discovery.search.Group.compareTo().

int org.sleuthkit.autopsy.discovery.search.Group.compareTo

(

Group

otherGroup

)

Compare this group to another group for sorting. Uses the algorithm specified in groupSortingType.

Parameters

otherGroup

The group to compare this one to.

Returns

-1 if this group should be displayed before the other group, 1 otherwise.

Definition at line 100 of file Group.java.

References org.sleuthkit.autopsy.discovery.search.Group.compareGroupsByGroupKey(), org.sleuthkit.autopsy.discovery.search.Group.compareGroupsBySize(), and org.sleuthkit.autopsy.discovery.search.Group.groupSortingType.

String org.sleuthkit.autopsy.discovery.search.Group.getDisplayName

(

)

Get the display name for this group.

Returns

The display name of the group.

Definition at line 70 of file Group.java.

References org.sleuthkit.autopsy.discovery.search.Group.displayName.

DiscoveryKeyUtils.GroupKey org.sleuthkit.autopsy.discovery.search.Group.getGroupKey

(

)

Get the key which uniquely identifies each group.

Returns

The unique key for the group.

Definition at line 79 of file Group.java.

References org.sleuthkit.autopsy.discovery.search.Group.groupKey.

Referenced by org.sleuthkit.autopsy.discovery.search.Group.compareGroupsByGroupKey().

List<Result> org.sleuthkit.autopsy.discovery.search.Group.getResults

(

)

Get the list of Result objects in the group.

Returns

The list of Result objects.

Definition at line 173 of file Group.java.

Referenced by org.sleuthkit.autopsy.discovery.search.Group.compareGroupsBySize().

void org.sleuthkit.autopsy.discovery.search.Group.sortResults

(

ResultsSorter

sorter

)

Sort all the results in the group

Definition at line 86 of file Group.java.

Member Data Documentation

final String org.sleuthkit.autopsy.discovery.search.Group.displayName

private

Definition at line 34 of file Group.java.

Referenced by org.sleuthkit.autopsy.discovery.search.Group.getDisplayName(), and org.sleuthkit.autopsy.discovery.search.Group.GroupSortingAlgorithm.toString().

final DiscoveryKeyUtils.GroupKey org.sleuthkit.autopsy.discovery.search.Group.groupKey

private

Definition at line 32 of file Group.java.

Referenced by org.sleuthkit.autopsy.discovery.search.Group.getGroupKey(), and org.sleuthkit.autopsy.discovery.search.Group.Group().

final Group.GroupSortingAlgorithm org.sleuthkit.autopsy.discovery.search.Group.groupSortingType

private

Definition at line 31 of file Group.java.

Referenced by org.sleuthkit.autopsy.discovery.search.Group.compareTo(), and org.sleuthkit.autopsy.discovery.search.Group.Group().

final List<Result> org.sleuthkit.autopsy.discovery.search.Group.results

private

Definition at line 33 of file Group.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/discovery/search/Group.java