UDF Basic Building Block

Category

Requirement

UDF coding

Test if input field existed (not null).

Normally this should be first checking for value, if null then do nothing.

Condition

Test if context values existed (not null).

Normally this should be first checking for contextValues, if empty context(null) then do nothing.

if (contextValues != null && contextValues.length > 0)

Condition

Test if has value (non-empty). Normally if false, sub-sequence coding will return result with empty string only.

if (value != null && value.trim().length() > 0)

Condition

Test if value is suppress.

if (ResultList.SUPPRESS.equalsIgnoreCase(value)))

Condition

Test if value is context change.

if (ResultList.CC.equals(value))

ResultList

Add suppress to result.

result.addSuppress();

ResultList

Add context change to result.

result.addContextChange();

ResultList

Add value to result.

result.addValue(value);

ResultList

Add boolean true/false to result. Boolean value will be used in next function call.

result.addValue(“true”);
result.addValue(“false”);

ResultList

Add empty string to result. Empty string will create target node.

result.addValue(“”);

ArrayList

Create new array list.

List array = new ArrayList();

ArrayList

Add value to array.

array.add(value);

ArrayList

Test if array contains value.

if (array.contains(value))

Looping

Pattern

for (int i = 0; i < contextValues.length; i++){

  String value = contextValues[i];

  //Do something
}

Looping

Pattern

Suggested function name:
createIf<SomeConditions>

for (int i = 0; i < contextValues.length; i++){

  String value = contextValues[i];

 
  if(<SomeConditions is true>){

      result.addValue(“”);

  }

  else{

      result.addSuppress();

  }
}

Suggested function name:

passIf<SomeConditions>

for (int i = 0; i < contextValues.length; i++){

  String value = contextValues[i];

 
  if(<SomeConditions is true>){

      result.addValue(value);

  }

  else{

      result.addSuppress();

  }
}

Return true if some condition is met, otherwise false.

Suggested function name:
has<SomeConditions>
is<SomeConditions>

for (int i = 0; i < contextValues.length; i++){

  String value = contextValues[i];

 
  if(<SomeConditions is true>){

      result.addValue(“true”);

  }

  else{

      result.addValue(“false”);

  }
}

Return single true if some condition is met for values in context, otherwise single false.

Suggested function name:

contextHas<SomeConditions>
contextIs<SomeConditions>

String conditionMet = “false”;

for (int i = 0; i < contextValues.length; i++){

  String value = contextValues[i];

 
  if(<SomeConditions is true>){

      conditionMet = “true”;

      break;

  }
}

result.addValue(conditionMet);

for (int i = 0; i < contextValues.length; i++){
  String value1 = contextValues[i];

  for (int j = 0; j < secondContext.length; j++){

      String value2 = secondContext[j];
      //Compare value1 and value2

      //Do something

  }
}

Suggested function name:

getValueByIndex
getFirstValue

getLastValue

input1 = contextValues
input2 = index(optional, starting at 1)

by index –> result.addValue(contextValues[index-1]);
first –> result.addValue(contextValues[0]);

last –> result.addValue(contextValues[contextValues.length-1]);

Split each value in contexts with context change. Simulate splitByValue(ForEach).

for (int i = 0; i < contextValues.length; i++){

  String value = contextValues[i];

  result.addValue(value);

  if(i != contextValues.length – 1){

      result.addContextChange();

  }

}

Remove all context change in contextValues. Simulate removeContext.

for (int i = 0; i < contextValues.length; i++){

  String value = contextValues[i];

  if (!ResultList.CC.equals(value)){

      result.addValue(value);

  }

}

Return only unique values, remove duplicated values.

List uniqueList = new ArrayList();

for (int i = 0; i < contextValues.length; i++){

  String value = contextValues[i];

  if (!uniqueList.contains(value)) {

      uniqueList.add(value);

      result.addValue(value);

  }
}

input1 = fullString

input2 = delimiter

String dchar = delimiter[0];

for (int i = 0; i < fullString.length; i++){

  String[] splitString = fullString[i].split(dchar);

  for (int j = 0; j < splitString.length; j++) {

      result.addValue(splitString[j]);

  }

}

Concatenate input1 context values to delimited string by delimiter specified by input2.

input1 =contextValues

input2 = delimiter

String fullString = “”;

String dchar = delimiter[0];

for (int i = 0; i < contextValues.length; i++){

  String value = contextValues[i];

  if(i == 0){

      fullString = value;

  }

  else{

      fullString = fullString + dchar + value;

  }

}

result.addValue(fullString);

for (int i = 0; i < contextValues.length; i++) {

  String value = contextValues[i];

  if (!ResultList.SUPPRESS.equalsIgnoreCase(value)){

      result.addValue(value);

  }

}

Generate single suppress. (useful for unit testing single function)

Combine 2 queues into 1 queue.

input1 = q1

input2 = q2

for (int i = 0; i < q1.length; i++) {

  result.addValue(q1[i]);

}

for (int i = 0; i < q2.length; i++) {

  result.addValue(q2[i]);

}

If input1 condition values equal to input2 single condition string, then get corresponding value from input3 context values.

input1 = conditionValues
input2 = conditionString
input3 = contextValues

String condition = conditionString[0];

for (int i = 0; i < conditionValues.length; i++){

  if(conditionValues[i].equalsIgnoreCase(condition)){

      result.addValue(contextValues[i]);

  }

  else{

      result.addSuppress();

  }

}

If input1 condition values equal to any input2 multiple condition string separated by semicolon, then get corresponding value from input3 context values.

input1 = conditionValues
input2 = conditionString
input3 = contextValues

String conditions[] = conditionString[0].split(“;”);

for (int i = 0; i < conditionValues.length; i++){

  boolean found = false;

  String value = “”;

  for(int j = 0; j < conditions.length; j++){

      if(conditionValues[i].equalsIgnoreCase(conditions[j])){

        value = contextValues[i];

        found = true;

        break;

      }

  }

  if(found){

      result.addValue(value);

  }

  else{

      result.addSuppress();

  }

}

Trim leading and trailing zero.

Using UDF:

FormatNum:

FormatNum can achieve this requirement. Below UDF remain as learning purpose only, please use standard FormatNum instead.

String output = “”;

output = value.replaceAll(“^0*”, “”);

Integer idx = value.indexOf(“.”);

if(idx != -1){

  output = output.replaceAll(“0*$”, “”).replaceAll(“\\.$”, “”);

}

if (output.trim().length() == 0) {

  output = “0”;

}

if(output.startsWith(“.”))

{

  output = “0” + output;

}

return output;

Trim leading space at left side.

String output = value.replaceAll(“^\\s*”, “”);

return output;

Trim trailing space at right side.

String output = value.replaceAll(“\\s*$”, “”);

return output;

Just use standard text trim() function.

input1 = value

input2 = totalLength

good short version:
return String.format(“%1$” + totalLength + “s”, value);

long version:

String output = value;

int toLength = Integer.parseInt(totalLength);

while (output.length() < toLength) {

            output = ” ” + output;

}

return output;

Pad trailing space up to total length.

input1 = value

input2 = totalLength

good short version:

return String.format(“%1$-” + totalLength + “s”, value);

long version:

String output = value;

int toLength = Integer.parseInt(totalLength);

while (output.length() < toLength) {

            output = output + ” “;

}

return output;