Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content > Class Template Referenceabstract

Inherits org.sleuthkit.autopsy.datamodel.ContentNode.

Classes

enum  NodeSpecificEvents
 

Public Member Functions

abstract< T > T accept (ContentNodeVisitor< T > visitor)
 
abstract< T > T accept (DisplayableItemNodeVisitor< T > visitor)
 
NodeSelectionInfo getChildNodeSelectionInfo ()
 
getContent ()
 
List< Content > getContentChildren ()
 
int getContentChildrenCount ()
 
List< Long > getContentChildrenIds ()
 
abstract String getItemType ()
 
String getName ()
 
boolean hasContentChildren ()
 
boolean hasVisibleContentChildren ()
 
abstract boolean isLeafTypeNode ()
 
int read (byte[] buf, long offset, long len) throws TskException
 
void setChildNodeSelectionInfo (NodeSelectionInfo selectedChildNodeInfo)
 
void setName (String name)
 

Static Public Member Functions

static boolean contentHasVisibleContentChildren (Content c)
 

Protected Member Functions

abstract List< Tag > getAllTagsFromDatabase ()
 
DataResultViewerTable.HasCommentStatus getCommentProperty (List< Tag > tags, List< CorrelationAttributeInstance > attributes)
 
Pair< Long, String > getCountPropertyAndDescription (CorrelationAttributeInstance attribute, String defaultDescription)
 
Pair< Score, String > getScorePropertyAndDescription ()
 
synchronized final void updatePropertySheet (NodeProperty<?>...newProps)
 
synchronized void updateSheet (NodeProperty<?>...newProps)
 

Protected Attributes

final T content
 

Static Protected Attributes

static final String NO_DESCR = Bundle.AbstractContentNode_nodescription()
 
static final String VALUE_LOADING = Bundle.AbstractContentNode_valueLoading()
 

Static Private Attributes

static final Logger logger = Logger.getLogger(AbstractContentNode.class.getName())
 
static final Integer MAX_POOL_SIZE = 10
 

Detailed Description

Interface class that all Data nodes inherit from. Provides basic information such as ID, parent ID, etc.

Parameters
<T>type of wrapped Content

Definition at line 56 of file AbstractContentNode.java.

Member Function Documentation

abstract <T> T org.sleuthkit.autopsy.datamodel.ContentNode.accept ( ContentNodeVisitor< T >  visitor)
abstractinherited

Visitor pattern support.

Parameters
visitorvisitor
Returns
visitor's visit return value
abstract <T> T org.sleuthkit.autopsy.datamodel.DisplayableItemNode.accept ( DisplayableItemNodeVisitor< T >  visitor)
abstractinherited

Accepts a visitor DisplayableItemNodeVisitor that will perform an operation on this artifact type and return some object as the result of the operation.

Parameters
visitorThe visitor, where the type parameter of the visitor is the type of the object that will be returned as the result of the visit operation.
Returns
An object of type T.

Referenced by org.sleuthkit.autopsy.directorytree.DataResultFilterNode.getActions(), and org.sleuthkit.autopsy.directorytree.DataResultFilterNode.getPreferredAction().

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

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

Parameters
cThe content object to look for children on
Returns
true if has children

Definition at line 156 of file AbstractContentNode.java.

Referenced by org.sleuthkit.autopsy.datamodel.AbstractContentNode< UnsupportedContent >.hasVisibleContentChildren(), and org.sleuthkit.autopsy.directorytree.DirectoryTreeFilterChildren.IsLeafItemVisitor.visitDeep().

abstract List<Tag> org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getAllTagsFromDatabase ( )
abstractprotected

Reads and returns a list of all tags associated with this content node.

Returns
list of tags associated with the node.
NodeSelectionInfo org.sleuthkit.autopsy.datamodel.DisplayableItemNode.getChildNodeSelectionInfo ( )
inherited

Gets information about which child node of this node, if any, should be selected.

Returns
The child node selection information, or null if no child should be selected.

Definition at line 142 of file DisplayableItemNode.java.

References org.sleuthkit.autopsy.datamodel.DisplayableItemNode.selectedChildNodeInfo.

DataResultViewerTable.HasCommentStatus org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getCommentProperty ( List< Tag >  tags,
List< CorrelationAttributeInstance attributes 
)
protected

Returns comment property for the node.

Default implementation is a null implementation.

Parameters
tagsThe list of tags.
attributesThe list of correlation attribute instances.
Returns
Comment property for the underlying content of the node.

Definition at line 364 of file AbstractContentNode.java.

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

