MapMarker Geocoding Cartridge for Oracle

Transcription

1 MapMarker Geocoding Cartridge for Oracle Version 4.0 USA LAYER USER GUIDE

2 Information in this document is subject to change without notice and does not represent a commitment on the part of the vendor or its representatives. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, without the written permission of MapInfo Corporation, One Global View, Troy, New York MapInfo Corporation. All rights reserved. MapInfo, the MapInfo logo and MapMarker are trademarks of MapInfo Corporation and/or its affiliates. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. The following trademarks are owned by the United States Postal Service: LACS Link and DPV. MapInfo Corporate Headquarters: Voice: (518) Fax: (518) Sales Info Hotline: (800) Government Sales Hotline: (800) Technical Support Hotline: (518) Technical Support Fax: (518) Contact information for all MapInfo offices is located at: Adobe Acrobat is a registered trademark of Adobe Systems Incorporated in the United States. Products named herein may be trademarks of their respective manufacturers and are hereby recognized. Trademarked names are used editorially, to the benefit of the trademark owner, with no intent to infringe on the trademark. May 2006

3 Table of Contents Chapter 1: MapMarker Geocoding Cartridge USA Layer Overview Installing MapMarker Geocoding Cartridge USA Running the Installer Installing the Files USA Layer Overview Introduction to the USA Objects GEOADDRESS3 Object CANDIDATE3 Object ADDRESSRANGE3 Object ADDRESSRANGEUNIT3 Object MM_PREFERENCE3 Object INPUTTABLEINFO3 Object OUTPUTTABLEINFO3 Object MM_USA Package commonaddress Object MISYS.GeoAddress3 Object MYSIS.Candidate3 Object MISYS.AddressRange3 Object MISYS.ADDRESSRANGEUNIT MISYS.MM_Preference3 Object Appendix A: MapMarker Geocoding Cartridge USA Layer Examples single_fields.sql table_fields.sql table_geoaddr.sql trigger_fields.trg create_us_addr.sql geocode_us_addr.sql Appendix B: Glossary Glossary of Address and Geocoding Terms Index

4 MapMarker Geocoding Cartridge USA Layer 1 In this chapter: Overview Installing MapMarker Geocoding Cartridge USA

5 Chapter 1: MapMarker Geocoding Cartridge USA Layer Overview The MapMarker Geocoding Cartridge USA layer extends the functionality of the MapMarker Geocoding Cartridge to U.S.street geocoding. The USA MMJ layer allows the setting of U.S.-specific preferences and the return of U.S.-specific address element fields. Preferences such as expanded radius search and use CASS mode are available. There are no U.S.-specific input address fields (though some of the standard fields have USA connotations.) Installing MapMarker Geocoding Cartridge USA The installation of MapMarker Geocoding Cartridge USA is a two step process. First run the installer on the product CD to lay down the MapMarker Geocoding Cartridge USA files (see Running the Installer below). Once the installation from the CD is complete, you must run the misys_usa.sql file to actually install the MapMarker Geocoding Cartridge USA (see Installing the Files on page 8). Note: must be completely installed prior to installing MapMarker Geocoding Cartridge USA. Running the Installer To install MapMarker Geocoding Cartridge USA: 1. Place the MapMarker Geocoding Cartridge software CD in your CD-ROM drive. 2. Run install.htm from the MapMarker Geocoding Cartridge CD. Select the installation package for your platform. The installation is copied to a temporary location on your system. Alternatively, you can bypass the browser. Go to the appropriate OS folder on the product CD under /InstData and run the install executable. The Introduction dialog displays MapInfo Corporation. All rights reserved. 5 GeocodingCartridge_USA.pdf

6 Chapter 1: MapMarker Geocoding Cartridge USA Layer 3. On the Introduction dialog, click NEXT to proceed. The Choose Install Folder dialog displays. 4. At the Choose Install Folder dialog, accept the default location to install MapMarker Geocoding Cartridge USA or browse to another location. Click NEXT. The Choose type of Installation dialog displays. 5. Select whether you are installing on an ORACLE CLIENT machine or an ORACLE SERVER and then click NEXT. Perform a Client installation if you are installing on a machine that will connect to an Oracle server elsewhere on your network. Perform a Server installation if you are installing on the Oracle server machine. If you select ORACLE SERVER, continue with step 7. The DataBase Alias Name dialog displays MapInfo Corporation. All rights reserved. 6 GeocodingCartridge_USA.pdf

7 Chapter 1: MapMarker Geocoding Cartridge USA Layer 6. Specify the database alias to which your Oracle Client connects in the DATABASE ALIAS field and then click NEXT. The MISYS Account Information dialog displays. 7. Type your MISYS password into the corresponding field and then click NEXT. The Pre-Installation Summary dialog displays MapInfo Corporation. All rights reserved. 7 GeocodingCartridge_USA.pdf

8 Chapter 1: MapMarker Geocoding Cartridge USA Layer 8. Review the information in the Pre-Installation Summary dialog, making sure all settings are correct. If you need to make any corrections, click PREVIOUS to navigate back through the installation wizard and make the necessary changes on the appropriate dialogs. If all settings are correct, click INSTALL to start the product installation. The Installing MapInfo(TM)GeocodingCartridge4.0-USA dialog displays. If you decide you do not want to install MapMarker Geocoding Cartridge USA, click CANCEL. The Install Complete dialog displays. 9. At the Install Complete dialog, click DONE to exit the software installer. Installing the Files After you run the installer, you must run the misys_usa.sql file as MISYS to finish the product installation. Note: When running this file in SQL*Plus, ensure your working directory is the same directory where the.sql file is located MapInfo Corporation. All rights reserved. 8 GeocodingCartridge_USA.pdf

