org.sleuthkit.autopsy.texttranslation.TextTranslationService Class Reference

Public Member Functions
int	getMaxPayloadSize ()
TextTranslator	getTranslatorByName (String translatorName) throws NoServiceProviderException
Collection<?extends TextTranslator >	getTranslators ()
boolean	hasProvider ()
String	translate (String input) throws NoServiceProviderException, TranslationException
void	updateSelectedTranslator ()

Static Public Member Functions
static TextTranslationService	getInstance ()

Private Member Functions
	TextTranslationService ()

Private Attributes
Optional< TextTranslator >	selectedTranslator
final Collection<?extends TextTranslator >	translators

Static Private Attributes
static final TextTranslationService	tts = new TextTranslationService()

Detailed Description

Performs a lookup for a TextTranslator service provider and if present, will use this provider to run translation on the input.

Definition at line 31 of file TextTranslationService.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.texttranslation.TextTranslationService.TextTranslationService ( )

private

Definition at line 38 of file TextTranslationService.java.

References org.sleuthkit.autopsy.texttranslation.TextTranslationService.updateSelectedTranslator().

Member Function Documentation

static TextTranslationService org.sleuthkit.autopsy.texttranslation.TextTranslationService.getInstance ( )

static

Definition at line 45 of file TextTranslationService.java.

References org.sleuthkit.autopsy.texttranslation.TextTranslationService.tts.

Referenced by org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.isSupported(), org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load(), org.sleuthkit.autopsy.texttranslation.ui.TranslationOptionsPanel.loadSelectedPanelSettings(), org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.setNode(), org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.BackgroundTranslationTask.translate(), and org.sleuthkit.autopsy.texttranslation.ui.TranslationOptionsPanel.TranslationOptionsPanel().

int org.sleuthkit.autopsy.texttranslation.TextTranslationService.getMaxPayloadSize

(

)

Returns the hard limit for translation request sizes.

Returns

Definition at line 129 of file TextTranslationService.java.

Referenced by org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.setNode().

TextTranslator org.sleuthkit.autopsy.texttranslation.TextTranslationService.getTranslatorByName

(

String

translatorName

)

throws NoServiceProviderException

Get a specific translator by name

Parameters

translatorName

the name of the translator to get

Returns

the translator which matches the name specified

Exceptions

NoServiceProviderException

Definition at line 95 of file TextTranslationService.java.

Referenced by org.sleuthkit.autopsy.texttranslation.ui.TranslationOptionsPanel.loadSelectedPanelSettings().

Collection<? extends TextTranslator> org.sleuthkit.autopsy.texttranslation.TextTranslationService.getTranslators

(

)

Get all the TextTranslator implementations which were found to exist

Returns

an unmodifiable collection of TextTranslators

Definition at line 110 of file TextTranslationService.java.

Referenced by org.sleuthkit.autopsy.texttranslation.ui.TranslationOptionsPanel.TranslationOptionsPanel().

boolean org.sleuthkit.autopsy.texttranslation.TextTranslationService.hasProvider

(

)

Returns if a TextTranslator lookup successfully found an implementing class.

Returns

Definition at line 120 of file TextTranslationService.java.

Referenced by org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.isSupported(), org.sleuthkit.autopsy.corecomponents.ViewPreferencesPanel.load(), and org.sleuthkit.autopsy.texttranslation.TextTranslationService.translate().

String org.sleuthkit.autopsy.texttranslation.TextTranslationService.translate

(

String

input

)

throws NoServiceProviderException, TranslationException

Translates the input string using whichever TextTranslator Service Provider was found during lookup.

Parameters

input

Input string to be translated

Returns

Translation string

Exceptions

NoServiceProviderException	Failed to find a Translation service provider
TranslationException	System exception for classes to use when specific translation implementations fail

Definition at line 78 of file TextTranslationService.java.

References org.sleuthkit.autopsy.texttranslation.TextTranslationService.hasProvider().

Referenced by org.sleuthkit.autopsy.texttranslation.ui.TranslatedTextViewer.BackgroundTranslationTask.translate().

void org.sleuthkit.autopsy.texttranslation.TextTranslationService.updateSelectedTranslator

(

)

Update the translator currently in use to match the one saved to the user preferences

Definition at line 53 of file TextTranslationService.java.

References org.sleuthkit.autopsy.core.UserPreferences.getTextTranslatorName().

Referenced by org.sleuthkit.autopsy.texttranslation.TextTranslationService.TextTranslationService().

Member Data Documentation

Optional<TextTranslator> org.sleuthkit.autopsy.texttranslation.TextTranslationService.selectedTranslator

private

Definition at line 36 of file TextTranslationService.java.

final Collection<? extends TextTranslator> org.sleuthkit.autopsy.texttranslation.TextTranslationService.translators

private

Definition at line 35 of file TextTranslationService.java.

final TextTranslationService org.sleuthkit.autopsy.texttranslation.TextTranslationService.tts = new TextTranslationService()

staticprivate

Definition at line 33 of file TextTranslationService.java.

Referenced by org.sleuthkit.autopsy.texttranslation.TextTranslationService.getInstance().

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/texttranslation/TextTranslationService.java