org.sleuthkit.autopsy.casemodule.services.TagNameDefinition Class Reference

Inherits Comparable< TagNameDefinition >.

Public Member Functions
	TagNameDefinition (String displayName, String description, TagName.HTML_COLOR color, TskData.FileKnown status)
	TagNameDefinition (String displayName, String description, TagName.HTML_COLOR color, TskData.TagType status)
int	compareTo (TagNameDefinition other)
boolean	equals (Object obj)
TagName.HTML_COLOR	getColor ()
String	getDescription ()
String	getDisplayName ()
TskData.FileKnown	getKnownStatus ()
TskData.TagType	getTagType ()
int	hashCode ()
String	toString ()

Private Member Functions
String	toSettingsFormat ()

Static Private Member Functions
static List< String >	getCRNotableList ()
static Integer	getPropertyFileVersion ()
static boolean	needsVersionUpdate ()
static void	updatePropertyFile ()

Private Attributes
final TagName.HTML_COLOR	color
final String	description
final String	displayName
final TskData.TagType	tagType

Static Private Attributes
static final Logger	LOGGER = Logger.getLogger(TagNameDefinition.class.getName())
static final List< String >	PROJECT_VIC_NAMES_NO_LONGER_USED = new ArrayList<>()
static final List< TagNameDefinition >	STANDARD_TAGS_DEFINITIONS = new ArrayList<>()
static final String	TAG_NAMES_SETTING_KEY = "TagNames"
static final String	TAG_SETTING_VERSION_KEY = "CustomTagNameVersion"
static final int	TAG_SETTINGS_VERSION = 2
static final String	TAGS_SETTINGS_NAME = "Tags"

Detailed Description

A tag name definition consisting of a display name, description and color.

Definition at line 46 of file TagNameDefinition.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TagNameDefinition	(	String	displayName,
		String	description,
		TagName.HTML_COLOR	color,
		TskData.FileKnown	status
	)

Constructs a tag name definition consisting of a display name, description, color and tag type.

Parameters

displayName	The display name for the tag name.
description	The description for the tag name.
color	The color for the tag name.
status	The status denoted by the tag name.

Deprecated:

TagNameDefinition(String displayName, String description, TagName.HTML_COLOR color, TskData.TagType status) should be used instead.

Definition at line 91 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.color, org::sleuthkit::datamodel::TskData::TagType.convertFileKnownToTagType(), org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.description, org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.displayName, and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.tagType.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.updatePropertyFile().

org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TagNameDefinition	(	String	displayName,
		String	description,
		TagName.HTML_COLOR	color,
		TskData.TagType	status
	)

Definition at line 98 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.color, org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.description, org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.displayName, and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.tagType.

Member Function Documentation

int org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.compareTo

(

TagNameDefinition

other

)

Compares this tag name definition with the specified tag name definition for order.

Parameters

other

The tag name definition to which to compare this tag name definition.

Returns

Negative integer, zero, or a positive integer to indicate that this tag name definition is less than, equal to, or greater than the specified tag name definition.

Definition at line 205 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getDisplayName().

boolean org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.equals

(

Object

obj

)

Indicates whether some other object is "equal to" this tag name definition.

Parameters

obj	The object to test for equality.

Returns

True or false.