9 USA Layer Packages and Object Types 2 In this chapter: USA Layer Overview Introduction to the USA Objects GEOADDRESS3 Object CANDIDATE3 Object ADDRESSRANGE3 Object ADDRESSRANGEUNIT3 Object MM_PREFERENCE3 Object INPUTTABLEINFO3 Object OUTPUTTABLEINFO3 Object

10 USA Layer Overview The MapMarker Geocoding Cartridge USA layer is made up of a jar file and a package that enable U.S.-specific field references and preference settings in some of the Geocoding Cartridge s core objects. The cartmmj_usa.jar file contains java code to translate addfields and addflags of the MM_PREFERENCE3 object to USA-specific geocode constraints settings, and to translate address elements from the java additionalfields to the addfields of CANDIDATE3, ADDRESSRANGE3 and ADDRESSRANGEUNIT3 objects. It is located in the USA\Install\sql folder of your product installation directory. The MM_USA package contains a collection of procedures and functions that allows for USA-centric reference to fields in the GEOADDRESS3, CANDIDATE3, ADDRESSRANGE3, ADDRESSRANGEUNIT3 and MM_PREFERENCE3 objects. It is located in the USA\Install\sql folder of your product installation directory. The sections that follow describe the USA Layer objects. Then the MM_USA package methods and how they act on the objects are described. Introduction to the USA Objects The objects used by the MapMarker Geocoding Cartridge USA layer are the same objects as in the core MapMarker Geocoding Cartridge product. However, the data used by the objects is specific to the United States and its territories. For example, the core product provides generic fields that will accept any 256 character string, but the USA implementation of the MapMarker Geocoding Cartridge uses these fields to store very specific types of data, such as census block, carrier route, and delivery point information. The tables presented below are the same tables found in the core documentation, but are updated to reflect the USA-specific treatment of the fields MapInfo Corporation. All rights reserved. 10 GeocodingCartridge_USA.pdf

11 GEOADDRESS3 Object The GEOADDRESS3 object type defines the attributes and functions required to geocode single addresses. It is also used for table geocoding where you wish to look at address range information or store results for more than one candidate. The address information to be geocoded is placed in the appropriate fields of the GEOADDRESS3 object, and the findlocation function geocodes the address and populates the CANDIDATESET3 with the returned candidates. The parts of the GEOADDRESS3 object are described below. Field Type Description country VARCHAR2(3) Input: the ISO standard abbreviation for the country of the input address genericfield1 VARCHAR2(256) Input: street2; secondary address information such as a Post Office box or apartment number genericfield2 VARCHAR2(256) not used for USA geocoding genericfield3 VARCHAR2(256) Input: PMB designator genericfield4 VARCHAR2(256) Input: PMB range placename VARCHAR2(256) Input: placename, usually a business name or well known landmark preaddress VARCHAR2(256) not used for USA geocoding addressnumber VARCHAR2(256) Input: address number This may be blank and the address number included in the mainaddress. predirectional VARCHAR2(256) Input: pre direction of a parsed input street prethoroughfaretype VARCHAR2(256) Input: pre type of a parsed input street mainaddress VARCHAR2(256) Input: street address postthouroughfaretype VARCHAR2(256) Input: post type of a parsed input street postdirectional VARCHAR2(256) Input: post directional of a parsed input street postaddress VARCHAR2(256) Input: the lastline; the postal code and any areanames in unparsed format postcode1 VARCHAR2(256) Input: zip code postcode2 VARCHAR2(256) Input: zip + 4 areaname1 VARCHAR2(256) Input: state areaname2 VARCHAR2(256) Input: county Note: Currently unsupported by the MapMarker Geocoding Server MapInfo Corporation. All rights reserved. 11 GeocodingCartridge_USA.pdf

12 Field Type Description areaname3 VARCHAR2(256) Input: city areaname4 VARCHAR2(256) Input: urbanization unitvalue VARCHAR2(256) Input: unit value unittype VARCHAR2(256) Input: unit type TotalCands NUMBER Output: total number of candidates found by the geocoder for the input address CloseCands NUMBER Output: number of the total candidates that the geocoder considered close matches errorcode NUMBER Output: number corresponding to a type of address related error. Does not include server, user and database errors, as these errors abort the geocoding process. errormsg VARCHAR2(256) Output: text of an address related error candidates CANDIDATESET3 Output: all of the available/requested candidates for this address after geocoding CANDIDATE3 Object The CANDIDATE3 object is used to hold the candidates returned by the cartridge when the GEOADDRESS3 is geocoded. These candidates contain address information as well as location information. The actual contents of some fields is dependent on the country and the implementation of the geocoding solution used. Field Type Description country VARCHAR2(3) the ISO standard abbreviation for the country this candidate is in genericfield1 VARCHAR2(256) street2; secondary address information such as a Post Office box or apartment number genericfield2 VARCHAR2(256) not used for USA geocoding genericfield3 VARCHAR2(256) PMB designator genericfield4 VARCHAR2(256) PMB range addfield(1) VARCHAR2(256) carrier route addfield(2) VARCHAR2(256) check digit addfield(3) VARCHAR2(256) delivery point addfield(4) VARCHAR2(256) LACS 2006 MapInfo Corporation. All rights reserved. 12 GeocodingCartridge_USA.pdf

