org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile > Class Template Reference

Inherits org.sleuthkit.autopsy.datamodel.AbstractContentNode< T >.

Classes
enum	AbstractFilePropertyType

Public Member Functions
T	getContent ()
List< Content >	getContentChildren ()
int	getContentChildrenCount ()
List< Long >	getContentChildrenIds ()
String	getName ()
boolean	hasContentChildren ()
boolean	hasVisibleContentChildren ()
int	read (byte[] buf, long offset, long len) throws TskException
void	setName (String name)

Static Public Member Functions
static boolean	contentHasVisibleContentChildren (Content c)
static void	fillPropertyMap (Map< String, Object > map, AbstractFile content)

Protected Member Functions
void	addTagProperty (Sheet.Set sheetSet)
synchronized Sheet	createSheet ()
void	finalize () throws Throwable
List< Tag >	getAllTagsFromDatabase ()
HasCommentStatus	getCommentProperty (List< Tag > tags, CorrelationAttributeInstance attribute)
CorrelationAttributeInstance	getCorrelationAttributeInstance ()
abstract Pair< Long, String >	getCountPropertyAndDescription (Type attributeType, String attributeValue, String defaultDescription)
Pair< Long, String >	getCountPropertyAndDescription (CorrelationAttributeInstance.Type attributeType, String attributeValue, String defaultDescription)
Pair< Score, String >	getScorePropertyAndDescription (List< Tag > tags)
synchronized void	updateSheet (NodeProperty<?>...newProps)

Static Protected Member Functions
static String	getHashSetHitsCsvList (AbstractFile file)

Protected Attributes
final T	content

Static Protected Attributes
static final String	NO_DESCR
static final String	VALUE_LOADING

Private Member Functions
List< NodeProperty<?> >	getProperties ()
void	removeListeners ()

Private Attributes
final PropertyChangeListener	pcl
final PropertyChangeListener	weakPcl = WeakListeners.propertyChange(pcl, null)

Static Private Attributes
static final Set< Case.Events >	CASE_EVENTS_OF_INTEREST
static final Set< IngestManager.IngestModuleEvent >	INGEST_MODULE_EVENTS_OF_INTEREST = EnumSet.of(CONTENT_CHANGED)
static final Logger	logger = Logger.getLogger(AbstractAbstractFileNode.class.getName())

Detailed Description

An abstract node that encapsulates AbstractFile data

Parameters

<T>	type of the AbstractFile to encapsulate

Definition at line 75 of file AbstractAbstractFileNode.java.

Member Function Documentation

void org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.addTagProperty ( Sheet.Set  sheetSet )

protected

Used by subclasses of AbstractAbstractFileNode to add the tags property to their sheets.

Parameters

sheetSet

the modifiable Sheet.Set returned by Sheet.get(Sheet.PROPERTIES)

Deprecated:

Definition at line 380 of file AbstractAbstractFileNode.java.

static boolean org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.contentHasVisibleContentChildren ( Content  c )

staticinherited

Return true if the given content object has children. Useful for lazy loading.

Parameters

c	The content object to look for children on

Returns

true if has children

Definition at line 158 of file AbstractContentNode.java.

synchronized Sheet org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.createSheet ( )

protected

Definition at line 244 of file AbstractAbstractFileNode.java.

static void org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.fillPropertyMap ( Map< String, Object >  map, AbstractFile  content  )

static

Fill map with AbstractFile properties

Parameters

map	map with preserved ordering, where property names/values are put
content	The content to get properties for.

TODO JIRA-4421: Deprecate this method and resolve warnings that appear in other locations.

Definition at line 533 of file AbstractAbstractFileNode.java.

void org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.finalize ( ) throws Throwable

protected

The finalizer removes event listeners as the BlackboardArtifactNode is being garbage collected. Yes, we know that finalizers are considered to be "bad" but since the alternative also relies on garbage collection being run and we know that finalize will be called when the object is being GC'd it seems like this is a reasonable solution.

Exceptions

Throwable

Definition at line 128 of file AbstractAbstractFileNode.java.

List<Tag> org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.getAllTagsFromDatabase ( )

protected

Definition at line 489 of file AbstractAbstractFileNode.java.

HasCommentStatus org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.getCommentProperty ( List< Tag >  tags, CorrelationAttributeInstance  attribute  )

protected

Definition at line 437 of file AbstractAbstractFileNode.java.

T org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getContent ( )

inherited

Return the content data associated with this node

Returns

the content object wrapped by this node

Definition at line 126 of file AbstractContentNode.java.

List<Content> org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getContentChildren ( )

inherited

Return children of the underlying content.

Returns

list of content children content.

Definition at line 238 of file AbstractContentNode.java.

Referenced by org.sleuthkit.autopsy.directorytree.DirectoryTreeFilterChildren.IsLeafItemVisitor::visitDeep().

int org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getContentChildrenCount ( )

inherited

Get count of the underlying content object children.

Useful for lazy loading.

Returns

content children count

Definition at line 260 of file AbstractContentNode.java.

List<Long> org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getContentChildrenIds ( )

inherited

Return ids of children of the underlying content. The ids can be treated as keys - useful for lazy loading.

Returns

list of content ids of children content.

Definition at line 218 of file AbstractContentNode.java.

CorrelationAttributeInstance org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.getCorrelationAttributeInstance ( )

