org.sleuthkit.autopsy.discovery.search.SearchData.Frequency Enum Reference

Public Member Functions
	Frequency (int ranking, int maxOccur, String displayName)
int	getMaxOccur ()
int	getRanking ()
String	toString ()

Static Public Member Functions
static Frequency	fromCount (long count)
static List< Frequency >	getOptionsForFilteringWithCr ()
static List< Frequency >	getOptionsForFilteringWithoutCr ()

Public Attributes
	COMMON =(2, 100, Bundle.SearchData_Frequency_common_displayName())
	KNOWN =(4, 0, Bundle.SearchData_Frequency_known_displayName())
	RARE =(1, 10, Bundle.SearchData_Frequency_rare_displayName())
	UNIQUE =(0, 1, Bundle.SearchData_Frequency_unique_displayName())
	UNKNOWN =(5, 0, Bundle.SearchData_Frequency_unknown_displayName())
	VERY_COMMON =(3, 0, Bundle.SearchData_Frequency_verycommon_displayName())

Private Attributes
final String	displayName
final int	maxOccur
final int	ranking

Detailed Description

Enum representing how often the result occurs in the Central Repository.

Definition at line 142 of file SearchData.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.Frequency	(	int	ranking,
		int	maxOccur,
		String	displayName
	)

Construct a new frequency enum value.

Parameters

ranking	The rank for sorting.
maxOccur	The max occurrences this enum value is for.
displayName	The display name for this enum value.

Definition at line 161 of file SearchData.java.

Member Function Documentation

static Frequency org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.fromCount ( long  count )

static

Get the enum matching the given occurrence count.

Parameters

count

Number of times a result is in the Central Repository.

Returns

The corresponding enum.

Definition at line 183 of file SearchData.java.

Referenced by org.sleuthkit.autopsy.discovery.search.DiscoveryAttributes.DomainFrequencyCallback.process(), and org.sleuthkit.autopsy.discovery.search.DiscoveryAttributes.FrequencyCallback.process().

int org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.getMaxOccur

(

)

Get the maximum number of occurrences this enum value is for.

Returns

The maximum number of occurrences this enum value is for.

Definition at line 224 of file SearchData.java.

static List<Frequency> org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.getOptionsForFilteringWithCr ( )

static

Get the list of enums that are valid for filtering when a CR is enabled.

Returns

enums that can be used to filter with a CR.

Definition at line 200 of file SearchData.java.

static List<Frequency> org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.getOptionsForFilteringWithoutCr ( )

static

Get the list of enums that are valid for filtering when no CR is enabled.

Returns

enums that can be used to filter without a CR.

Definition at line 210 of file SearchData.java.

int org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.getRanking

(

)

Get the rank for sorting.

Returns

The rank (lower should be displayed first).

Definition at line 172 of file SearchData.java.

String org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.toString

(

)

Definition at line 215 of file SearchData.java.

Member Data Documentation

org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.COMMON =(2, 100, Bundle.SearchData_Frequency_common_displayName())

Definition at line 145 of file SearchData.java.

final String org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.displayName

private

Definition at line 151 of file SearchData.java.

org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.KNOWN =(4, 0, Bundle.SearchData_Frequency_known_displayName())

Definition at line 147 of file SearchData.java.

final int org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.maxOccur

private

Definition at line 152 of file SearchData.java.

final int org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.ranking

private

Definition at line 150 of file SearchData.java.

org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.RARE =(1, 10, Bundle.SearchData_Frequency_rare_displayName())

Definition at line 144 of file SearchData.java.

org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.UNIQUE =(0, 1, Bundle.SearchData_Frequency_unique_displayName())

Definition at line 143 of file SearchData.java.

Referenced by org.sleuthkit.autopsy.discovery.search.DiscoveryAttributes.FrequencyCallback.process().

org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.UNKNOWN =(5, 0, Bundle.SearchData_Frequency_unknown_displayName())

Definition at line 148 of file SearchData.java.

org.sleuthkit.autopsy.discovery.search.SearchData.Frequency.VERY_COMMON =(3, 0, Bundle.SearchData_Frequency_verycommon_displayName())

Definition at line 146 of file SearchData.java.

---

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

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