13 Field Type Description addfield(5) VARCHAR2(256) multi-unit flag addfield(6) VARCHAR2(256) record type addfield(7) VARCHAR2(256) census block addfield(8) VARCHAR2(256) geographic rank (for geographic fallback candidates) addfield(9) VARCHAR2(256) DPV CONF addfield(10) VARCHAR2(256) DPV CMRA addfield(11) VARCHAR2(256) DPV FP addfield(12) VARCHAR2(256) DPV footnote 1 addfield(13) VARCHAR2(256) DPV footnote 2 addfield(14) VARCHAR2(256) DPV footnote 3 addfield(15) VARCHAR2(256) default flag addfield(16) VARCHAR2(256) LACSLink indicator addfield(17) VARCHAR2(256) LACSLink return code addfield(18) VARCHAR2(256) Out PMB street2 flag; if set to T (true) genericfield1 will have the street2 information placename VARCHAR2(256) the placename of a candidate address formattedstreet VARCHAR2(256) the formatted street address (not parsed into individual fields, for example: 10 Main St Apt 2 ) formattedlocation VARCHAR2(256) the last line information of the address, such as area name information and postal code. preaddress VARCHAR2(256) not used for USA geocoding addressnumber VARCHAR2(256) the address number for the candidate (some implementations may return this combined with street address information in one or more of the following fields) predirectional VARCHAR2(256) the String assigned by the country geocoder to predirectional prethoroughfaretype VARCHAR2(256) the String assigned by the country geocoder to the prethoroughfaretype mainaddress VARCHAR2(256) the String assigned by the country geocoder to the mainaddress field. In most countries candidates this will be the name of the street, for example: Main in Main Street. postthoroughfaretype VARCHAR2(256) the post type for the street address, if available postdirectional VARCHAR2(256) the post directional, if available PostAddress VARCHAR2(256) not used in USA geocoding 2006 MapInfo Corporation. All rights reserved. 13 GeocodingCartridge_USA.pdf

14 Field Type Description postcode1 VARCHAR2(256) zip code postcode2 VARCHAR2(256) zip+4. areaname1 VARCHAR2(256) state areaname2 VARCHAR2(256) county (not currently supported) areaname3 VARCHAR2(256) city areaname4 VARCHAR2(256) urbanization unitvalue VARCHAR2(256) the unit value for this candidate unittype VARCHAR2(256) the unit type for this candidate X NUMBER the longitude coordinate for the candidate Y NUMBER the latitude coordinate for the candidate SRID NUMBER the Oracle SRID, which represents the coordinate system the latitude and longitude should be interpreted in closematchflag CHAR(1) T if true (if the geocoder considered this candidate a closematch). F if false. resultcode VARCHAR2(256) the result code for the candidate. This corresponds to the type of point returned as well as which fields in the input address matches the corresponding fields in this candidate. ranges ADDRESSRANGE3SET ranges for candidate ADDRESSRANGE3 Object The ADDRESSRANGE3 lists the street house ranges for a match candidate. The parts of an ADDRESSRANGE3 object are described below: Field Type Description country VARCHAR2(3) the ISO standard abbreviation for the country this candidate is in genericfield1 VARCHAR2(256) not used for USA geocoding genericfield2 VARCHAR2(256) not used for USA geocoding genericfield3 VARCHAR2(256) not used for USA geocoding genericfield4 VARCHAR2(256) not used for USA geocoding addfield(1) VARCHAR2(256) record type 2006 MapInfo Corporation. All rights reserved. 14 GeocodingCartridge_USA.pdf

15 Field Type Description addfield(2) VARCHAR2(256) carrier route addlfield(3) VARCHAR2(256) LACS addfield(4) VARCHAR2(256) AltBase placename VARCHAR2(256) placename, usually a business name or well known landmark preaddress VARCHAR2(256) not used for USA geocoding addressnumber VARCHAR2(256) not used for USA geocoding predirectional VARCHAR2(256) not used for USA geocoding prethoroughfaretype VARCHAR2(256) not used for USA geocoding mainaddress VARCHAR2(256) not used for USA geocoding postthouroughfaretype VARCHAR2(256) not used for USA geocoding postdirectional VARCHAR2(256) not used for USA geocoding postaddress VARCHAR2(256) not used for USA geocoding postcode1 VARCHAR2(256) zip code postcode2 VARCHAR2(256) zip+4 areaname1 VARCHAR2(256) not used for USA geocoding areaname2 VARCHAR2(256) not used for USA geocoding areaname3 VARCHAR2(256) not used for USA geocoding areaname4 VARCHAR2(256) not used for USA geocoding unitvalue VARCHAR2(256) unit value unittype VARCHAR2(256) unit type lowhouse VARCHAR2(256) the low address of the range highhouse VARCHAR2(256) the high address of the range rangecondition VARCHAR2(256) information related to what address numbers are between the from and the to. In the USA these conditions would be (O)dd, (E)ven, (B)oth. In some other countries it may have other meanings. So a from of 1 and a to of 9 with a range condition of Odd would also contain 3, 5, and 7. If the condition were Both it would contain all the integers from 1 to 9. A Even condition for this range would not be correct. rangeside NUMBER 0 = left, 1 = right (default to left if the side is not known) units ADDRESSRANGEUNIT3SET range units 2006 MapInfo Corporation. All rights reserved. 15 GeocodingCartridge_USA.pdf

16 ADDRESSRANGEUNIT3 Object This object holds the data associated with a CandidateRangeUnit from the server. The server allows for returning multiple RangeUnits per range. It contains all of the address fields as well as specific unit fields. Field Type Description country VARCHAR2(3) the ISO standard abbreviation for the country this candidate is in addfield(1) VARCHAR2(256) record type addlfield(2) VARCHAR2(256) carrier route addfield(3) VARCHAR2(256) LACS addlfield(4) VARCHAR2(256) altbase addlfield(5) VARCHAR2(256) odd/even genericfield1 VARCHAR2(256) not used for USA geocoding genericfield2 VARCHAR2(256) not used for USA geocoding genericfield3 VARCHAR2(256) not used for USA geocoding genericfield4 VARCHAR2(256) not used for USA geocoding placename VARCHAR2(256) placename, usually a business name or well known landmark preaddress VARCHAR2(256) not used for USA geocoding addressnumber VARCHAR2(256) not used for USA geocoding predirectional VARCHAR2(256) not used for USA geocoding prethoroughfaretype VARCHAR2(256) not used for USA geocoding mainaddress VARCHAR2(256) not used for USA geocoding postthouroughfaretype VARCHAR2(256) not used for USA geocoding postdirectional VARCHAR2(256) not used for USA geocoding postaddress VARCHAR2(256) not used for USA geocoding postcode1 VARCHAR2(256) not used for USA geocoding postcode2 VARCHAR2(256) zip+4 areaname1 VARCHAR2(256) not used for USA geocoding areaname2 VARCHAR2(256) not used for USA geocoding areaname3 VARCHAR2(256) not used for USA geocoding areaname4 VARCHAR2(256) not used for USA geocoding 2006 MapInfo Corporation. All rights reserved. 16 GeocodingCartridge_USA.pdf

