Class TranslationHandlerImpl

java.lang.Object

com.vladsch.flexmark.formatter.internal.TranslationHandlerImpl

All Implemented Interfaces:

TranslationContext, TranslationHandler

public class TranslationHandlerImpl
extends Object
implements TranslationHandler

Field Summary

Fields

Modifier and Type	Field	Description
private int	myAnchorId
(package private) final HashMap<String,String>	myAnchorTexts
(package private) final FormatterOptions	myFormatterOptions
private HtmlIdGenerator	myIdGenerator
(package private) final HtmlIdGeneratorFactory	myIdGeneratorFactory
private MergeContext	myMergeContext
private Function<String, CharSequence>	myNonTranslatingPostProcessor
private int	myNonTranslatingSpanId
(package private) final ArrayList<String>	myNonTranslatingSpans
(package private) final HashMap<String,String>	myNonTranslatingTexts
(package private) final HashMap<String,String>	myOriginalAnchors
(package private) final HashMap<String,Integer>	myOriginalRefTargets
private TranslationPlaceholderGenerator	myPlaceholderGenerator
private int	myPlaceholderId
(package private) final Pattern	myPlaceHolderMarkerPattern
private RenderPurpose	myRenderPurpose
(package private) final HashMap<String,String>	myTranslatedAnchors
(package private) final HashMap<Integer,String>	myTranslatedRefTargets
(package private) final ArrayList<String>	myTranslatedSpans
(package private) final HashMap<String,String>	myTranslatedTexts
(package private) final ArrayList<String>	myTranslatingPlaceholders
private int	myTranslatingSpanId
(package private) final ArrayList<String>	myTranslatingSpans
(package private) final HashMap<String,String>	myTranslatingTexts
(package private) final MutableDataSet	myTranslationStore
private MarkdownWriter	myWriter

Constructor Summary

Constructors

Constructor	Description
TranslationHandlerImpl(DataHolder options, HtmlIdGeneratorFactory idGeneratorFactory)

Method Summary

Modifier and Type	Method	Description
static String	addPrefixSuffix(CharSequence placeholderId, CharSequence prefix, CharSequence suffix, CharSequence suffix2)
void	beginRendering(@NotNull Document node, @NotNull NodeFormatterContext context, @NotNull MarkdownWriter appendable)
void	customPlaceholderFormat(@NotNull TranslationPlaceholderGenerator generator, @NotNull TranslatingSpanRender render)	Temporarily change the format for placeholders
HtmlIdGenerator	getIdGenerator()
MergeContext	getMergeContext()
String	getPlaceholderId(String format, int placeholderId, CharSequence prefix, CharSequence suffix, CharSequence suffix2)
@NotNull RenderPurpose	getRenderPurpose()	Get the reason this format rendering is being performed
@NotNull List<String>	getTranslatingTexts()
@NotNull MutableDataSet	getTranslationStore()	Get MutableDataHolder for storing this translation run values across render purpose phases
(package private) static boolean	isNotBlank(CharSequence csq)
boolean	isPostProcessingNonTranslating()
boolean	isTransformingText()	Returns false if special translation functions are no-ops
void	nonTranslatingSpan(@NotNull TranslatingSpanRender render)	Separate non-translation span.
void	postProcessNonTranslating(@NotNull Function<String, CharSequence> postProcessor, @NotNull Runnable scope)
<T> T	postProcessNonTranslating(@NotNull Function<String, CharSequence> postProcessor, @NotNull Supplier<T> scope)
private String	renderInSubContext(TranslatingSpanRender render, boolean copyToMain)
void	setMergeContext(@NotNull MergeContext context)
void	setRenderPurpose(@NotNull RenderPurpose renderPurpose)
void	setTranslatedTexts(@NotNull List<? extends CharSequence> translatedTexts)
@NotNull CharSequence	transformAnchorRef(@NotNull CharSequence pageRef, @NotNull CharSequence anchorRef)	During RenderPurpose.TRANSLATION_SPANS this converts anchorRef to ordinal placeholder id During RenderPurpose.TRANSLATED_SPANS this returns the ordinal placeholder During RenderPurpose.TRANSLATED this returns new anchorRef for the AnchorRefTarget original was referring to
@NotNull CharSequence	transformNonTranslating(CharSequence prefix, @NotNull CharSequence nonTranslatingText, CharSequence suffix, CharSequence suffix2)	Transform non-translating text
@NotNull CharSequence	transformTranslating(CharSequence prefix, @NotNull CharSequence translatingText, CharSequence suffix, CharSequence suffix2)	Transform translating text but which is contextually isolated from the text block in which it is located ie.
void	translatingRefTargetSpan(@Nullable Node target, @NotNull TranslatingSpanRender render)	Separate translation span which is also a ref target
void	translatingSpan(@NotNull TranslatingSpanRender render)	Separate translation span.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

myFormatterOptions

final FormatterOptions myFormatterOptions

myNonTranslatingTexts

final HashMap<String,String> myNonTranslatingTexts

myAnchorTexts

final HashMap<String,String> myAnchorTexts

myTranslatingTexts

