Autopsy  4.15.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer Class Reference

Inherits org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.

Classes

class  DisplayDropDownChangeListener
 
class  ExtractAndTranslateTextTask
 
class  OCRDropdownChangeListener
 
class  SelectionChangeListener
 

Public Member Functions

TextViewer createInstance ()
 
Component getComponent ()
 
String getTitle ()
 
String getToolTip ()
 
int isPreferred (Node node)
 
boolean isSupported (Node node)
 
void resetComponent ()
 
void setNode (Node selectedNode)
 
void setNode (final Node node)
 

Private Attributes

volatile ExtractAndTranslateTextTask backgroundTask
 
final ExecutorService executorService = Executors.newSingleThreadExecutor(translationThreadFactory)
 
volatile Node node
 
final TranslationContentPanel panel = new TranslationContentPanel()
 
final ThreadFactory translationThreadFactory = new ThreadFactoryBuilder().setNameFormat("translation-content-viewer-%d").build()
 

Static Private Attributes

static final List< String > INSTALLED_LANGUAGE_PACKS = PlatformUtil.getOcrLanguagePacks()
 
static final Logger logger = Logger.getLogger(TranslatedTextViewer.class.getName())
 
static final int MAX_EXTRACT_SIZE_BYTES = 25600
 
static final boolean OCR_DISABLED = false
 
static final boolean OCR_ENABLED = true
 

Detailed Description

A TextViewer that displays machine translation of text.

Definition at line 59 of file TranslatedTextViewer.java.

Member Function Documentation

TextViewer org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.createInstance ( )

Create and return a new instance of your viewer. The reason that this is needed is because the specific viewer modules will be found via NetBeans Lookup and the type will only be TextViewer. This method is used to get an instance of your specific type.

Returns
A new instance of the viewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.

Definition at line 114 of file TranslatedTextViewer.java.

Component org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.getComponent ( )

Return the Swing Component to display. Implementations of this method that extend JPanel and do a 'return this;'. Otherwise return an internal instance of the JPanel.

Returns
the component which is displayed for this viewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.

Definition at line 119 of file TranslatedTextViewer.java.

String org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.getTitle ( )

Returns the title of this viewer to display in the tab.

Returns
the title of TextViewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.

Definition at line 103 of file TranslatedTextViewer.java.

String org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.getToolTip ( )

Returns a short description of this viewer to use as a tool tip for its tab.

Returns
the tooltip for this TextViewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.

Definition at line 109 of file TranslatedTextViewer.java.

int org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.isPreferred ( Node  node)

Checks whether the given viewer is preferred for the Node. This is a bit subjective, but the idea is that Autopsy wants to display the most relevant tab. The more generic the viewer, the lower the return value should be. This will only be called on viewers that support the given node (i.e., isSupported() has already returned true).

The following are some examples of the current levels in use. If the selected node is an artifact, the level may be determined by both the artifact and its associated file.

Level 7 - Based on the artifact, if any, in the selected node and specific to an artifact type or types. The current text viewer that can return level 7 is the Indexed Text tab when the selected node is a Keyword Search hit.

Level 6 - Based on the artifact, if any, in the selected node but not restricted to particular types.

Level 5 - Based on the file in the selected node and very specific to the file type.

Level 4 - Based on the file in the selected node but fairly general. Currently this is the level returned by the Indexed Text tab if Keyword Search has been run (unless the node is a Keyword Search hit or a Credit Card account). This is the default tab for most files.

Level 3 - Based on the artifact, if any, in the selected node where the artifact is thought to be of less interest than the associated file.

Level 1 - Very general and should always be available. The Strings tabs is this this level

Level 0 - For cases where the text viewer should never be displayed by default.

Parameters
nodeNode to check for preference
Returns
an int (0-10) higher return means the viewer has higher priority

Implements org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.

Definition at line 148 of file TranslatedTextViewer.java.

boolean org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.isSupported ( Node  node)

Checks whether the given node is supported by the viewer. This will be used to enable or disable the tab for the viewer.

Parameters
nodeNode to check for support
Returns
True if the node can be displayed / processed, else false

Implements org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.

Definition at line 134 of file TranslatedTextViewer.java.

References org.sleuthkit.autopsy.texttranslation.TextTranslationService.getInstance(), and org.sleuthkit.autopsy.texttranslation.TextTranslationService.hasProvider().

void org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.resetComponent ( )

Resets the contents of the viewer / component.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.

Definition at line 124 of file TranslatedTextViewer.java.

void org.sleuthkit.autopsy.corecomponentinterfaces.TextViewer.setNode ( Node  selectedNode)
inherited

Autopsy will call this when this panel is focused with the file that should be analyzed. When called with null, must clear all references to previous nodes.

Parameters
selectedNodethe node which is used to determine what is displayed in this viewer

Implemented in org.sleuthkit.autopsy.contentviewers.textcontentviewer.StringsTextViewer.

void org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.setNode ( final Node  node)

Definition at line 79 of file TranslatedTextViewer.java.

References org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.SelectionChangeListener.actionPerformed(), org.sleuthkit.autopsy.corecomponents.DataContentViewerUtility.getDefaultContent(), org.sleuthkit.autopsy.texttranslation.TextTranslationService.getInstance(), and org.sleuthkit.autopsy.texttranslation.TextTranslationService.getMaxTextChars().

Member Data Documentation

volatile ExtractAndTranslateTextTask org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.backgroundTask
private

Definition at line 70 of file TranslatedTextViewer.java.

final ExecutorService org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.executorService = Executors.newSingleThreadExecutor(translationThreadFactory)
private

Definition at line 73 of file TranslatedTextViewer.java.

final List<String> org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.INSTALLED_LANGUAGE_PACKS = PlatformUtil.getOcrLanguagePacks()
staticprivate

Definition at line 66 of file TranslatedTextViewer.java.

final Logger org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.logger = Logger.getLogger(TranslatedTextViewer.class.getName())
staticprivate

Definition at line 61 of file TranslatedTextViewer.java.

final int org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.MAX_EXTRACT_SIZE_BYTES = 25600
staticprivate

Definition at line 65 of file TranslatedTextViewer.java.

volatile Node org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.node
private

Definition at line 69 of file TranslatedTextViewer.java.

final boolean org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.OCR_DISABLED = false
staticprivate

Definition at line 64 of file TranslatedTextViewer.java.

final boolean org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.OCR_ENABLED = true
staticprivate

Definition at line 63 of file TranslatedTextViewer.java.

final TranslationContentPanel org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.panel = new TranslationContentPanel()
private

Definition at line 67 of file TranslatedTextViewer.java.

final ThreadFactory org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.translationThreadFactory = new ThreadFactoryBuilder().setNameFormat("translation-content-viewer-%d").build()
private

Definition at line 72 of file TranslatedTextViewer.java.

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

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