17 Field Type Description unitvalue VARCHAR2(256) unit value unittype VARCHAR2(256) unit type lowunit VARCHAR2(256) a field holding the low unit value for this unit highunit VARCHAR2(256) a field holding the high unit value for this unit MM_PREFERENCE3 Object The MM_PREFERENCE3 object type is used to define how a geocode request is handled. Different preferences can be created to match different geocoding needs. To modify the default settings in the MapMarker Geocoding Cartridge, create or modify a preferences object in the MISYS_PREFERENCES3 table, and then use MM_ADMIN.set_default_preferences to make that preference the single entry in the MISYS_DEFAULT_PREFERENCES3 table. Other preferences may be stored in the MISYS_PREFERENCES3 table and passed to the geocoding engine when the row is being geocoded. The parts of an MM_PREFERENCE3 object are as follows. Field Type Description name VARCHAR2(32) the name of the preference. All access to the preferences may be by name so as to avoid needing to have the various object and package members updated whenever a change to the preference type is required. The Java side of the cartridge will be responsible for retrieving the information of a preference. CloseOnly CHAR(1) field to determine if only closematches will be returned. T = true, F = false. maxcandidates NUMBER the maximum number of candidates to return for an input address geocode maxrangespercandidate NUMBER the maximum number of ADDRESSRANGE2 objects to return for each candidate MaxRangeUnitsPerRange NUMBER the maximum number of ADDRESSRANGEUNIT2 objects to return for each range serverurl VARCHAR2(256) the URL of the server. This is used by the Java side code to open a connection to the server from the client. batchsize NUMBER how often output info is committed in the database. postalfallback CHAR(1) determines if the geocoder can attempt to fallback to a postal centroid in the event that no closematches are found on street geocoding. The country implementation must support this for any centroids to be returned. T = true, F = false. geographicfallback CHAR(1) allows for fallback to geogrpahic data MapInfo Corporation. All rights reserved. 17 GeocodingCartridge_USA.pdf

18 Field Type Description corneroffsetunit CHAR(2) corresponds to the defined unit types for controlling how the offset distances should be interpreted corneroffsetdistance NUMBER the number of distunits the segment on which interpolation should be shrunk. The effect in practice is to move the two endpoint addresses in corneroffset distance and compute all in between addresses from this imaginary segment. streetoffsetunit CHAR(2) the unit of measurement to interpret the streetoffset in streetoffsetdistance NUMBER the number of distunits the street result should be offset from the center-line of the street segment. Only applies to points interpolated based on address ranges. RequestSRID NUMBER the SRID coordinates should be returned in. Will be overridden for table geocoding with an output SDO_GEOMETRY column. mustmatchaddressnumber CHAR(1) If set to T, closematches must match the input address number. T = true, F = false. mustmatchmainaddress CHAR(1) if set to T, the street name fields must match the input for closematches. T = true, F = false. mustmatchareaname1 CHAR(1) if set to T, close candidates must match the areaname1 given in input. T = true, F = false. mustmatchareaname2 CHAR(1) if set to T, close candidates must match the areaname2 given in input. T = true, F = false. mustmatchareaname3 CHAR(1) if set to T, close candidates must match the areaname3 given in input. T = true, F = false. mustmatchareaname4 CHAR(1) if set to T, close candidates must match the areaname4 given in input. T = true, F = false. mustmatchpostal CHAR(1) if set to T, closematches must match the input postal code. T = true, F = false. mustmatchinput CHAR(1) if set to T, the above preferences are also set to T where appropriate. T = true, F = false. addflag(1) CHAR(1) CASS addflag(2) CHAR(1) expanded search addflag(3) CHAR(1) expanded search, stay in state addlflag(4) CHAR(1) DPV addlflag(5) CHAR(1) LACSLink addfield(1) VARCHAR2(256) expanded radius (in miles) addfield(2) VARCHAR2(256) alternate lookup (STREET_FIRST/PLACE_FIRST) 2006 MapInfo Corporation. All rights reserved. 18 GeocodingCartridge_USA.pdf

19 INPUTTABLEINFO3 Object The INPUTTABLEINFO3 object serves as a holder for column mappings to addresses in an input table. For each of the fields, specify the name of the column used to hold that value for the table or null if there is no column for that value (for example, input postcode1). All the named columns should contain character data. Field Type Description tablename VARCHAR2(65) column in the named table containing a unique identifier naming the table that is described KeyColumn VARCHAR2(32) column in the named table linking input to output countrycolumn VARCHAR2(32) column in the named table containing the ISO standard abbreviation for the country of the input address genericfield1column VARCHAR2(32) column in the named table containing the street2; secondary address information such as a Post Office box or apartment number genericfield2column VARCHAR2(32) not used for USA geocoding genericfield3column VARCHAR2(32) column in the named table containing the PMB designator genericfield4column VARCHAR2(32) column in the named table containing the PMB range placenamecolumn VARCHAR2(32) column in the named table containing the placename, usually a business name or well known landmark preaddresscolumn VARCHAR2(32) not used for USA geocoding addressnumbercolumn VARCHAR2(32) column in the named table containing the address number This may be blank and the address number included in the mainaddress. predirectionalcolumn VARCHAR2(32) column in the named table containing the pre direction of a parsed input street prethoroughfaretypecolumn VARCHAR2(32) column in the named table containing the pre type of a parsed input street mainaddresscolumn VARCHAR2(32) column in the named table containing the street address postthoroughfaretypecolumn VARCHAR2(32) column in the named table containing the post type of a parsed input street postdirectionalcolumn VARCHAR2(32) column in the named table containing the post directional of a parsed input street postaddresscolumn VARCHAR2(32) column in the named table containing the lastline; the postal code and any areanames in unparsed format postcode1column VARCHAR2(32) column in the named table containing the zip code postcode2column VARCHAR2(32) column in the named table containing the zip MapInfo Corporation. All rights reserved. 19 GeocodingCartridge_USA.pdf

