Developer Guide (On-Premises)

5.14.0
- 5.9.0
- 5.8.1
- 5.8.0
- 5.16.4
- 5.16.3
- 5.16.2
- 5.16.1
- 5.16.0
- 5.15.0
- 5.13.0
- 5.12.0
- 5.11.0
- 5.10.0

Back Next

How Do I Specify Processing Parameters and Input and Result Formats?

You can specify the processing parameters and input and results formats either at the global level or at address object level. If you are using C API, you can use

AD_SetParametersXML()

AD_SetParametersXMLW()

to set parameters at the address-object level. In Java API, use the

m_oAO.setParametersXML

function, where

m_oAO

denotes the address object to which you want to apply the parameters.

The following examples shows C and Java API examples for assigning process parameters and input and results formats at address object level and global level.

Specifying Parameters at the AddressObject Level Using C API

AD_SetParametersXML(hAOHandle,
 "<?xml version='1.0' encoding='iso-8859-1' ?>\n"
 "<!DOCTYPE Parameters SYSTEM 'Parameters.dtd'>\n"
 "<Parameters>\n"
 "<Process Mode='BATCH' />\n"
 "<AddressElementStandardize>\n"
 "<Country Casing='UPPER' />\n"
 "</AddressElementStandardize>\n"
 "</Parameters>\n",
 NULL,
 NULL
);

Alternatively, you can call parameters from an external file as shown in the following example.

AD_SetParametersXML( hAOHandle,
 NULL,
 NULL,
 "Parameters.xml"
);

Specifying Parameters at the AddressObject Level Using Java API

// This code assumes that you have already acquired m_oAO as the active AddressObject
m_oAO.setParametersXML(
 "<?xml version='1.0' encoding='UTF-16LE' ?>\n" +
 "<Parameters>\n" +
 "<Process Mode='BATCH'/>\n" +
 // Java uses UTF-16LE as default encoding for its String method
 "<Input Encoding='UTF-16LE'/>" +
 "<Result Encoding='UTF-16LE'/>" +
 "<AddressElementStandardize> \n" +
 "<Country Casing='UPPER' />\n" +
 "</AddressElementStandardize> \n" +
 "</Paramaters>",
 null
);

Alternatively, you can call parameters from an external file as shown in the following example.

// This code assumes that you have already acquired m_oAO as the active AddressObject
m_oAO.setParametersXML(
null,
"Parameters.xml"
);

Instead of setting attributes for each AddressObject individually, you can specify the parameters at the global level by assigning the values to the initialization function. Assigning parameters at the global level applies global defaults to all AddressObjects that do not have individual parameters set as shown in the preceding examples. The following examples show the global level parameter settings.

Specifying Parameters at the Global Level Using C API

AD_Initialize(
 "<?xml version='1.0' encoding='iso-8859-1' ?>\n"
 "<!DOCTYPE SetConfig SYSTEM 'SetConfig.dtd'>\n"
 "<SetConfig>\n"
 "<General />\n"
 "<UnlockCode>(Enter Code here)</UnlockCode>\n" 
 "<DataBase CountryISO3='ALL' Type='BATCH_INTERACTIVE' Path='/ADDB'
 PreloadingType='NONE'/>\n"
 "</SetConfig>\n",
 NULL,
 "<?xml version='1.0' encoding='iso-8859-1' ?>\n"
 "<!DOCTYPE Parameters SYSTEM 'Parameters.dtd'>\n"
 "<Parameters>\n"
 "<Process Mode='BATCH' />\n"
 "<AddressElementStandardize>\n"
 "<Country Casing='UPPER' />\n"
 "</AddressElementStandardize>\n"
 "</Parameters>\n",
 NULL
 );

Alternatively, you can call the parameters from an external file as shown in the following example:

AD_Initialize(
 NULL,
 "SetConfig.xml",
 NULL,
 "Parameters.xml"
);

Specifying Parameters at the Global Level Using Java API

AddressDoctor.initialize(
 "<?xml version='1.0' encoding='UTF-16' ?>"+
 "<!DOCTYPE SetConfig SYSTEM 'SetConfig.dtd'>"+
 "<SetConfig><General WriteXMLEncoding='UTF-16' />"+
   " <UnlockCode>(Enter Code here)</UnlockCode>"+
   " <DataBase CountryISO3='ALL' Type='BATCH_INTERACTIVE'"+
   " Path='/ADDB' PreloadingType='NONE' />"+
 "</SetConfig>", null,
 "<?xml version='1.0' encoding='UTF-16' ?>"+
 "<!DOCTYPE SetConfig SYSTEM 'Parameters.dtd'>"+
 "<Parameters WriteXMLEncoding='UTF-16'>"+
   " <Input Encoding='UTF-16' />"+
   " <Result Encoding='UTF-16' />"+
"</Parameters>", null);

Rename Saved Search

Table of Contents

Developer Guide (On-Premises)

Developer Guide (On-Premises)

How Do I Specify Processing Parameters and Input and Result Formats?

How Do I Specify Processing Parameters and Input and Result Formats?