Return the content data associated with this node

Returns
the content object wrapped by this node

Definition at line 124 of file AbstractContentNode.java.

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

Return children of the underlying content.

Returns
list of content children content.

Definition at line 236 of file AbstractContentNode.java.

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

Get count of the underlying content object children.

Useful for lazy loading.

Returns
content children count

Definition at line 258 of file AbstractContentNode.java.

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

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 216 of file AbstractContentNode.java.

Pair<Long, String> org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getCountPropertyAndDescription ( CorrelationAttributeInstance  attribute,
String  defaultDescription 
)
protected

Returns occurrences/count property for the node.

Default implementation is a null implementation.

Parameters
attributeThe correlation attribute for which data will be retrieved.
defaultDescriptionA description to use when none is determined by the getCountPropertyAndDescription method.
Returns
count property for the underlying content of the node.

Definition at line 380 of file AbstractContentNode.java.

abstract String org.sleuthkit.autopsy.datamodel.DisplayableItemNode.getItemType ( )
abstractinherited

Gets the item type string of the node, suitable for use as a key.

Returns
A String representing the item type of node.
String org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getName ( )
Pair<Score, String> org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.getScorePropertyAndDescription ( )
protected

Returns Score property for the node.

Returns
Score property for the underlying content of the node.

Definition at line 341 of file AbstractContentNode.java.

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

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

Returns
true if has children

Definition at line 196 of file AbstractContentNode.java.

Referenced by org.sleuthkit.autopsy.directorytree.DirectoryTreeFilterChildren.IsLeafItemVisitor.visit(), and org.sleuthkit.autopsy.directorytree.DirectoryTreeFilterChildren.ShowItemVisitor.visit().

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

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

Returns
true if has children

Definition at line 144 of file AbstractContentNode.java.

abstract boolean org.sleuthkit.autopsy.datamodel.DisplayableItemNode.isLeafTypeNode ( )
abstractinherited

Indicates whether or not the node is capable of having child nodes. Should only return true if the node is ALWAYS a leaf node.

Returns
True or false.

Referenced by org.sleuthkit.autopsy.directorytree.DirectoryTreeFilterChildren.IsLeafItemVisitor.defaultVisit().

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

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

Parameters
bufbuffer to read into
offsetthe starting offset in the content object
lenthe length to read
Returns
the bytes read
Exceptions
TskExceptionexception thrown if the requested part of content could not be read

Definition at line 284 of file AbstractContentNode.java.

void org.sleuthkit.autopsy.datamodel.DisplayableItemNode.setChildNodeSelectionInfo ( NodeSelectionInfo  selectedChildNodeInfo)
inherited

Adds information about which child node of this node, if any, should be selected. Can be null.

Parameters
selectedChildNodeInfoThe child node selection information.

Definition at line 131 of file DisplayableItemNode.java.

References org.sleuthkit.autopsy.datamodel.DisplayableItemNode.selectedChildNodeInfo.

Referenced by org.sleuthkit.autopsy.directorytree.ViewContextAction.setNodeSelection(), org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.viewArtifact(), and org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.viewOsAccount().

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

Definition at line 129 of file AbstractContentNode.java.

synchronized final void org.sleuthkit.autopsy.datamodel.DisplayableItemNode.updatePropertySheet ( NodeProperty<?>...  newProps)
protectedinherited

Updates the node property sheet by replacing existing properties with new properties with the same property name.

Parameters
newPropsThe replacement property objects.

Definition at line 152 of file DisplayableItemNode.java.

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

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
newPropsNew file property instances to be updated in the current sheet.

Definition at line 301 of file AbstractContentNode.java.

Member Data Documentation

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

Underlying Sleuth Kit Content object

Definition at line 61 of file AbstractContentNode.java.

Referenced by org.sleuthkit.autopsy.datamodel.AbstractContentNode< UnsupportedContent >.getContent().

final Logger org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.logger = Logger.getLogger(AbstractContentNode.class.getName())
staticprivate

Definition at line 62 of file AbstractContentNode.java.

final Integer org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.MAX_POOL_SIZE = 10
staticprivate

Definition at line 69 of file AbstractContentNode.java.

final String org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.NO_DESCR = Bundle.AbstractContentNode_nodescription()
staticprotected
final String org.sleuthkit.autopsy.datamodel.AbstractContentNode< T extends Content >.VALUE_LOADING = Bundle.AbstractContentNode_valueLoading()
staticprotected

Definition at line 77 of file AbstractContentNode.java.


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

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