Definition at line 230 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getDisplayName(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getTagType().

TagName.HTML_COLOR org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getColor

(

)

Gets the color for the tag name.

Returns

The color.

Definition at line 169 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.color.

static List<String> org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getCRNotableList ( )

staticprivate

Returns a list notable tag names from the CR bagTag list.

Returns

A list of tag names, or empty list if none were found.

Definition at line 403 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getInstance(), and org.sleuthkit.autopsy.centralrepository.CentralRepoSettings.getModuleSettingsKey().

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.updatePropertyFile().

String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getDescription

(

)

Gets the description for the tag name.

Returns

The description.

Definition at line 160 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.description.

String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getDisplayName

(

)

Gets the display name for the tag name.

Returns

The display name.

Definition at line 151 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.displayName.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.compareTo(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.equals().

TskData.FileKnown org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getKnownStatus

(

)

The status which will be applied to items with this tag.

Returns

a value of TskData.FileKnown which is associated with this tag

Deprecated:

getTagType() should be used instead.

Definition at line 189 of file TagNameDefinition.java.

References org::sleuthkit::datamodel::TskData::TagType.convertTagTypeToFileKnown(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.tagType.

static Integer org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getPropertyFileVersion ( )

staticprivate

Returns the Tags property file version.

Returns

The current version of tags property file, or null if no version was found.

Definition at line 429 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TAGS_SETTINGS_NAME.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.needsVersionUpdate(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.updatePropertyFile().

TskData.TagType org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getTagType

(

)

The status which will be applied to items with this tag.

Returns

a value of TskData.TagType which is associated with this tag

Definition at line 178 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.tagType.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.equals().

int org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.hashCode

(

)

Returns a hash code value for this tag name definition.

Returns

The has code.

Definition at line 215 of file TagNameDefinition.java.

static boolean org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.needsVersionUpdate ( )

staticprivate

Based on the version in the Tags property file, returns whether or not the file needs updating.

Returns

Definition at line 418 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getPropertyFileVersion(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TAG_SETTINGS_VERSION.

String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.toSettingsFormat ( )

private

Returns

A string representation of the tag name definition in the format that is used by the tags settings file.

Definition at line 253 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.color, and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.tagType.

String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.toString

(

)

A string representation of this tag name definition.

Returns

The display name of the tag type.

Definition at line 245 of file TagNameDefinition.java.

References org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.displayName.

static void org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.updatePropertyFile ( )

staticprivate

Updates the Tag Definition file to the current format.

Definition at line 335 of file TagNameDefinition.java.

References org::sleuthkit::datamodel::TskData::TagType.BAD, org::sleuthkit::datamodel::TskData::TagType.convertFileKnownToTagType(), org.sleuthkit.autopsy.coreutils.ModuleSettings.getConfigSetting(), org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getCRNotableList(), org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getPropertyFileVersion(), org.sleuthkit.autopsy.coreutils.ModuleSettings.setConfigSetting(), org::sleuthkit::datamodel::TskData::TagType.SUSPICIOUS, org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TagNameDefinition(), org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TAGS_SETTINGS_NAME, org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.tagType, org::sleuthkit::datamodel::TskData::FileKnown.valueOf(), and org::sleuthkit::datamodel::TskData::TagType.valueOf().

Member Data Documentation

final TagName.HTML_COLOR org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.color

private

Definition at line 61 of file TagNameDefinition.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getColor(), org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TagNameDefinition(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.toSettingsFormat().

final String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.description

private

Definition at line 60 of file TagNameDefinition.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getDescription(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TagNameDefinition().

final String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.displayName

private

Definition at line 59 of file TagNameDefinition.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getDisplayName(), org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TagNameDefinition(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.toString().

final Logger org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.LOGGER = Logger.getLogger(TagNameDefinition.class.getName())

staticprivate

Definition at line 48 of file TagNameDefinition.java.

final List<String> org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.PROJECT_VIC_NAMES_NO_LONGER_USED = new ArrayList<>()

staticprivate

Definition at line 65 of file TagNameDefinition.java.

final List<TagNameDefinition> org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.STANDARD_TAGS_DEFINITIONS = new ArrayList<>()

staticprivate

Definition at line 64 of file TagNameDefinition.java.

final String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TAG_NAMES_SETTING_KEY = "TagNames"

staticprivate

Definition at line 55 of file TagNameDefinition.java.

final String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TAG_SETTING_VERSION_KEY = "CustomTagNameVersion"

staticprivate

Definition at line 56 of file TagNameDefinition.java.

final int org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TAG_SETTINGS_VERSION = 2

staticprivate

Definition at line 57 of file TagNameDefinition.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.needsVersionUpdate().

final String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TAGS_SETTINGS_NAME = "Tags"

staticprivate

Definition at line 54 of file TagNameDefinition.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getPropertyFileVersion(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.updatePropertyFile().

final TskData.TagType org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.tagType

private

Definition at line 62 of file TagNameDefinition.java.

Referenced by org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getKnownStatus(), org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getTagType(), org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TagNameDefinition(), org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.toSettingsFormat(), and org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.updatePropertyFile().

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/casemodule/services/TagNameDefinition.java