SAP ABAP Class CL_GEOCODER (Application Interface for Geocoding)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-GEO (Application Component) Geographical Functions
⤷
SZGEOCODING (Package) Geocoding, Independent of Business Address Services
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ADDRESS_ENHANCEMENT_SERVICE | IF for Address Enhancement Services (Geo-Coding, Nielsen,..) | 20000225 |
Properties
| Class | CL_GEOCODER | |
| Short Description | Application Interface for Geocoding | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SZGEOCODING | Geocoding, Independent of Business Address Services |
| Created | 20000202 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_GEOCODER has no forward declaration.
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_ADDRESS_ENHANCEMENT_SERVICE | IF for Address Enhancement Services (Geo-Coding, Nielsen,..) | 20000225 |
Friends
Class CL_GEOCODER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Protected | Type reference (TYPE) | XFLAG | ' ' | False | 20001207 | ||
| 2 | Instance attribute | Public | Type reference (TYPE) | GEOCD_CHOICE_TABLE | Table with Address Selections for Geocoding | 20000523 | |||
| 3 | Static Attribute | Protected | Type reference (TYPE) | FIELDNAME_TABLE | Buffered Table, Attribute Names of ADRC_STRUC | 20000214 | |||
| 4 | Static Attribute | Protected | See coding | Buffered Table, Relevant Address Fields | 20000210 | ||||
| 5 | Static Attribute | Protected | See coding | Buffered Table with Geocoders | 20000208 | ||||
| 6 | Static Attribute | Protected | Type reference (TYPE) | GEOCODING_TOOLS_LTABLE | Mapping Table SRCID->Interface in Geocoding Tool | 20000221 | |||
| 7 | Constant | Protected | Type reference (TYPE) | XFLAG | 'X' | True | 20001207 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Checks Whether Coding-Relevant Address Changes Occurred | 20000330 | |
| 2 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20000208 | |
| 3 | Instance method | Public | Method | Compares Two Addresses. Delivers List of Different Fields | 20000215 | |
| 4 | Instance method | Public | Method | Compares the Given Fields of Two Addresses | 20000215 | |
| 5 | Instance method | Protected | Method | Displays the Selection List, in the Case of Interactive Mode | 20000229 | |
| 6 | Instance method | Protected | Method | Geocoding of Addresses in One Country | 20000210 | |
| 7 | Instance method | Protected | Method | Delivers the Suitable Reference (IF_GEOCODING_TOOL) to SRCID | 20000221 | |
| 8 | Instance method | Protected | Method | Interactive Geocoding Mode | 20000228 |
Events
Class CL_GEOCODER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | GEOCODING_TOOLS_LTABLE | Protected | See coding | 20000303 | GEOCODING_TOOLS_LTABLE type hashed table of LS_GEOCODER2CLASS
with unique key srcid
|
||
| 2 | LS_GEOCODER2CLASS | Protected | See coding | 20000303 | BEGIN OF LS_GEOCODER2CLASS,
srcid type geosrcid,
clsname type seoclsname,
geocoding_tool type ref to if_geocoding_tool,
END OF LS_GEOCODER2CLASS
|
Method Signatures
Method CHECK_FOR_RELEVANT_CHANGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GEOCODER_ID | Call by reference | Type reference (TYPE) | GEOSRCID | Id des Geokodierers | 20000330 | |||
| 2 | NEW_ADDRESS | Call by reference | Type reference (TYPE) | AES_ADDR | Neue Adresse | 20000330 | |||
| 3 | OLD_ADDRESS | Call by reference | Type reference (TYPE) | AES_ADDR | Alte Adresse | 20000330 | |||
| 4 | RELEVANT | Call by reference | Type reference (TYPE) | XFLAG | 'X'=Es fanden relevante Änderungen statt. | 20000330 |
Method CHECK_FOR_RELEVANT_CHANGES on class CL_GEOCODER has no exception.
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_GEOCODER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_GEOCODER has no exception.
Method COMPARE_ADDRESSES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ADDRESS1 | Call by reference | Type reference (TYPE) | ADRC_STRUC | Erste Adresse | 20000215 | |||
| 2 | ADDRESS2 | Call by reference | Type reference (TYPE) | ADRC_STRUC | Zweite Adresse | 20000215 | |||
| 3 | DIFFERENT_FIELDS | Call by reference | Type reference (TYPE) | FIELDNAME_TABLE | Namen der unterschiedlichen Attribute der ADRC_STRUC | 20000215 |
Method COMPARE_ADDRESSES on class CL_GEOCODER has no exception.
Method COMPARE_FIELDS_OF_ADDRESSES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ADDRESS1 | Call by reference | Type reference (TYPE) | ADRC_STRUC | Adresse1 | 20000215 | |||
| 2 | ADDRESS2 | Call by reference | Type reference (TYPE) | ADRC_STRUC | Adresse2 | 20000215 | |||
| 3 | DIFFERENT_FIELDS | Call by reference | Type reference (TYPE) | FIELDNAME_TABLE | Liste der Felder mit unterschiedlichem Inhalt | 20000215 | |||
| 4 | FIELDNAMES | Call by reference | Type reference (TYPE) | FIELDNAME_TABLE | Liste der zu vergleichenden Felder | 20000215 |
Method COMPARE_FIELDS_OF_ADDRESSES on class CL_GEOCODER has no exception.
Method DISPLAY_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | APPLY_ADDRESS | Call by reference | Type reference (TYPE) | GEOCDCHXFL | Ausgewählte Adresse in den Dialog übernehmen? | 20000417 | |||
| 2 | CHOICE | Call by reference | Type reference (TYPE) | GEOCD_CHOICE_SORTEDTABLE | Auswahlliste | 20000229 | |||
| 3 | CHOSEN | Call by reference | Type reference (TYPE) | GEOCD_CHOI | Ausgewählter Eintrag | 20000229 | |||
| 4 | INTERACTION_ALLOWED | Call by reference | Type reference (TYPE) | GEOCD_XFLG | Exklusivflag für Geokodierung | 20000229 | |||
| 5 | RESULT | Call by reference | Type reference (TYPE) | GEOCD_RESS | Ergebnis aus der Geokodierung | 20000229 | |||
| 6 | RETURN_VALUE | Call by reference | Type reference (TYPE) | CHAR10 | 'OK', 'CANCEL' oder 'IGNORE' | 20001024 |
Method DISPLAY_LIST on class CL_GEOCODER has no exception.
Method GEOCODE_ONE_COUNTRY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ADDRESSES | Call by reference | Type reference (TYPE) | AES_ADDR_SORTEDTABLE | Tabelle mit den Adressen | 20000210 | |||
| 2 | CONTAINERS | Call by reference | Type reference (TYPE) | AESC_SORTEDTABLE | Tabelle mit Container für Geokodierungsergebnisse | 20000210 | |||
| 3 | CORRECTED_ADDRESSES | Call by reference | Type reference (TYPE) | AES_ADDR_SORTEDTABLE | Tabelle mit geänderten Adressen | 20000210 | |||
| 4 | COUNTRY | Call by reference | Type reference (TYPE) | LAND1 | Land, in dem sich die angegebenen Adressen befinden | 20000210 | |||
| 5 | INTERACTION_ALLOWED | Call by reference | Type reference (TYPE) | XFLAG | Interaktion an der Oberfläche? space=Nein (z.B. Batch) | 20000228 | |||
| 6 | MESSAGES | Call by reference | Type reference (TYPE) | AES_MSG_TABLE | Bei Geokodierung erzeugte Nachrichten | 20000210 | |||
| 7 | OPTIONS | Call by reference | Type reference (TYPE) | GEOCD_OPTION | Geokodierung: Optionen (IGS) | 20041109 | |||
| 8 | PREV_ADDRESSES | Call by reference | Type reference (TYPE) | AES_ADDR_SORTEDTABLE | Tabelle mit vorherigen Adressen (sortiert nach GUID) | 20000210 | |||
| 9 | RESULTS | Call by reference | Type reference (TYPE) | GEOCD_RES_SORTEDTABLE | Liste mit Ergebnissen aus der Geokodierung | 20000303 |
Method GEOCODE_ONE_COUNTRY on class CL_GEOCODER has no exception.
Method GET_GEOCODING_TOOL_FROM_SRCID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | OBJ_GEOCODING_TOOL | Call by reference | Object reference (TYPE REF TO) | IF_GEOCODING_TOOL | Interface zu Geokodierungstools (3rd Party) | 20000221 | |||
| 2 | SRCID | Call by reference | Type reference (TYPE) | GEOSRCID | ID des Geokodierers | 20000221 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Customizing Fehler bei den Geokodierern | 20000221 |
Method INTERACTIVE_GEOCODING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ADDRESSES | Call by reference | Type reference (TYPE) | AES_ADDR_SORTEDTABLE | Tabelle mit allen noch zu geokodierenden Adressen | 20000228 | |||
| 2 | CONTAINERS | Call by reference | Type reference (TYPE) | AESC_SORTEDTABLE | Tabelle mit AES-Containern | 20000228 | |||
| 3 | CORRECTED_ADDRESSES | Call by reference | Type reference (TYPE) | AES_ADDR_SORTEDTABLE | Korrigierte Adressen | 20000228 | |||
| 4 | GEOCODING_TOOL | Call by reference | Object reference (TYPE REF TO) | IF_GEOCODING_TOOL | Referenz auf das eigentlich Geokodierungstool | 20000228 | |||
| 5 | INTERACTION_ALLOWED | Call by reference | Type reference (TYPE) | GEOCD_XFLG | Auswahlmodus, ja/nein? | 20000228 | |||
| 6 | MESSAGES | Call by reference | Type reference (TYPE) | AES_MSG_TABLE | Tabelle mit generierten Meldungen | 20000228 | |||
| 7 | OPTIONS | Call by reference | Type reference (TYPE) | GEOCD_OPTION | Geokodierung: Optionen (IGS) | 20041109 | |||
| 8 | RESULTS | Call by reference | Type reference (TYPE) | GEOCD_RES_SORTEDTABLE | Ergebnisse der Geokodierung | 20000228 | |||
| 9 | XINFO | Call by reference | Type reference (TYPE) | GEOCDXINFO | Zusatzinfos für den Geokodierer | 20000831 |
Method INTERACTIVE_GEOCODING on class CL_GEOCODER has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 46D |