org.sleuthkit.autopsy.keywordsearch.Keyword Class Reference

Public Member Functions
boolean	equals (Object obj)
String	getSearchTerm ()
int	hashCode ()
boolean	searchTermIsLiteral ()
boolean	searchTermIsWholeWord ()
String	toString ()

Private Attributes
BlackboardAttribute.ATTRIBUTE_TYPE	artifactAtrributeType
boolean	isLiteral
boolean	isWholeWord
final String	listName
final String	originalTerm
String	searchTerm

Detailed Description

A representation of a keyword for which to search. The search term for the keyword may be either a literal term, to be treated as either a whole word or a substring, or a regex.

It is currently possible to optionally associate an artifact attribute type with a keyword. This feature was added to support an initial implementation of account number search and may be removed in the future.

Definition at line 34 of file Keyword.java.

Member Function Documentation

boolean org.sleuthkit.autopsy.keywordsearch.Keyword.equals

(

Object

obj

)

Definition at line 195 of file Keyword.java.

References org.sleuthkit.autopsy.keywordsearch.Keyword.getSearchTerm(), org.sleuthkit.autopsy.keywordsearch.Keyword.searchTermIsLiteral(), and org.sleuthkit.autopsy.keywordsearch.Keyword.searchTermIsWholeWord().

String org.sleuthkit.autopsy.keywordsearch.Keyword.getSearchTerm

(

)

Gets the search term for the keyword, which may be either a literal term or a regex.

Returns

The search term.

Definition at line 126 of file Keyword.java.

References org.sleuthkit.autopsy.keywordsearch.Keyword.searchTerm.

Referenced by org.sleuthkit.autopsy.keywordsearch.Keyword.equals(), and org.sleuthkit.autopsy.keywordsearch.GlobalEditListPanel.KeywordTableModel.getValueAt().

int org.sleuthkit.autopsy.keywordsearch.Keyword.hashCode

(

)

Definition at line 211 of file Keyword.java.

boolean org.sleuthkit.autopsy.keywordsearch.Keyword.searchTermIsLiteral

(

)

Indicates whether the search term for the keyword is a literal term or a regex.

Returns

True or false.

Definition at line 136 of file Keyword.java.

References org.sleuthkit.autopsy.keywordsearch.Keyword.isLiteral.

Referenced by org.sleuthkit.autopsy.keywordsearch.Keyword.equals().

boolean org.sleuthkit.autopsy.keywordsearch.Keyword.searchTermIsWholeWord

(

)

Indicates whether or not the search term for the keyword, if it is a literal term and not a regex, will be treated as a whole word or as a substring.

Returns

True or false.

Definition at line 147 of file Keyword.java.

References org.sleuthkit.autopsy.keywordsearch.Keyword.isWholeWord.

Referenced by org.sleuthkit.autopsy.keywordsearch.Keyword.equals().

String org.sleuthkit.autopsy.keywordsearch.Keyword.toString

(

)

Definition at line 190 of file Keyword.java.

Member Data Documentation

BlackboardAttribute.ATTRIBUTE_TYPE org.sleuthkit.autopsy.keywordsearch.Keyword.artifactAtrributeType

private

Definition at line 39 of file Keyword.java.

boolean org.sleuthkit.autopsy.keywordsearch.Keyword.isLiteral

private

Definition at line 37 of file Keyword.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.Keyword.searchTermIsLiteral().

boolean org.sleuthkit.autopsy.keywordsearch.Keyword.isWholeWord

private

Definition at line 38 of file Keyword.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.Keyword.searchTermIsWholeWord().

final String org.sleuthkit.autopsy.keywordsearch.Keyword.listName

private

Definition at line 40 of file Keyword.java.

final String org.sleuthkit.autopsy.keywordsearch.Keyword.originalTerm

private

Definition at line 46 of file Keyword.java.

String org.sleuthkit.autopsy.keywordsearch.Keyword.searchTerm

private

Definition at line 36 of file Keyword.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.Keyword.getSearchTerm().

---

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

• /home/carriersleuth/repos/autopsy/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/Keyword.java