com.arcway.cockpit.docgen.provider.interfaces

Interface ITextManipulationHelper

public interface ITextManipulationHelper

The ITextManipulationHelper provides utility methods for text manipulation in document generation. The ITextManipulationHelper can be referenced directly within a document template by its name textManipulationHelper.

Method Summary

Modifier and Type	Method and Description
java.lang.String	executeReplacementInText(java.lang.String text, com.arcway.cockpit.docgen.provider.TextReplacementConfiguration textReplacementConfiguration) Replaces all occurrences of terms according to the given replacement configuration (see getTextReplacementConfiguration(Map)) in the given text.
com.arcway.cockpit.docgen.provider.TextReplacementConfiguration	getTextReplacementConfiguration(java.util.Map<java.lang.String,java.lang.String> replacements) Creates a text replacement configuration to be used with the method executeReplacementInText(String, TextReplacementConfiguration) .

Method Detail

getTextReplacementConfiguration

com.arcway.cockpit.docgen.provider.TextReplacementConfiguration getTextReplacementConfiguration(java.util.Map<java.lang.String,java.lang.String> replacements)

Creates a text replacement configuration to be used with the method executeReplacementInText(String, TextReplacementConfiguration) .

Parameters:

replacements - the replacements (term mapped to the replacement for the term; the literal {0} may be used as a placeholder for the term itself in the capitalisation found in the text to be replaced)

Returns:

the replacement configuration

executeReplacementInText

java.lang.String executeReplacementInText(java.lang.String text,
                                          com.arcway.cockpit.docgen.provider.TextReplacementConfiguration textReplacementConfiguration)

Replaces all occurrences of terms according to the given replacement configuration (see getTextReplacementConfiguration(Map)) in the given text.

Parameters:

text - the text

textReplacementConfiguration - the replacement configuration

Returns:

the replaced text