20 Field Type Description areaname1column VARCHAR2(32) column in the named table containing the state areaname2column VARCHAR2(32) column in the named table containing the county Note: Currently unsupported by the MapMarker Geocoding Server. areaname3column VARCHAR2(32) column in the named table containing the city areaname4column VARCHAR2(32) column in the named table containing the urbanization unitvaluecolumn VARCHAR2(32) column in the named table containing the unit value unittypecolumn VARCHAR2(32) column in the named table containing the unit type defaultcountry CHAR(3) the default country to be used when the INPUTTABLEINFO3 country field is empty or a record in the input table does not have a value in this field. OUTPUTTABLEINFO3 Object The OUTPUTTABLEINFO3 object stores the column information that defines where the output from the geocoding request should be placed. The additional fields also represent the names of columns in the table for that type of data. The attributes of the OUTPUTTABLEINFO3 object are defined below. All attributes of the OUTPUTTABLEINFO3 object are String types. Field Type Description tablename VARCHAR2(65) the fully qualified name of the output table keycolumn VARCHAR2(32) column in the named table where the column name linking input to output will be written countrycolumn VARCHAR2(32) column in the named table where the ISO standard abbreviation for this candidate s country will be written genericfield1column VARCHAR2(32) column in the named table where the street2 will be written genericfield2column VARCHAR2(32) column in the named table where the census block will be written genericfield3column VARCHAR2(32) column in the named table where the PMB designator will be written genericfield4column VARCHAR2(32) column in the named table where the PMB range will be written placenamecolumn VARCHAR2(32) column in the named table where the placename of a candidate address will be written 2006 MapInfo Corporation. All rights reserved. 20 GeocodingCartridge_USA.pdf

21 Field Type Description formattedstreetcolumn VARCHAR2(32) column in the named table where the formatted street address will be written (not parsed into individual fields, for example: 10 Main St Apt 2 ) formattedlocationcolumn VARCHAR2(32) column in the named table where the last line information of the address, such as area name information and postal code, will be written. preaddresscolumn VARCHAR2(32) not used for USA geocoding addressnumbercolumn VARCHAR2(32) column in the named table where the address number for the candidate will be written (some implementations may return this combined with street address info in one or more of the following fields) predirectionalcolumn VARCHAR2(32) column in the named table where the String assigned by the country geocoder to predirectional will be written prethoroughfaretypecolumn VARCHAR2(32) column in the named table where the String assigned by the country geocoder to the prethoroughfaretype will be written mainaddresscolumn VARCHAR2(32) column in the named table where the String assigned by the country geocoder to the mainaddress field will be written. In most countries candidates this will be the complete street address, and may include the address number. postthoroughfaretypecolumn VARCHAR2(32) column in the named table where the post type for the street address will be written, if available postdirectionalcolumn VARCHAR2(32) column in the named table where the post directional will be written, if available postcode1column VARCHAR2(32) column in the named table where the zip code will be written postcode2column VARCHAR2(32) column in the named table where the zip+4 will be written areaname1column VARCHAR2(32) column in the named table where the state will be written areaname2column VARCHAR2(32) column in the named table where the county will be written (not currently supported) areaname3column VARCHAR2(32) column in the named table where the city will be written areaname4column VARCHAR2(32) column in the named table where the urbanization will be written unitvaluecolumn VARCHAR2(32) column in the named table where the unit value will be written unittypecolumn VARCHAR2(32) column in the named table where the unit type will be written xcolumn VARCHAR2(32) column in the named table where the longitude coordinate will be written ycolumn VARCHAR2(32) column in the named table where the latitude coordinate will be written 2006 MapInfo Corporation. All rights reserved. 21 GeocodingCartridge_USA.pdf

22 Field Type Description SRIDColumn VARCHAR2(32) column in the named table where the Oracle SRID will be written, which represents the coordinate system the latitude and longitude should be interpreted in spatialobjectcolumn VARCHAR2(32) column in the named table where the name of a MDSYS.SDO_GEOMETRY column to put the point returned by the geocoder will be written closematchflagcolumn VARCHAR2(32) column in the named table that will contain a T if true (if the geocoder considered this candidate a closematch). F if false. TotalCandidatesColumn VARCHAR2(32) column in the named table where the total number of candidates found by the geocoder will be written for the input address TotalCloseCandidatesColumn VARCHAR2(32) column in the named table where the total number of candidates that the geocoder considered close matches will be written. Close candidates are ordered first in the candidate array. resultcodecolumn VARCHAR2(32) column in the named table where the result code for the candidate will be written. This corresponds to the type of point returned as well as which fields in the input address matches the corresponding fields in this candidate. errorcodecolumn VARCHAR2(32) column in the named table where the number corresponding to a type of address related error will be written. Does not include server, user and database errors, as these errors abort the geocoding process. errormessagecolumn VARCHAR2(32) column in the named table where the text of an address related error will be written addfield(1) VARCHAR2(256) carrier route addfield(2) VARCHAR2(256) check digit addfield(3) VARCHAR2(256) delivery point addfield(4) VARCHAR2(256) LACS addfield(5) VARCHAR2(256) multi-unit flag addfield(6) VARCHAR2(256) record type addfield(7) VARCHAR2(256) census block addfield(8) VARCHAR2(256) geographic rank (for geographic fallback candidates) addfield(9) VARCHAR2(256) DPV CONF addfield(10) VARCHAR2(256) DPV CMRA addfield(11) VARCHAR2(256) DPV FP addfield(12) VARCHAR2(256) DPV footnote MapInfo Corporation. All rights reserved. 22 GeocodingCartridge_USA.pdf