final HashMap<String,String> myTranslatingTexts

myTranslatedTexts

final HashMap<String,String> myTranslatedTexts

myTranslatingPlaceholders

final ArrayList<String> myTranslatingPlaceholders

myTranslatingSpans

final ArrayList<String> myTranslatingSpans

myNonTranslatingSpans

final ArrayList<String> myNonTranslatingSpans

myTranslatedSpans

final ArrayList<String> myTranslatedSpans

myIdGeneratorFactory

final HtmlIdGeneratorFactory myIdGeneratorFactory

myPlaceHolderMarkerPattern

final Pattern myPlaceHolderMarkerPattern

myTranslationStore

final MutableDataSet myTranslationStore

myOriginalRefTargets

final HashMap<String,Integer> myOriginalRefTargets

myTranslatedRefTargets

final HashMap<Integer,String> myTranslatedRefTargets

myOriginalAnchors

final HashMap<String,String> myOriginalAnchors

myTranslatedAnchors

final HashMap<String,String> myTranslatedAnchors

myPlaceholderId

private int myPlaceholderId

myAnchorId

private int myAnchorId

myTranslatingSpanId

private int myTranslatingSpanId

myNonTranslatingSpanId

private int myNonTranslatingSpanId

myRenderPurpose

private RenderPurpose myRenderPurpose

myWriter

private MarkdownWriter myWriter

myIdGenerator

private HtmlIdGenerator myIdGenerator

myPlaceholderGenerator

private TranslationPlaceholderGenerator myPlaceholderGenerator

myNonTranslatingPostProcessor

private Function<String, CharSequence> myNonTranslatingPostProcessor

myMergeContext

private MergeContext myMergeContext

Constructor Details

TranslationHandlerImpl

public TranslationHandlerImpl(DataHolder options,
 HtmlIdGeneratorFactory idGeneratorFactory)

Method Details

getMergeContext

public MergeContext getMergeContext()

Specified by:

getMergeContext in interface TranslationContext

setMergeContext

public void setMergeContext(@NotNull
 @NotNull MergeContext context)

Specified by:

setMergeContext in interface TranslationHandler

getTranslationStore

@NotNull
public @NotNull MutableDataSet getTranslationStore()

Description copied from interface: TranslationContext

Get MutableDataHolder for storing this translation run values across render purpose phases

Specified by:

getTranslationStore in interface TranslationContext

getIdGenerator

public HtmlIdGenerator getIdGenerator()

Specified by:

getIdGenerator in interface TranslationContext

beginRendering

public void beginRendering(@NotNull
 @NotNull Document node,
 @NotNull
 @NotNull NodeFormatterContext context,
 @NotNull
 @NotNull MarkdownWriter appendable)

Specified by:

beginRendering in interface TranslationHandler

isNotBlank

static boolean isNotBlank(CharSequence csq)

getTranslatingTexts

@NotNull
public @NotNull List<String> getTranslatingTexts()

Specified by:

getTranslatingTexts in interface TranslationHandler

setTranslatedTexts

public void setTranslatedTexts(@NotNull
 @NotNull List<? extends CharSequence> translatedTexts)

Specified by:

setTranslatedTexts in interface TranslationHandler

setRenderPurpose

public void setRenderPurpose(@NotNull
 @NotNull RenderPurpose renderPurpose)

Specified by:

setRenderPurpose in interface TranslationHandler

getRenderPurpose

@NotNull
public @NotNull RenderPurpose getRenderPurpose()

Description copied from interface: TranslationContext

Get the reason this format rendering is being performed

Specified by:

getRenderPurpose in interface TranslationContext

Returns:

RenderPurpose for current rendering

isTransformingText

public boolean isTransformingText()

Description copied from interface: TranslationContext

Returns false if special translation functions are no-ops

During RenderPurpose.TRANSLATION_SPANS this is true During RenderPurpose.TRANSLATED_SPANS this is true During RenderPurpose.TRANSLATED this is true

Specified by:

isTransformingText in interface TranslationContext

Returns:

true if need to call translation related functions

transformAnchorRef

@NotNull
public @NotNull CharSequence transformAnchorRef(@NotNull
 @NotNull CharSequence pageRef,
 @NotNull
 @NotNull CharSequence anchorRef)

Description copied from interface: TranslationContext

During RenderPurpose.TRANSLATION_SPANS this converts anchorRef to ordinal placeholder id During RenderPurpose.TRANSLATED_SPANS this returns the ordinal placeholder During RenderPurpose.TRANSLATED this returns new anchorRef for the AnchorRefTarget original was referring to

Specified by:

transformAnchorRef in interface TranslationContext

Parameters:

pageRef - url part without the anchor ref to resolve reference

anchorRef - anchor ref

Returns:

anchorRef for the phase to be used for rendering

customPlaceholderFormat

public void customPlaceholderFormat(@NotNull
 @NotNull TranslationPlaceholderGenerator generator,
 @NotNull
 @NotNull TranslatingSpanRender render)

Description copied from interface: TranslationContext

Temporarily change the format for placeholders

Specified by:

customPlaceholderFormat in interface TranslationContext

Parameters:

generator - placeholder generator

render - render which will be used with the custom generator

translatingSpan

public void translatingSpan(@NotNull
 @NotNull TranslatingSpanRender render)

Description copied from interface: TranslationContext

Separate translation span. Will generate a paragraph of text which should be translated as one piece

During RenderPurpose.TRANSLATION_SPANS this adds the generated output to translation spans During RenderPurpose.TRANSLATED_SPANS output from renderer is suppressed, instead outputs corresponding translated span During RenderPurpose.TRANSLATED calls render

Specified by:

translatingSpan in interface TranslationContext

renderInSubContext

private String renderInSubContext(TranslatingSpanRender render,
 boolean copyToMain)

translatingRefTargetSpan

public void translatingRefTargetSpan(@Nullable
 @Nullable Node target,
 @NotNull
 @NotNull TranslatingSpanRender render)

Description copied from interface: TranslationContext

Separate translation span which is also a ref target

Specified by:

translatingRefTargetSpan in interface TranslationContext

Parameters:

target - target node,

render -

nonTranslatingSpan

public void nonTranslatingSpan(@NotNull
 @NotNull TranslatingSpanRender render)

Description copied from interface: TranslationContext

Separate non-translation span. Will generate a paragraph of text which will not be translated

During RenderPurpose.TRANSLATION_SPANS this adds the generated output to translation spans During RenderPurpose.TRANSLATED_SPANS output from renderer is suppressed, instead outputs corresponding translated span During RenderPurpose.TRANSLATED calls render

Specified by:

nonTranslatingSpan in interface TranslationContext

getPlaceholderId

public String getPlaceholderId(String format,
 int placeholderId,
 CharSequence prefix,
 CharSequence suffix,
 CharSequence suffix2)

addPrefixSuffix

public static String addPrefixSuffix(CharSequence placeholderId,
 CharSequence prefix,
 CharSequence suffix,
 CharSequence suffix2)

postProcessNonTranslating

public void postProcessNonTranslating(@NotNull
 @NotNull Function<String, CharSequence> postProcessor,
 @NotNull
 @NotNull Runnable scope)

Specified by:

postProcessNonTranslating in interface TranslationContext

Parameters:

postProcessor - id post processor for TRANSLATED purpose

scope - code to which the post processor applies

postProcessNonTranslating

@NotNull
public <T> T postProcessNonTranslating(@NotNull
 @NotNull Function<String, CharSequence> postProcessor,
 @NotNull
 @NotNull Supplier<T> scope)

Specified by:

postProcessNonTranslating in interface TranslationContext

Parameters:

postProcessor - id post processor for TRANSLATED purpose

scope - code to which the post processor applies

isPostProcessingNonTranslating

public boolean isPostProcessingNonTranslating()

Specified by:

isPostProcessingNonTranslating in interface TranslationContext

Returns:

true if non-translating post processor is set

transformNonTranslating

@NotNull
public @NotNull CharSequence transformNonTranslating(CharSequence prefix,
 @NotNull
 @NotNull CharSequence nonTranslatingText,
 CharSequence suffix,
 CharSequence suffix2)

Description copied from interface: TranslationContext

Transform non-translating text

During RenderPurpose.TRANSLATION_SPANS this converts text to non-translating placeholder based on ordinal id During RenderPurpose.TRANSLATED_SPANS this returns the non-translating placeholder based on ordinal id During RenderPurpose.TRANSLATED this returns the original non-translating text for the nonTranslatingText (placeholder)

Specified by:

transformNonTranslating in interface TranslationContext

Parameters:

prefix - prefix to use on non-translating placeholder so it is interpreted as a proper element during parsing

nonTranslatingText - non-rendering text of the node (content will depend on translation phase)

suffix - suffix to use on non-translating placeholder so it is interpreted as a proper element during parsing

suffix2 - suffix to use on non-translating placeholder so it is interpreted as a proper element during parsing

Returns:

text to be used in rendering for this phase

transformTranslating

@NotNull
public @NotNull CharSequence transformTranslating(CharSequence prefix,
 @NotNull
 @NotNull CharSequence translatingText,
 CharSequence suffix,
 CharSequence suffix2)

Description copied from interface: TranslationContext

Transform translating text but which is contextually isolated from the text block in which it is located ie. link reference or image reference

During RenderPurpose.TRANSLATION_SPANS this converts text to non-translating placeholder based on ordinal id and adds it to translation snippets During RenderPurpose.TRANSLATED_SPANS this returns the non-translating placeholder based on ordinal id During RenderPurpose.TRANSLATED this returns the translated text for the translatingText (placeholder)

Specified by:

transformTranslating in interface TranslationContext

Parameters:

prefix - prefix to use on non-translating placeholder so it is interpreted as a proper element during parsing

translatingText - translating but isolated text of the node (content will depend on translation phase)

suffix - suffix to use on non-translating placeholder so it is interpreted as a proper element during parsing

suffix2 - suffix to use on non-translating placeholder so it is interpreted as a proper element during parsing

Returns:

text to be used in rendering for this phase