de.xima.fc.placeholder

Class PlaceholderReplacer

java.lang.Object

de.xima.fc.placeholder.PlaceholderReplacer

public class PlaceholderReplacer
extends Object

Diese Klasse dient dazu Eingabetexte gegen das auftreten von Formularwerten oder WorkflowProcessingContext -Werten zu parsen und die jeweiligen Werte zu ersetzen.
Generall geben alle 'parse...'-Methoden einen Leerstring zurück, wenn der übergebene Text null ist.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMS_SPLITCHAR

Constructor Summary

Constructors

Constructor and Description
PlaceholderReplacer()

Method Summary

Modifier and Type	Method and Description
static String	cleanUp(String text)
static List<Pattern>	getPatternList()
static boolean	matchPlaceholder(String text)
static String	parse(IEntityContext ec, String text, IFormDataAdapter fda, IWorkflowProcessingContext wpc, Vorgang vorgang, Mandant mandant, boolean encodeForHTML) Diese Methode dient dazu, all verfügbaren Parser auf einen Text anzuwenden.
static String	parse(IEntityContext ec, String text, IFormDataAdapter fda, Mandant client, FormVersion formVersion, boolean encodeForHTML) This method applies all available placeholder replacers on the given text.
static String	parse(IEntityContext ec, String text, IFormDataAdapter fda, Mandant client, Vorgang formRecord, boolean encodeForHTML) This method applies all available placeholder replacers on the given text.
static String	parse(IEntityContext ec, String text, IReplacerParams parameters)
static String	parse(IEntityContext ec, String text, Vorgang formRecord, boolean encodeForHTML)
static String	parse(String text, IWorkflowProcessingContext wpc) Diese Methode dient dazu, all verfügbaren Parser auf einen Text anzuwenden.
static String	parse(String text, IWorkflowProcessingContext wpc, boolean encodeUserInput)
static String	parseForContextValues(IEntityContext ec, String text, IContextReplacerParams parameters)
static String	parseForFormValues(IEntityContext ec, String text, IFormDataAdapter formData, FormVersion formVersion, boolean encodeForHTML) Diese Methode dient dazu, Formularelementplatzhalter durch Formularwerte zu ersetzten.
static String	parseForFormValues(IEntityContext ec, String text, IFormReplacerParams parameters)
static String	parseForSessionValues(IEntityContext ec, String text, ISessionReplacerParams parameters)
static String	parseForSessionValues(IEntityContext ec, String text, Vorgang process, String contextPath, String sessionId) Diese Methode dient dazu, Systemattribute an die Stelle zu plazieren, an der entsprechende Platzhalter zu finden sind.
static String	parseForSystemAttributes(IEntityContext ec, String text, ISystemReplacerParams parameters)
static String	parseForSystemAttributes(IEntityContext ec, String text, Vorgang process, IWorkflowProcessingContext wfpctx) Diese Methode dient dazu, Systemattribute an die Stelle zu plazieren, an der entsprechende Platzhalter zu finden sind.
static String	parseForTemplates(IEntityContext ec, String text, ITemplateReplacerParams parameters)
static String	parseForTemplates(IEntityContext ec, String text, Mandant client) Diese Methode dient dazu, Textbausteinplatzhalter durch Formularwerte zu ersetzten.
static String	replaceFormValue(IEntityContext ec, String placeholder, String placeholderContent, IFormDataAdapter formData, FormVersion formVersion, boolean encodeForHTML)
static String	replaceSessionValues(IEntityContext ec, String placeholder, String placeholderContent, IContextReplacerParams parameters, String contextPath)
static String	replaceSessionValues(IEntityContext ec, String placeholder, String placeholderContent, Vorgang process, String sessionId, String contextPath)
static String	replaceSystemValue(IEntityContext ec, String placeholder, String placeholderContent, IWorkflowProcessingContext wfpctx)
static String	replaceTemplateValue(IEntityContext ec, String placeholder, String placeholderContent, Mandant client)
static void	setDefaultFormValueReplacer(IFormValueReplacer formReplacer)
static void	setDefaultSessionValueReplacer(ISessionValueReplacer sessionReplacer)
static void	setDefaultSystemValueReplcaer(ISystemValueReplacer systemReplacer)
static void	setDefaultTemplateValueReplacer(ITemplateValueReplacer templateReplacer)

Methods inherited from class java.lang.Object

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

Field Detail

PARAMS_SPLITCHAR

public static final String PARAMS_SPLITCHAR

See Also:

Constant Field Values

