org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type Class Reference

Inherits Serializable.

Public Member Functions
	Type (int id, String displayName, String dbTableName, Boolean supported, Boolean enabled) throws EamDbException
	Type (String displayName, String dbTableName, Boolean supported, Boolean enabled) throws EamDbException
boolean	equals (Object that)
String	getDbTableName ()
String	getDisplayName ()
int	getId ()
int	hashCode ()
Boolean	isEnabled ()
Boolean	isSupported ()
void	setDbTableName (String dbTableName) throws EamDbException
void	setDisplayName (String displayName)
void	setEnabled (Boolean enabled)
void	setId (int id)
void	setSupported (Boolean supported)
String	toString ()

Private Member Functions
boolean	sameType (CorrelationAttribute.Type that)

Private Attributes
final String	DB_NAMES_REGEX = "[a-z][a-z0-9_]*"
String	dbTableName
String	displayName
Boolean	enabled
int	id
Boolean	supported

Detailed Description

Definition at line 170 of file CorrelationAttribute.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.Type	(	int	id,
		String	displayName,
		String	dbTableName,
		Boolean	supported,
		Boolean	enabled
	)		throws EamDbException

Parameters

id	Unique ID for this Correlation Type
displayName	Name of this type displayed in the UI.
dbTableName	Central repository db table where data of this type is stored. Must start with a lowercase letter and only contain lowercase letters, numbers, and '_' characters.
supported	Is this Type currently supported
enabled	Is this Type currently enabled.

Definition at line 189 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.dbTableName, org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.displayName, org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.enabled, org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.id, and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.supported.

org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.Type	(	String	displayName,
		String	dbTableName,
		Boolean	supported,
		Boolean	enabled
	)		throws EamDbException

Constructor for custom types where we do not know the Type ID until the row has been entered into the correlation_types table in the central repository.

Parameters

displayName	Name of this type displayed in the UI.
dbTableName	Central repository db table where data of this type is stored Must start with a lowercase letter and only contain lowercase letters, numbers, and '_' characters.
supported	Is this Type currently supported
enabled	Is this Type currently enabled.

Definition at line 215 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.dbTableName, org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.displayName, org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.enabled, and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.supported.

Member Function Documentation

boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.equals

(

Object

that

)

Determine if 2 Type objects are equal

Parameters

that	Type object for comparison.

Returns

true or false

Definition at line 227 of file CorrelationAttribute.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.equals().

String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.getDbTableName

(

)

To support having different database tables for each Type, this field provides the prefix/suffix of the table name, which allows us to automatically compute the table names and index names.

It is the prefix for the instances tables *_instances. (i.e. file_instances) It is the suffix for the reference tables reference_*. (i.e. reference_file)

When custom Types are added in the future, they are already supported by just giving the desired value for the table name for each custom Type. Possibly having all custom Types use a common table name.

Returns

the dbTableName

Definition at line 351 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.dbTableName.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.toString().

String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.getDisplayName

(

)

Returns

the displayName

Definition at line 325 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.displayName.

Referenced by org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelatedInstances(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCasesTableModel.mapValueById(), and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.toString().

int org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.getId

(

)

Returns

the id

Definition at line 275 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.id.

Referenced by org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.rightClickPopupMenuPopupMenuWillBecomeVisible(), and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.toString().

int org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.hashCode

(

)

Definition at line 252 of file CorrelationAttribute.java.

Boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.isEnabled

(

)

Check if this Artifact Type is enabled.

Returns

true or false

Definition at line 309 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.enabled.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.toString().

Boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.isSupported

(

)

Check if this Artifact Type is supported.

Returns

true or false

Definition at line 291 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.supported.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.toString().

boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.sameType ( CorrelationAttribute.Type  that )

private

Determines if the content of this artifact type object is equivalent to the content of another artifact type object.

Parameters

that	the other type

Returns

true if it is the same type

Definition at line 245 of file CorrelationAttribute.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.setDbTableName

(

String

dbTableName

)

throws EamDbException

To support having different database tables for each Type, this field provides the prefix/suffix of the table name, which allows us to automatically compute the table names and index names.

It is the prefix for the instances tables *_instances. (i.e. file_instances) It is the suffix for the reference tables reference_*. (i.e. reference_file)

When custom Types are added in the future, they are already supported by just giving the desired value for the table name for each custom Type. Possibly having all custom Types use a common table name. (i.e. custom_instances)

Parameters

dbTableName

the dbTableName to set. Must start with lowercase letter and can only contain lowercase letters, numbers, and '_' characters.

Exceptions

EamDbException

if dbTableName contains invalid characters

Definition at line 373 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.dbTableName.

void org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.setDisplayName

(

String

displayName

)

Parameters

displayName

the displayName to set

Definition at line 332 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.displayName.

void org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.setEnabled

(

Boolean

enabled

)

Set this Artifact Type as enabled or not enabled.

Parameters

enabled

the enabled to set

Definition at line 318 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.enabled.

void org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.setId

(

int

id

)

Parameters

id	the id to set

Definition at line 282 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.id.

void org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.setSupported

(

Boolean

supported

)

Set this Artifact Type as supported or not supported.

Parameters

supported

the supported to set

Definition at line 300 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.supported.

String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.toString

(

)

Definition at line 261 of file CorrelationAttribute.java.

References org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.getDbTableName(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.getDisplayName(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.getId(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.isEnabled(), and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.isSupported().

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.toString().

Member Data Documentation

final String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.DB_NAMES_REGEX = "[a-z][a-z0-9_]*"

private

Definition at line 177 of file CorrelationAttribute.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.dbTableName

private

Definition at line 174 of file CorrelationAttribute.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.getDbTableName(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.setDbTableName(), and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.Type().

String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.displayName

private

Definition at line 173 of file CorrelationAttribute.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.getDisplayName(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.setDisplayName(), and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.Type().

Boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.enabled

private

Definition at line 176 of file CorrelationAttribute.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.isEnabled(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.setEnabled(), and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.Type().

int org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.id

private

Definition at line 172 of file CorrelationAttribute.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.getId(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.setId(), and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.Type().

Boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.supported

private

Definition at line 175 of file CorrelationAttribute.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.isSupported(), org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.setSupported(), and org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttribute.Type.Type().

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/centralrepository/datamodel/CorrelationAttribute.java