23 Field Type Description addfield(13) VARCHAR2(256) DPV footnote 2 addfield(14) VARCHAR2(256) DPV footnote 3 addfield(15) VARCHAR2(256) default flag addfield(16) VARCHAR2(256) LACSLink indicator addfield(17) VARCHAR2(256) LACSLink return code addfield(18) VARCHAR2(256) Out PMB street2 flag; if set to T (true) genericfield1 will have the street2 information MM_USA Package The MM_USA package contains a number of set and get methods that enable you to specify and have returned the U.S.-specific parts of an address.the methods are listed below, and are organized by object. commonaddress Object The MM_USA package contains the following methods for accessing commonaddress elements: Method function getstate(addr in CommonAddress) return VARCHAR2 function getcity(addr in CommonAddress) return VARCHAR2 function geturbanization(addr in CommonAddress) return VARCHAR2 function getzipcode(addr in CommonAddress) return VARCHAR2 function getzip4(addr in CommonAddress) return VARCHAR2 function getfirm(addr in CommonAddress) return VARCHAR2 Description Returns the address s areaname1. Returns the address s areaname3. Returns the address s areaname4. Returns the address s postcode1. Returns the address s postcode2. Returns the address s placename MapInfo Corporation. All rights reserved. 23 GeocodingCartridge_USA.pdf

24 MISYS.GeoAddress3 Object The following methods operate on MISYS.GeoAddress3 objects: Method procedure setstreet(addr in out GeoAddress3, street in VARCHAR2); procedure setstreet2(addr in out GeoAddress3, street2 in VARCHAR2); procedure setlastline(addr in out GeoAddress3, lastline in VARCHAR2); procedure setstate(addr in out GeoAddress3, state in VARCHAR2); procedure setcity(addr in out GeoAddress3, city in VARCHAR2); procedure seturbanization(addr in out GeoAddress3, urbanization in VARCHAR2); procedure setzipcode(addr in out GeoAddress3, zipcode in VARCHAR2); procedure setzip4(addr in out GeoAddress3, zip4 in VARCHAR2); procedure setfirm(addr in out GeoAddress3, firm in VARCHAR2); function getstreet(addr in GeoAddress3) return VARCHAR2; function getstreet2(addr in GeoAddress3) return VARCHAR2; function getlastline(addr in GeoAddress3) return VARCHAR2; Description Sets the GeoAddressAddress3 mainaddress. Sets the GeoAddress3 genericfield1. Sets the GeoAddress3 postaddress. Sets the GeoAddress3 areaname1. Sets the GeoAddress3 areaname3. Sets the GeoAddress3 areaname4. Sets the GeoAddress postcode1. Sets the GeoAddress postcode. Sets the GeoAddress placename. Returns the GeoAddress mainaddress. Returns the GeoAddress3 genericfield1. Returns the GeoAddress3 postaddress. MYSIS.Candidate3 Object The following methods operate on the MYSIS.Candidate3 object: Method function getstreet(cand in Candidate3) return VARCHAR2; function getstreet2(cand in Candidate3) return VARCHAR2; function getlastline(cand in Candidate3) return VARCHAR2; function getpmbdesignator(cand in Candidate3) return VARCHAR2; function getpmbrange(cand in Candidate3) return VARCHAR2; Description Returns the Candidate3 formattedstreet. Returns the Candidate3 genericfield1. Returns the Candidate3 formattedlocation. Returns the Candidate3 genericfield3. Returns the Candidate3 genericfield MapInfo Corporation. All rights reserved. 24 GeocodingCartridge_USA.pdf

25 The following methods operate on the MYSIS.Candidate3 object to get U.S.-specific output that is stored in the addfields of the candidate: Method function getcensusblock(cand in Candidate3) return VARCHAR2; function getlacs(cand in Candidate3) return VARCHAR2; function getdeliverypoint(cand in Candidate3) return VARCHAR2; function getcheckdigit(cand in Candidate3) return VARCHAR2; function getrecordtype(cand in Candidate3) return VARCHAR2; function getcarrierroute(cand in Candidate3) return VARCHAR2; function getmultiunitflag(cand in Candidate3) return VARCHAR2; function getpmboutaddr2(cand in Candidate3) return VARCHAR2; function getdefaultflag(cand in Candidate3) return VARCHAR2; function getgeographicrank(cand in Candidate3) return VARCHAR2; function getdpvconf(cand in Candidate3) return VARCHAR2; function getdpvcmra(cand in Candidate3) return VARCHAR2; function getdpvfp(cand in Candidate3) return VARCHAR2; function getdpvfn1(cand in Candidate3) return VARCHAR2; function getdpvfn2(cand in Candidate3) return VARCHAR2; function getdpvfn3(cand in Candidate3) return VARCHAR2; function getlacslinkindicator(cand in Candidate3) return VARCHAR2; function getlacslinkreturncode(cand in Candidate3) return VARCHAR2; Description Returns the Candidate3.getAdditionalField(7). Returns the Candidate3.getAdditionalField(4). Returns the Candidate3.getAdditionalField(3). Returns the Candidate3.getAdditionalField(2). Returns the Candidate3.getAdditionalField(6). Returns the Candidate3.getAdditionalField(1). Returns the Candidate3.getAdditionalField(5). Returns the Candidate3.getAdditionalField(18). Returns the Candidate3.getAdditionalField(15). Returns the Candidate3.getAdditionalField(8). Returns the Candidate3.getAdditionalField(9). Returns the Candidate3.getAdditionalField(10). Returns the Candidate3.getAdditionalField(11). Returns the Candidate3.getAdditionalField(12). Returns the Candidate3.getAdditionalField(13). Returns the Candidate3.getAdditionalField(14). Returns the Candidate3.getAdditionalField(16). Returns the Candidate3.getAdditionalField(17). MISYS.AddressRange3 Object The following methods operate on the MISYS.AddressRange3 object: Method function getoddeven(range in AddressRange3) return VARCHAR2; Description Returns the AddressRange3 rangecondition MapInfo Corporation. All rights reserved. 25 GeocodingCartridge_USA.pdf