Constructor Detail

PlaceholderReplacer

public PlaceholderReplacer()

Method Detail

parse

public static String parse(IEntityContext ec,
                           String text,
                           IReplacerParams parameters)

parse

public static String parse(IEntityContext ec,
                           String text,
                           IFormDataAdapter fda,
                           IWorkflowProcessingContext wpc,
                           Vorgang vorgang,
                           Mandant mandant,
                           boolean encodeForHTML)

Diese Methode dient dazu, all verfügbaren Parser auf einen Text anzuwenden. Wir an entsprechender Stelle null übergeben, so kann ein Parser ausgelassen werden

Parameters:

ec - Wrapper für EntityManager (und Zusatzinformationen), um referenzierte Elemente aus dem WorkflowProcessingContext zu laden

text - Text der geparst werden soll

fda - Parsen des Texts mit Formdateninhalten (null um replaceFormValue(IEntityContext, String, String, IFormDataAdapter, FormVersion, boolean) zu überspringen)

wpc - Parsen des Texts mit WorkflowProcessingContext-Inhalten (null um parseForSystemAttributes(IEntityContext, String, Vorgang, IWorkflowProcessingContext) zu überspringen)

vorgang - Parsen des Texts mit Systemattributen (null um parseForSystemAttributes(IEntityContext, String, Vorgang, IWorkflowProcessingContext) zu überspringen)

mandant - Mandant auf dessen Textbaustein-Instanzen zugegriffen werden soll

Returns:

Zeichenkette mit den ersetzten Platzhaltern

parse

public static String parse(IEntityContext ec,
                           String text,
                           IFormDataAdapter fda,
                           Mandant client,
                           Vorgang formRecord,
                           boolean encodeForHTML)

This method applies all available placeholder replacers on the given text. Pass null for one of the arguments to skip all placeholder replaces that require this argument.

Parameters:

ec - Entity context for interacting with the database. Wrapper for an EntityManager with additional data, that is used to load the corresponding form element values for form value placeholders.

text - The text to be processed.

fda - Required for form element placeholders. Pass null to skip replaceFormValue(IEntityContext, String, String, IFormDataAdapter, FormVersion, boolean).

formRecord - Required form form value placeholders. Pass null to skip replaceFormValue(IEntityContext, String, String, IFormDataAdapter, FormVersion, boolean).

client - Client whose template resources are used. Required for template placeholders. Pass null to skip parseForTemplates(IEntityContext, String, Mandant).

Returns:

The text with all applicable placeholders replaced with their value.

parse

public static String parse(IEntityContext ec,
                           String text,
                           Vorgang formRecord,
                           boolean encodeForHTML)

parse

public static String parse(IEntityContext ec,
                           String text,
                           IFormDataAdapter fda,
                           Mandant client,
                           FormVersion formVersion,
                           boolean encodeForHTML)

This method applies all available placeholder replacers on the given text. Pass null for one of the arguments to skip all placeholder replacements that require this argument.

Parameters:

ec - Entity context for interacting with the database. Wrapper for an EntityManager with additional data, that is used to load the corresponding form element values for form value placeholders.

text - The text to be processed.

fda - Required for form element placeholders. Pass null to skip replaceFormValue(IEntityContext, String, String, IFormDataAdapter, FormVersion, boolean).

formVersion - Required form form value placeholders. Pass null to skip replaceFormValue(IEntityContext, String, String, IFormDataAdapter, FormVersion, boolean).

client - Client whose template resources are used. Required for template placeholders. Pass null to skip parseForTemplates(IEntityContext, String, Mandant).

Returns:

The text with all applicable placeholders replaced with their value.

parse

public static String parse(String text,
                           IWorkflowProcessingContext wpc)

Diese Methode dient dazu, all verfügbaren Parser auf einen Text anzuwenden.

Parameters:

text - Text der geparst werden soll

wpc - Parsen des Texts mit WorkflowProcessingContext-Inhalten

Returns:

Zeichenkette mit den ersetzten Platzhaltern

parse

public static String parse(String text,
                           IWorkflowProcessingContext wpc,
                           boolean encodeUserInput)

parseForFormValues

public static String parseForFormValues(IEntityContext ec,
                                        String text,
                                        IFormDataAdapter formData,
                                        FormVersion formVersion,
                                        boolean encodeForHTML)

Diese Methode dient dazu, Formularelementplatzhalter durch Formularwerte zu ersetzten.

Parameters:

text - - Zeichenkette in der zu ersetzende Platzhalter vorkommen

