com.dkfqs.tools.text

Class ReplaceVariableLiteralsInContent

java.lang.Object

com.dkfqs.tools.text.ReplaceVariableLiteralsInContent

public class ReplaceVariableLiteralsInContent
extends java.lang.Object

Replace Variable Literals (placeholders) in a content.

Programming Example:

String content = new String("The US$ ${amount} billion bilateral trade target between ${country1} and ${country2} set for this year will not be reached.");
HashMap<String, String> nameValueMap = new HashMap<String, String>();
nameValueMap.put("amount", "15");
nameValueMap.put("country1", "Cambodia");
nameValueMap.put("country2", "Thailand");

ReplaceVariableLiteralsInContent replaceVariableLiteralsInContent = new ReplaceVariableLiteralsInContent(content, nameValueMap);
boolean allOk = replaceVariableLiteralsInContent.execute();
System.out.println(replaceVariableLiteralsInContent.getResultContent()); // The US$ 15 billion bilateral trade target between Cambodia and Thailand set for this year will not be reached.

System.out.println("successfulReplaces = " + replaceVariableLiteralsInContent.getNumSuccessfulReplaces());
System.out.println("failedReplaces = " + replaceVariableLiteralsInContent.getNumFailedReplaces());
System.out.println("allOk = " + allOk);
if (!allOk) {
   for (String contentVarName : replaceVariableLiteralsInContent.getFailedReplaceVariablesList()) {
      System.out.println("- Failed to replace var " + replaceVariableLiteralsInContent.getLeftSidePattern() + contentVarName + replaceVariableLiteralsInContent.getRightSidePattern() + " in content");
   }
}

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LEFT_SIDE_PATTERN The default left side pattern of the literals.
static java.lang.String	DEFAULT_RIGHT_SIDE_PATTERN The default right side pattern of the literals.

Constructor Summary

Constructors

Constructor and Description
ReplaceVariableLiteralsInContent(java.lang.String content, java.util.Map<java.lang.String,java.lang.String> nameValueMap) Create a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	execute() Search and replace the variable literals in content.
java.util.List<java.lang.String>	getFailedReplaceVariablesList() Get a list of literal variable names whose name was not found in the name/value map.
java.lang.String	getLeftSidePattern() Get the left side pattern of the literals.
int	getNumFailedReplaces() Get the number of failed replaces.
int	getNumSuccessfulReplaces() Get the number of successful replaces.
java.lang.String	getResultContent() Get the result content.
java.lang.String	getRightSidePattern() Get the right side pattern of the literals.
java.util.List<ReplaceVariableLiteralsSuccessListEntry>	getSuccessfulReplaceList() Get a list of all successful replaced variables, inclusive the replaced value and the number of replaces.
void	setLeftSidePattern(java.lang.String leftSidePattern) Set the left side pattern of the literals.
void	setRightSidePattern(java.lang.String rightSidePattern) Set the right side pattern of the literals.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LEFT_SIDE_PATTERN

public static final java.lang.String DEFAULT_LEFT_SIDE_PATTERN

The default left side pattern of the literals.

See Also:

Constant Field Values

DEFAULT_RIGHT_SIDE_PATTERN

public static final java.lang.String DEFAULT_RIGHT_SIDE_PATTERN

The default right side pattern of the literals.

See Also:

Constant Field Values

Constructor Detail

ReplaceVariableLiteralsInContent

public ReplaceVariableLiteralsInContent(java.lang.String content,
                                        java.util.Map<java.lang.String,java.lang.String> nameValueMap)

Create a new instance.

Parameters:

content - the content in which the variable literals are replaced.

nameValueMap - a map of key = variable name, value = variable value

Throws:

java.lang.IllegalArgumentException - if the nameValueMap contains a formal invalid variable name

See Also:

Utils.isFormalValidVariableName(java.lang.String)

Method Detail

setLeftSidePattern

public void setLeftSidePattern(java.lang.String leftSidePattern)

Set the left side pattern of the literals.

Parameters:

leftSidePattern - the left side pattern of the literals.

Throws:

java.lang.IllegalArgumentException - if the left side pattern is an empty string

See Also:

DEFAULT_LEFT_SIDE_PATTERN

getLeftSidePattern

public java.lang.String getLeftSidePattern()

Get the left side pattern of the literals.

Returns:

the left side pattern of the literals

setRightSidePattern

public void setRightSidePattern(java.lang.String rightSidePattern)

Set the right side pattern of the literals.

Parameters:

rightSidePattern - the right side pattern of the literals.

Throws:

java.lang.IllegalArgumentException - if the right side pattern is an empty string

See Also:

DEFAULT_RIGHT_SIDE_PATTERN

getRightSidePattern

public java.lang.String getRightSidePattern()

Get the right side pattern of the literals.

Returns:

the right side pattern of the literals

execute

public boolean execute()

Search and replace the variable literals in content.
Note: In case if the variable name of a literal is not found in the name/value map then the corresponding part of the content remains unchanged.

Returns:

true if all variable literals have successfully replaced.

getResultContent

public java.lang.String getResultContent()

Get the result content.

Returns:

the result content

getNumSuccessfulReplaces

public int getNumSuccessfulReplaces()

Get the number of successful replaces.

Returns:

the number of successful replaces

getSuccessfulReplaceList

public java.util.List<ReplaceVariableLiteralsSuccessListEntry> getSuccessfulReplaceList()

Get a list of all successful replaced variables, inclusive the replaced value and the number of replaces.

Returns:

a list of all successful replaced variables, inclusive the replaced value and the number of replaces

getNumFailedReplaces

public int getNumFailedReplaces()

Get the number of failed replaces.

Returns:

the number of failed replaces

getFailedReplaceVariablesList

public java.util.List<java.lang.String> getFailedReplaceVariablesList()

Get a list of literal variable names whose name was not found in the name/value map.

Returns:

a list of literal variable names whose name was not found in the name/value map