protected

Definition at line 494 of file AbstractAbstractFileNode.java.

abstract Pair<Long, String> org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getCountPropertyAndDescription ( Type  attributeType, String  attributeValue, String  defaultDescription  )

abstractprotectedinherited

Returns occurrences/count property for the node.

Parameters

attributeType	the type of the attribute to count
attributeValue	the value of the attribute to count
defaultDescription	a description to use when none is determined by the getCountPropertyAndDescription method

Returns

count property for the underlying content of the node.

Pair<Long, String> org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.getCountPropertyAndDescription ( CorrelationAttributeInstance.Type  attributeType, String  attributeValue, String  defaultDescription  )

protected

Definition at line 414 of file AbstractAbstractFileNode.java.

static String org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.getHashSetHitsCsvList ( AbstractFile  file )

staticprotected

Gets a comma-separated values list of the names of the hash sets currently identified as including a given file.

Parameters

file

The file.

Returns

The CSV list of hash set names.

Deprecated:

Definition at line 399 of file AbstractAbstractFileNode.java.

String org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getName ( )

inherited

Definition at line 136 of file AbstractContentNode.java.

List<NodeProperty<?> > org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.getProperties ( )

private

Creates and populates a list of properties for this nodes property sheet.

Definition at line 328 of file AbstractAbstractFileNode.java.

Referenced by org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.createSheet().

Pair<Score, String> org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getScorePropertyAndDescription ( List< Tag >  tags )

protectedinherited

Returns Score property for the node.

Parameters

tags	list of tags.

Returns

Score property for the underlying content of the node.

Definition at line 349 of file AbstractContentNode.java.

boolean org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.hasContentChildren ( )

inherited

Return true if the underlying content object has children Useful for lazy loading.

Returns

true if has children

Definition at line 198 of file AbstractContentNode.java.

Referenced by org.sleuthkit.autopsy.directorytree.DirectoryTreeFilterChildren.IsLeafItemVisitor::visitDeep().

boolean org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.hasVisibleContentChildren ( )

inherited

Return true if the underlying content object has children Useful for lazy loading.

Returns

true if has children

Definition at line 146 of file AbstractContentNode.java.

int org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.read ( byte[]  buf, long  offset, long  len  ) throws TskException

inherited

Reads the content of this node (of the underlying content object).

Parameters

buf	buffer to read into
offset	the starting offset in the content object
len	the length to read

Returns

the bytes read

Exceptions

TskException

exception thrown if the requested part of content could not be read

Definition at line 286 of file AbstractContentNode.java.

void org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.removeListeners ( )

private

Definition at line 133 of file AbstractAbstractFileNode.java.

Referenced by org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.finalize().

void org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.setName ( String  name )

inherited

Definition at line 131 of file AbstractContentNode.java.

synchronized void org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.updateSheet ( NodeProperty<?>...  newProps )

protectedinherited

Updates the values of the properties in the current property sheet with the new properties being passed in. Only if that property exists in the current sheet will it be applied. That way, we allow for subclasses to add their own (or omit some!) properties and we will not accidentally disrupt their UI.

Race condition if not synchronized. Only one update should be applied at a time.

Parameters

newProps

New file property instances to be updated in the current sheet.

Definition at line 303 of file AbstractContentNode.java.

Member Data Documentation

final Set<Case.Events> org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.CASE_EVENTS_OF_INTEREST

staticprivate

Initial value:

= EnumSet.of(Case.Events.CURRENT_CASE,
            Case.Events.CONTENT_TAG_ADDED, Case.Events.CONTENT_TAG_DELETED, Case.Events.CR_COMMENT_CHANGED)

Definition at line 79 of file AbstractAbstractFileNode.java.

Referenced by org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.removeListeners().

final T org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.content

protectedinherited

Underlying Sleuth Kit Content object

Definition at line 63 of file AbstractContentNode.java.

Referenced by org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >::getCorrelationAttributeInstance(), and org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >::getProperties().

final Set<IngestManager.IngestModuleEvent> org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.INGEST_MODULE_EVENTS_OF_INTEREST = EnumSet.of(CONTENT_CHANGED)

staticprivate

Definition at line 81 of file AbstractAbstractFileNode.java.

final Logger org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.logger = Logger.getLogger(AbstractAbstractFileNode.class.getName())

staticprivate

Definition at line 77 of file AbstractAbstractFileNode.java.

final String org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.NO_DESCR

staticprotectedinherited

Default no description string

Definition at line 78 of file AbstractContentNode.java.

Referenced by org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >::addTagProperty(), and org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >::getProperties().

final PropertyChangeListener org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.pcl

private

Definition at line 138 of file AbstractAbstractFileNode.java.

final String org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.VALUE_LOADING

staticprotectedinherited

Definition at line 79 of file AbstractContentNode.java.

Referenced by org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >::getProperties().

final PropertyChangeListener org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.weakPcl = WeakListeners.propertyChange(pcl, null)

private

We pass a weak reference wrapper around the listener to the event publisher. This allows Netbeans to delete the node when the user navigates to another part of the tree (previously, nodes were not being deleted because the event publisher was holding onto a strong reference to the listener. We need to hold onto the weak reference here to support unregistering of the listener in removeListeners() below.

Definition at line 235 of file AbstractAbstractFileNode.java.

Referenced by org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.removeListeners().

---

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

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