Document Template Classes

About Document Template Classes

Using a method defined in a Class, you can manipulate the data that a Document Template processes.

How it Works

• When a Document Template is processed, it gets its data from the TemplateContext

• The TemplateContext contains a HashMap for each record sent to the Document Template, indexed by an Object name (a string). Each HashMap contains name/value pairs for the fields in that record.

• To a Document Template, then, a data object is simply a HashMap that is present in the TemplateContext.

• That object is passed to a method you define. By manipulating the HashMaps it contains, you change the data that the Document Template processes. You can even add new "objects", by adding additional HashMaps, and new "related objects", by adding ArrayLists of HashMaps.

• HashMaps and ArrayLists can be nested as deeply as needed.

Accessing Values

• When you add a simple value to the context, the corresponding template variable is ${keyname}. So if "myParam" is the key, then $myParam inserts the corresponding value into the template.

• If you add a HashMap, $myParam.{hashMapKey} accesses the value for some key defined in the map. Ex: $myParam.quantity

• If you add an ArrayList, then $myParam[n] accesses the nth value.

• Or you can process the list in a loop like this:

<syntaxhighlight lang="java" enclose="div">

for ($loopVariable : $myParam) {

 // work with $loopVariable here

} </syntaxhighlight>

• If the ArrayList is a list of HashMaps you process the values like this:

$myParam[n].{hashMapKey}. Ex: $myParam.quantity

or this:

<syntaxhighlight lang="java" enclose="div">

for ($loopVariable : $myParam) {

 // work with $loopVariable.{hashMapKey}. Ex: $loopVariable.quantity

} </syntaxhighlight>

Coding a Method in a Document Template Class

In a Document Template, a data reference has the form $objectName.fieldname. To access, create, or modify data in your code, you will do one or more of the following operations:

• Retrieve an object's HashMap from the TemplateContext

  TemplateContext.get("objectName");

• Add or update a data HashMap

  TemplateContext.put("objectName", HashMap);

• Get a field from a data HashMap

  HashMap.get("fieldName");

  Add or update a field in a data HashMap

  HashMap.put("fieldName",value);
  where value is typically a string or a nested HashMap.

• Retrieve an ArrayList of HashMaps (one for each related-object record)

  TemplateContext.get("RelatedObjectName");

Configuring a Document Template to use a Specified Class and Method

To designate the class and method to use, when creating or editing a Document Template:

1. Under Custom Data Source, click Enabled.
2. In Select a Class, choose the class that has the method you want.
3. In Select Method choose the method that does the processing you want.

The methods available to choose are public methods that have the following signature:

<syntaxhighlight lang="java" enclose="div">

public {void} doSomething(TemplateContext context, String objName, String recordId) { } </syntaxhighlight>

where:

com.platform.api.TemplateContext

Is the container that the print template gets its data from.

String (objName)

Has the name of the object the print template was invoked on.

String (recordID)

Has the ID of the record on which it was invoked.

Considerations

• Such methods generally return void, but they don't have to. Any method that takes the appropriate arguments is available, regardless of its return value.
• A class can contain multiple processing methods, so you can do all template-related work in a single class.
• Only one method is run, however. (You select which one.)

Accessing Lookup Target Records

Data from lookup-target records is stored as a nested map. For example, to get data for the template variable $Order.customer.name:

1. HashMap orderMap = TemplateContext.get("Order")

Gets the Order HashMap from the context.

2. HashMap customerMap = orderMap.get("customer")

Gets the lookup-target record for the customer field.

3. String name = customerMap.get("name")

Gets the customer's name.

Accessing Data in Related Records

A Document Template is always invoked on a specific record. Related-object records that look up to that record are contained in an ArrayList of HashMaps, indexed by object name. The code for obtaining and processing that kind of list looks like this:

<syntaxhighlight lang="java" enclose="div">

public void chgData(TemplateContext context, String obj, String record) {

   ArrayList<HashMap<String,Object>> listOfRecords =
       (ArrayList)context.get("SomeObject");
   if (listOfRecords == null) { listOfRecords = new ArrayList(); }
   for (HashMap<String,Object> currRecord : listOfRecords )
   {

// Process the records in this for-each loop

   }		

} </syntaxhighlight>

To create an entirely new breed of related "records", create an ArrayList of the appropriate type and add it to the TemplateContext.

Examples

Changing Field Data

This example substitutes the name of the state for its abbreviation, when processing a Customer record:

<syntaxhighlight lang="java" enclose="div">

public void chgData(TemplateContext context, String obj, String record) {

   HashMap customerMap = (HashMap)context.get("Customer");
   String state = customerMap.get("state").toString();
   if ( "CA".equals(state) ) { 
       customerMap.put("state","California"); 
   }

} </syntaxhighlight>

Example: Adding a New Field

This example adds a new "Good Customer" field to the record.

<syntaxhighlight lang="java" enclose="div">

public void addData(TemplateContext context, String obj, String record) {

   HashMap customerMap = (HashMap)context.get("Customer");
   customerMap.put("rating", "Good Customer"); }

} </syntaxhighlight>

After that method has run, the Document Template can use the variable $Customer.rating, just as though that field was defined in the platform object.

Example: Adding a New Object

This code creates a new ProductSupplier "object" (as far as the Document Template is concerned), and adds it to the TenantContext (context).

<syntaxhighlight lang="java" enclose="div">

public void addObj(TemplateContext context, String obj, String record) {

   HashMap<String, Object> productSupplierMap = 
       new HashMap<String, Object>();
   productSupplierMap.put("supplierName", "Stuff R' Us");
   productSupplierMap.put("phone", "408-555-0987");
   context.put("ProductSupplier", productSupplierMap);

} </syntaxhighlight>

After that method has run, the Document Template can use the variable $ProductSupplier.phone, just as though the data had originated in the platform.