com.esri.arcgis.location
Interface IGeocodeServer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GeocodeServer, IGeocodeServerProxy

public interface IGeocodeServer
extends java.io.Serializable

COM Interface 'IGeocodeServer'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description: 'Provides access to members for geocoding addresses.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID5918bc71_27dc_41d7_8282_a0871a612923
static int	xxDummy Deprecated. Internal use only

Method Summary

IRecordSet	findAddressCandidates(IPropertySet address, IPropertySet propMods) Generates candidates for an address (normal or standardized form).
IPropertySet	geocodeAddress(IPropertySet address, IPropertySet propMods) Geocodes a single address (normal or standardized form).
IRecordSet	geocodeAddresses(IRecordSet addressTable, IPropertySet addressFieldMapping, IPropertySet propMods) Geocodes a table of addresses.
IFields	getAddressFields() Fields needed to geocode a table of addresses.
IFields	getCandidateFields(IPropertySet propMods) Fields contained in a list of candidates.
IPropertySet	getDefaultInputFieldMapping() Suggested field name mappings for all input fields.
IFields	getIntersectionCandidateFields(IPropertySet propMods) Fields contained by intersection candidates.
IPropertySet	getLocatorProperties() Default properties for a locator.
IFields	getResultFields(IPropertySet propMods) Fields contained in the geocoding result.
IFields	getStandardizedFields() Fields contained in a standardized address.
IFields	getStandardizedIntersectionFields() Fields contained in a standardized intersection.
IPropertySet	reverseGeocode(IPoint location, boolean bReturnIntersection, IPropertySet propMods) Generates an address for a point.
IPropertySet	standardizeAddress(IPropertySet address, IPropertySet propMods) Standardizes an address.

Field Detail

IID5918bc71_27dc_41d7_8282_a0871a612923

static final int IID5918bc71_27dc_41d7_8282_a0871a612923

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

geocodeAddress

IPropertySet geocodeAddress(IPropertySet address,
                            IPropertySet propMods)
                            throws java.io.IOException,
                                   AutomationException

Geocodes a single address (normal or standardized form).

Parameters:

address - A reference to a com.esri.arcgis.system.IPropertySet (in)

propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

geocodeAddresses

IRecordSet geocodeAddresses(IRecordSet addressTable,
                            IPropertySet addressFieldMapping,
                            IPropertySet propMods)
                            throws java.io.IOException,
                                   AutomationException

Geocodes a table of addresses.

Parameters:

addressTable - A reference to a com.esri.arcgis.geodatabase.IRecordSet (in)

addressFieldMapping - A reference to a com.esri.arcgis.system.IPropertySet (in)

propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRecordSet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

standardizeAddress

IPropertySet standardizeAddress(IPropertySet address,
                                IPropertySet propMods)
                                throws java.io.IOException,
                                       AutomationException

Standardizes an address. One of the properties returned indicates if it is an intersection or not.

Parameters:

address - A reference to a com.esri.arcgis.system.IPropertySet (in)

propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findAddressCandidates

IRecordSet findAddressCandidates(IPropertySet address,
                                 IPropertySet propMods)
                                 throws java.io.IOException,
                                        AutomationException

Generates candidates for an address (normal or standardized form).

Parameters:

address - A reference to a com.esri.arcgis.system.IPropertySet (in)

propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRecordSet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddressFields

IFields getAddressFields()
                         throws java.io.IOException,
                                AutomationException

Fields needed to geocode a table of addresses.

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCandidateFields

IFields getCandidateFields(IPropertySet propMods)
                           throws java.io.IOException,
                                  AutomationException

Fields contained in a list of candidates.

Parameters:

propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIntersectionCandidateFields

IFields getIntersectionCandidateFields(IPropertySet propMods)
                                       throws java.io.IOException,
                                              AutomationException

Fields contained by intersection candidates.

Parameters:

propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardizedFields

IFields getStandardizedFields()
                              throws java.io.IOException,
                                     AutomationException

Fields contained in a standardized address.

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardizedIntersectionFields

IFields getStandardizedIntersectionFields()
                                          throws java.io.IOException,
                                                 AutomationException

Fields contained in a standardized intersection.

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResultFields

IFields getResultFields(IPropertySet propMods)
                        throws java.io.IOException,
                               AutomationException

Fields contained in the geocoding result.

Parameters:

propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultInputFieldMapping

IPropertySet getDefaultInputFieldMapping()
                                         throws java.io.IOException,
                                                AutomationException

Suggested field name mappings for all input fields.

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocatorProperties

IPropertySet getLocatorProperties()
                                  throws java.io.IOException,
                                         AutomationException

Default properties for a locator.

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reverseGeocode

IPropertySet reverseGeocode(IPoint location,
                            boolean bReturnIntersection,
                            IPropertySet propMods)
                            throws java.io.IOException,
                                   AutomationException

Generates an address for a point.

Parameters:

location - A reference to a com.esri.arcgis.geometry.IPoint (in)

bReturnIntersection - The bReturnIntersection (in)

propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.