26 The following methods get range information that is stored in the addfields of the range: Method function getrecordtype(range in AddressRange3) return VARCHAR2; function getcarrierroute(range in AddressRange3) return VARCHAR2; function getlacs(range in AddressRange3) return VARCHAR2; function getaltbase(range in AddressRange3) return VARCHAR2; Description Returns the AddressRange3. getadditionalfield(1). Returns the AddressRange3.getAdditionalField(2). Returns the AddressRange3.getAdditionalField(3). Returns the AddressRange3.getAdditionalField(4). MISYS.ADDRESSRANGEUNIT3 The following methods operate on the MISYS.ADDRESSRANGEUNIT3 object to get unit information that is stored in the addfields of the unit: Method function getrecordtype(unit in AddressRangeUnit3) return VARCHAR2; function getcarrierroute(unit in AddressRangeUnit3) return VARCHAR2; function getlacs(unit in AddressRangeUnit3) return VARCHAR2; function getaltbase(unit in AddressRangeUnit3) return VARCHAR2; function getoddeven(unit in AddressRangeUnit3) return VARCHAR2; Description Returns the AddressRangeUnit3.getAdditionalField(1). Returns the AddressRangeUnit3.getAdditionalField(2). Returns the AddressRangeUnit3.getAdditionalField(3). Returns the AddressRangeUnit3.getAdditionalField(4). Returns the AddressRangeUnit3.getAdditionalField(5). MISYS.MM_Preference3 Object The following methods operate on the MISYS.MM_Preference3 object: Method procedure setusecassmode(preference in out MM_Preference3, flag in CHAR); procedure setexpandedsearch(preference in out MM_Preference3, flag in CHAR); procedure setexpandedrestrictstate(preference in out MM_Preference3, flag in CHAR); procedure setusedpv(preference in out MM_Preference3, flag in CHAR); Description Sets the addflag 1 to flag. Sets the addflag 2 to flag. Sets the addflag 3 to flag. Sets the addflag 4 to flag MapInfo Corporation. All rights reserved. 26 GeocodingCartridge_USA.pdf

27 Method procedure setuselacslink(preference in out MM_Preference3, flag in CHAR); procedure setexpandedradius(preference in out MM_Preference3, distance in NUMBER) procedure setalternatelookup(preference in out MM_Preference3, alternatelookup in VARCHAR2); Description Sets the addflag 5 to flag. Sets the addfield 1 to TO_CHAR(distance). Sets the addfield 2 to alternatelookup. The following methods get U.S.-specific preference options: Method function getusecassmode(preference in MM_Preference3) return CHAR; function getexpandedsearch(preference in MM_Preference3) return CHAR; function getexpandedrestrictstate(preference in MM_Preference3) return CHAR; function getusedpv(preference in MM_Preference3) return CHAR; function getusalacslink(preference in MM_Preference3) return CHAR; function getexpandedradius(preference in MM_Preference3) return NUMBER; function getalternatelookup(preference in MM_Preference3) return VARCHAR2; Description Returns the MM_Preference.getAdditionalFlag(1). Returns the MM_Preference.getAdditionalFlag(2). Returns the MM_Preference.getAdditionalFlag(3.) Returns the MM_Preference.getAdditionalFlag(4). Returns the MM_Preference.getAdditionalFlag(5). Returns the MM_Preference.getAdditionalField(1). Returns the MM_Preference.getAdditionalField(2.) 2006 MapInfo Corporation. All rights reserved. 27 GeocodingCartridge_USA.pdf

28 MapMarker Geocoding Cartridge USA Layer Examples A To learn how to geocode to MapMarker using the MapMarker Geocoding Cartridge USA layer, look at the demos in the MapInfoGeocodingCartridge4.0\USA\demos directory for example SQL scripts. To run them, log in as MISYS. In this appendix: single_fields.sql table_fields.sql table_geoaddr.sql trigger_fields.trg

29 Appendix A: MapMarker Geocoding Cartridge USA Layer Examples single_fields.sql This script demonstrates how to geocode a single address when you do not have a GEOADDRESS3 object. Note: This script uses the first candidate even if there are multiple, equal matches. 1. The script turns on tracing so dbms_output will show up. 2. Then it creates a MISYS.GEOADDRESS3 object containing the address to be geocoded. 3. The script then geocodes using the MapMarker Geocoding Cartridge defaults. 4. If successful, the longitude/latitude coordinates of the first candidate are shown. After running this demonstration script, you can remove the temporary procedure created by this example by uncommenting and executing the last line in the script: drop procedure usa_single_fields; table_fields.sql This script demonstrates how to geocode a table when address information is not contained in GEOADDRESS3 objects. To use the code contained in this script on your own table, you must replace the table and column names with names applicable to your table. Note: This script uses only the street, zip, longitude and latitude fields. You may want to expand it to use other fields such and city, state, output firm, etc. It also uses the first candidate even if there are multiple, equal matches. 1. The script first drops table temp_geotable. This will show an error if the table does not exist. 2. It then creates and populates a temporary table and inserts the table metadata into USER_SDO_GEOM_METADATA. 3. Table temp_geotableout is then dropped. This will show an error if the table does not exist. 4. A second temporary table is then created for storing geocode results. 5. The script then creates a procedure named table_fields that assigns the INPUTTABLEINFO3 and OUTPUTTABLEINFO3 objects and calls the geocode_table procedure. Next, the table_fields procedure is called and the results are selected from the tables. After running this demonstration script, you can remove the temporary data created by this example by uncommenting and executing the last three lines in the script: drop table temp_geotable; drop table temp_geotableout; drop procedure table_fields; 2006 MapInfo Corporation. All rights reserved. 29 GeocodingCartridge_USA.pdf

