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

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

Classes
enum	AbstractFilePropertyType

Public Member Functions
Action[]	getActions (boolean context)
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)
static String	getHashSetHitsForFile (AbstractFile file)

Protected Member Functions
void	addTagProperty (Sheet.Set sheetSet)
void	finalize () throws Throwable

Private Member Functions
void	removeListeners ()
void	updateSheet ()

Static Private Member Functions
static String	getContentPath (AbstractFile file)

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 Logger	logger = Logger.getLogger(AbstractAbstractFileNode.class.getName())
static final String	NO_DESCR = AbstractAbstractFileNode_addFileProperty_desc()

Detailed Description

An abstract node that encapsulates AbstractFile data

Parameters

<T>	type of the AbstractFile to encapsulate

Definition at line 59 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)

Definition at line 284 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 111 of file AbstractContentNode.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.

Definition at line 236 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 97 of file AbstractAbstractFileNode.java.

Action [] org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.getActions

(

boolean

context

)

Definition at line 262 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 80 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 181 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 203 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 161 of file AbstractContentNode.java.

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

staticprivate

Definition at line 297 of file AbstractAbstractFileNode.java.

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

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

static

Definition at line 319 of file AbstractAbstractFileNode.java.

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

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

inherited

Definition at line 90 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 141 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 100 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 229 of file AbstractContentNode.java.

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

private

Definition at line 102 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 85 of file AbstractContentNode.java.

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

private

Definition at line 166 of file AbstractAbstractFileNode.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)

Definition at line 65 of file AbstractAbstractFileNode.java.

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

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

staticprivate

Definition at line 61 of file AbstractAbstractFileNode.java.

final String org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< T extends AbstractFile >.NO_DESCR = AbstractAbstractFileNode_addFileProperty_desc()

staticprivate

Definition at line 63 of file AbstractAbstractFileNode.java.

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

private

Definition at line 107 of file AbstractAbstractFileNode.java.

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 164 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