Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
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)
 
int compareTo (TagNameDefinition other)
 
boolean equals (Object obj)
 
TagName.HTML_COLOR getColor ()
 
String getDescription ()
 
String getDisplayName ()
 
TskData.FileKnown getKnownStatus ()
 
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.FileKnown knownStatus
 

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< TagNameDefinitionSTANDARD_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 = 1
 
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 knownStatus.

Parameters
displayNameThe display name for the tag name.
descriptionThe description for the tag name.
colorThe color for the tag name.
statusThe status denoted by the tag name.

Definition at line 89 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.knownStatus.

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

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
otherThe 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 185 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
objThe object to test for equality.
Returns
True or false.

Definition at line 210 of file TagNameDefinition.java.

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

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

Gets the color for the tag name.

Returns
The color.

Definition at line 160 of file TagNameDefinition.java.

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

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

Gets the description for the tag name.

Returns
The description.

Definition at line 151 of file TagNameDefinition.java.

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

String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getDisplayName ( )
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

Definition at line 169 of file TagNameDefinition.java.

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

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

static Integer org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.getPropertyFileVersion ( )
staticprivate
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 195 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 393 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 233 of file TagNameDefinition.java.

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

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 225 of file TagNameDefinition.java.

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

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

Member Data Documentation

final TagName.HTML_COLOR org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.color
private
final String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.description
private
final String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.displayName
private
final TskData.FileKnown org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.knownStatus
private
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 = 1
staticprivate
final String org.sleuthkit.autopsy.casemodule.services.TagNameDefinition.TAGS_SETTINGS_NAME = "Tags"
staticprivate

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

Copyright © 2012-2022 Basis Technology. Generated on: Sat Sep 24 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.