30 Appendix A: MapMarker Geocoding Cartridge USA Layer Examples table_geoaddr.sql This script demonstrates how to geocode a table when address information is contained in a GEOADDRESS3 object. It also shows how to create a new preferences object to use during the geocode. To use the code contained in this script on your own table, you must replace the table and geoaddress column names with names applicable to your table. 1. The script turns on tracing so dbms_output will show up. 2. Table temp_geotable is then dropped. This will show an error if the table does not exist. 3. The script then creates and populates a temporary table. 4. A procedure that will geocode the table using new preference settings is then created. The default preferences are modified to allow for 4 candidates, each with 3 ranges and 3 range units. 5. The table is then geocoded using the modified MapMarker Geocoding Cartridge settings. After running this demonstration script, you can remove the temporary data created by this example by uncommenting and executing the last line in the script: drop table temp_geotable; trigger_fields.trg This script demonstrates how to geocode a new or updated record when you do not have a GEOADDRESS3 column. If you don't have an MISYS.GEOADRESS3 column in your table you can use the code supplied within this script. You must replace the table and column names with names applicable to your table. Note: This code uses the first candidate even if there are multiple, equal matches. 1. This script first drops table temp_coltrigger. This will show an error if the table does not exist. 2. Then a new table named temp_coltrigger is created containing company, add1, add2, city, state, and zip columns. Next, OutFirm, OutStreet, OutCity, OutState, OutZIP, longitude, latitude, and georesult columns are added to the table. 3. The trigger is then created. 4. A new address is then inserted. After the insert, candidate information should be automatically inserted into the temp_coltrigger table. After running this demonstration script, you can remove the temporary data created by this example by uncommenting and executing the last line in the script: drop table temp_coltrigger; 2006 MapInfo Corporation. All rights reserved. 30 GeocodingCartridge_USA.pdf

31 Appendix A: MapMarker Geocoding Cartridge USA Layer Examples create_us_addr.sql The create_us_addr.sql script and the script that follows, geocode_us_addr.sql, are executed in succession to demonstrate creating and geocoding a table of U.S. sample addresses. The create_us_addr.sql script creates an Oracle table of U.S. sample address named US_ADDR. This table of addresses is used when you execute the geocode_us_addr script. 1. Creates US_ADDR table with address input and output columns. 2. Inserts spatial metadata for the table into USER_SDO_GEOM_METADATA. 3. Creates a spatial index on US_ADDR table. 4. Inserts input address information into US_ADDR. 5. Grants select, insert, and update privileges to MISYS user. geocode_us_addr.sql This script demonstrates how to geocode a sample table of addresses named US_ADDR. Geocoded output information is inserted into the US_ADDR table and address match output is displayed upon script completion. 1. Creates input table, output table, and geocoding preference objects. 2. Assigns sampling of preferences to the preference objects. 3. Assigns input and output column names to the table objects. 4. Displays how to insert candidate spatial point objects and U.S. census information into the us_addr table. 5. Geocodes table with assigned preferences. 6. Georesult address matching information is displayed MapInfo Corporation. All rights reserved. 31 GeocodingCartridge_USA.pdf

32 Glossary B In this appendix: Glossary of Address and Geocoding Terms

33 Appendix B: Glossary Glossary of Address and Geocoding Terms Candidate Record from the MapMarker Address Dictionary that is considered a potential match for the input address, based on its score. Carrier Route USPS address element that describes a given mail delivery or collection route within a 5-digit ZIP Code. There are five possible Carrier Route codes: Bnnn = P.O. Box; Hnnn = Highway Contract; Rnnn = Rural Route; Cnnn = City Delivery; and Gnnn = General Delivery (where n = a number). CASS Mode A strict manner of geocoding records, based on the standards set by the USPS Coding and Accuracy Support System (CASS), which strives for accurate addresses for mail pieces. Geocoding in this way matches records to the exact house number, street name, and ZIP Code. Other geocoding preferences are overridden. The street name and postal code can vary. Census Block U.S. Census Bureau code that uniquely identifies a geographic area for census reporting. Up to a 15- digit alphanumeric code can be returned for a successful match, depending on the result code. The census value is interpreted as follows: SSCCCTTTTTTGBB(B) where: S = State Federal Information Processing Standard (FIPS) code (2 characters) C = County FIPS code (3 characters) T = Census Tract (6 characters) G = Census Block Group (1 character) B = Census Block (typically 2 characters. The third character means the block was split from another block.) S5 matches return the full code to the Census Block level. S1, S2, S3, Z1, Z2, and Z3 matches return the Block Group code (12 digits). No value is returned for S4 matches. Check Digit A one-digit code that together with Delivery Point is used to form the delivery point bar code on U.S. mail pieces. County Name of subdivision of a state. Delivery Point A two-digit code that along with the Check Digit is used to form the delivery point barcode on U.S. mail pieces MapInfo Corporation. All rights reserved. 33 GeocodingCartridge_USA.pdf