formData - - Formulardaten

formVersion - - betreffende FormVersion

Returns:

geparste Zeichenkette

parseForFormValues

public static String parseForFormValues(IEntityContext ec,
                                        String text,
                                        IFormReplacerParams parameters)

parseForSessionValues

public static String parseForSessionValues(IEntityContext ec,
                                           String text,
                                           Vorgang process,
                                           String contextPath,
                                           String sessionId)

Diese Methode dient dazu, Systemattribute an die Stelle zu plazieren, an der entsprechende Platzhalter zu finden sind. Siehe dazu CmnConst.BUILTIN_PLACEHOLDER

Parameters:

process - - Vorgang über welchen die Systemattribute ermittelt werden

text - - Zeichenkette in der zu ersetzende Platzhalter vorkommen

contextPath - the context path

Returns:

geparste Zeichenkette

parseForSessionValues

public static String parseForSessionValues(IEntityContext ec,
                                           String text,
                                           ISessionReplacerParams parameters)

parseForContextValues

public static String parseForContextValues(IEntityContext ec,
                                           String text,
                                           IContextReplacerParams parameters)

parseForSystemAttributes

public static String parseForSystemAttributes(IEntityContext ec,
                                              String text,
                                              Vorgang process,
                                              IWorkflowProcessingContext wfpctx)

Diese Methode dient dazu, Systemattribute an die Stelle zu plazieren, an der entsprechende Platzhalter zu finden sind. Siehe dazu CmnConst.BUILTIN_PLACEHOLDER

Parameters:

text - - Zeichenkette in der zu ersetzende Platzhalter vorkommen

process - - Vorgang über welchen die Systemattribute ermittelt werden

wfpctx - the workflow processing context

Returns:

geparste Zeichenkette

parseForSystemAttributes

public static String parseForSystemAttributes(IEntityContext ec,
                                              String text,
                                              ISystemReplacerParams parameters)

parseForTemplates

public static String parseForTemplates(IEntityContext ec,
                                       String text,
                                       Mandant client)

Diese Methode dient dazu, Textbausteinplatzhalter durch Formularwerte zu ersetzten.

Parameters:

text - - Zeichenkette in der zu ersetzende Platzhalter vorkommen

client - - Mandant zum herauslesen der benutzerspezifischen Textbausteine

Returns:

geparste Zeichenkette

parseForTemplates

public static String parseForTemplates(IEntityContext ec,
                                       String text,
                                       ITemplateReplacerParams parameters)

cleanUp

public static String cleanUp(String text)

Parameters:

text - Text to be cleaned from placeholders.

Returns:

The given text, cleaned such that all placeholders are removed.

replaceTemplateValue

public static String replaceTemplateValue(IEntityContext ec,
                                          String placeholder,
                                          String placeholderContent,
                                          Mandant client)

replaceSessionValues

public static String replaceSessionValues(IEntityContext ec,
                                          String placeholder,
                                          String placeholderContent,
                                          Vorgang process,
                                          String sessionId,
                                          String contextPath)

replaceSessionValues

public static String replaceSessionValues(IEntityContext ec,
                                          String placeholder,
                                          String placeholderContent,
                                          IContextReplacerParams parameters,
                                          String contextPath)

replaceSystemValue

public static String replaceSystemValue(IEntityContext ec,
                                        String placeholder,
                                        String placeholderContent,
                                        IWorkflowProcessingContext wfpctx)

replaceFormValue

public static String replaceFormValue(IEntityContext ec,
                                      String placeholder,
                                      String placeholderContent,
                                      IFormDataAdapter formData,
                                      FormVersion formVersion,
                                      boolean encodeForHTML)

setDefaultSessionValueReplacer

public static void setDefaultSessionValueReplacer(ISessionValueReplacer sessionReplacer)

Parameters:

sessionReplacer - the sessionReplacer to set

setDefaultSystemValueReplcaer

public static void setDefaultSystemValueReplcaer(ISystemValueReplacer systemReplacer)

Parameters:

systemReplacer - the systemReplcaer to set

setDefaultTemplateValueReplacer

public static void setDefaultTemplateValueReplacer(ITemplateValueReplacer templateReplacer)

Parameters:

templateReplacer - the templateReplacer to set

setDefaultFormValueReplacer

public static void setDefaultFormValueReplacer(IFormValueReplacer formReplacer)

Parameters:

formReplacer - the formReplacer to set

getPatternList

public static List<Pattern> getPatternList()

matchPlaceholder

public static boolean matchPlaceholder(String text)