com.ibm.di.connector.maximo.util
Class TemplateLoader

java.lang.Object
  extended by com.ibm.di.connector.maximo.util.TemplateLoader

public final class TemplateLoader
extends Object

This class loads a text file and replaces tokens defined inside it.

Let's suppose the file /com/ibm/di/maximo/query.xml.template defines the following template:

 <?xml version='1.0' encoding='UTF-8'?>
 <Query<b>{mos.name}</b>
     xmlns="http://www.ibm.com/maximo"
     creationDateTime="<b>{creation.date.time}</b>"
     baseLanguage="EN"
     transLanguage="EN"
     messageID="<b>{message.id}</b>"
     maximoVersion="<b>{maximo.version}</b>"
     uniqueResult="false"
     maxItems="<b>{max.items}</b>"
     rsStart="<b>{rs.start}</b>">
   <<b>{mos.name}</b>Query>
       <b>{criteria}</b>
   </<b>{mos.name}</b>Query>
 </Query<b>{mos.name}</b>>
 

The code bellow can be used to load and replace the tokens:

 TemplateLoader tl = new TemplateLoader("/com/ibm/di/maximo/query.xml.template");
 tl.setProperty("mos.name", "MXASSET");
 tl.setProperty("maximo.version", "MX_VERSION");
 tl.setProperty("creation.date.time", "2007-07-25T10:00:00-03:00");
 tl.setProperty("message.id", 123);
 tl.setProperty("max.items", "10");
 tl.setProperty("rs.start", "1");
 tl.setProperty("criteria", "<ASSET><ASSETNUM operator=\"=\">5000</ASSETNUM></ASSET>");
 
 System.out.println(tl.toString());
 

The result should be something like:

 <QueryMXASSET
     xmlns="http://www.ibm.com/maximo"
     creationDateTime="2007-07-25T10:00:00-03:00"
     baseLanguage="EN"
     transLanguage="EN"
     messageID="123"
     maximoVersion="MX_VERSION"
     uniqueResult="false"
     maxItems="10"
     rsStart="1">
   <MXASSETQuery>
     <ASSET>
       <SOME CRITERIA />
     </ASSET>
   </MXASSETQuery>
 </QueryMXASSET>
 

Since:
7.1

Field Summary
static String ARG_HOLDER
           
static String CREATION_HOLDER
           
static String LANG_HOLDER
           
static String MAXITEMS_HOLDER
           
static String MBO_HOLDER
           
static String MOS_HOLDER
           
static String MSGID_HOLDER
           
static String OPER_HOLDER
           
static String RSSTART_HOLDER
           
static int TYPE_CREATE
           
static int TYPE_DELETE
           
static int TYPE_QUERY
           
static int TYPE_SYNC
           
static int TYPE_UPDATE
           
static String UNIQUERES_HOLDER
           
static String VERSION_HOLDER
           
 
Constructor Summary
TemplateLoader(int templateType, Log log)
          Constructs a TemplateLoader for the specified type.
TemplateLoader(String templateName)
          Constructs a TemplateLoader with the specified file.
 
Method Summary
 void setProperty(String token, long value)
          Defines the value associated with the given token.
 void setProperty(String token, String value)
          Defines the value associated with the given token.
 String toString()
          Returns the template content with all tokens replaced.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CREATION_HOLDER

public static final String CREATION_HOLDER
See Also:
Constant Field Values

MSGID_HOLDER

public static final String MSGID_HOLDER
See Also:
Constant Field Values

VERSION_HOLDER

public static final String VERSION_HOLDER
See Also:
Constant Field Values

LANG_HOLDER

public static final String LANG_HOLDER
See Also:
Constant Field Values

UNIQUERES_HOLDER

public static final String UNIQUERES_HOLDER
See Also:
Constant Field Values

MAXITEMS_HOLDER

public static final String MAXITEMS_HOLDER
See Also:
Constant Field Values

RSSTART_HOLDER

public static final String RSSTART_HOLDER
See Also:
Constant Field Values

OPER_HOLDER

public static final String OPER_HOLDER
See Also:
Constant Field Values

ARG_HOLDER

public static final String ARG_HOLDER
See Also:
Constant Field Values

MBO_HOLDER

public static final String MBO_HOLDER
See Also:
Constant Field Values

MOS_HOLDER

public static final String MOS_HOLDER
See Also:
Constant Field Values

TYPE_QUERY

public static final int TYPE_QUERY
See Also:
Constant Field Values

TYPE_CREATE

public static final int TYPE_CREATE
See Also:
Constant Field Values

TYPE_UPDATE

public static final int TYPE_UPDATE
See Also:
Constant Field Values

TYPE_DELETE

public static final int TYPE_DELETE
See Also:
Constant Field Values

TYPE_SYNC

public static final int TYPE_SYNC
See Also:
Constant Field Values
Constructor Detail

TemplateLoader

public TemplateLoader(String templateName)
Constructs a TemplateLoader with the specified file.

Parameters:
templateName - name of the file that contains the template definition

TemplateLoader

public TemplateLoader(int templateType,
                      Log log)
Constructs a TemplateLoader for the specified type.

Parameters:
templateType - type of XML to create
Method Detail

setProperty

public void setProperty(String token,
                        long value)
Defines the value associated with the given token.

Parameters:
token - token defined inside the template
value - value to be associated with the given token

setProperty

public void setProperty(String token,
                        String value)
Defines the value associated with the given token.

Parameters:
token - token defined inside the template
value - value to be associated with the given token

toString

public String toString()
Returns the template content with all tokens replaced.

Overrides:
toString in class Object
Returns:
template content with all tokens replaced