com.esri.arcgis.location
Class IGeocodingPropertiesProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.location.IAddressInputsProxy
          com.esri.arcgis.location.IGeocodingPropertiesProxy

All Implemented Interfaces:

IAddressInputs, IGeocodingProperties, Externalizable, Serializable

Direct Known Subclasses:

IGeocodingProperties2Proxy

public class IGeocodingPropertiesProxy
extends IAddressInputsProxy
implements IGeocodingProperties, Serializable

Provides access to members that control geocoding settings.

When To Use

Use the IGeocodingProperties interface to inspect and set properties specific to address locators that use the ESRI geocoding engine.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGeocodingPropertiesProxy()
	IGeocodingPropertiesProxy(Object obj)
protected	IGeocodingPropertiesProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getEndOffset() End offset percentage.
String	getIntersectionConnectors() Connector strings used to designate intersections.
int	getMinimumCandidateScore() Minimum candidate score setting.
int	getMinimumMatchScore() Minimum match score setting.
double	getSideOffset() Side offset distance.
int	getSideOffsetUnits() Units used for the side offset.
int	getSpellingSensitivity() Spelling sensitivity setting.
boolean	isAddPercentAlongToMatchFields() Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result.
boolean	isAddReferenceIDToMatchFields() Indicates if the feature ID of the matched feature is included in the geocoding result.
boolean	isAddStandardizeStringToMatchFields() Indicates if the standardized address is included in the geocoding result.
boolean	isAddXYCoordsToMatchFields() Indicates if the x and y coordinates of the address location are included in the geocoding result.
boolean	isMatchIfScoresTie() Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score.
boolean	isUseRelativePaths() Indicates if the paths to the reference data should be stored relative to the locator.
void	removeListener(String iidStr, Object theListener)
void	setAddPercentAlongToMatchFields(boolean bAddPercentAlongToMatchFields) Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result.
void	setAddReferenceIDToMatchFields(boolean bAddReferenceIDToMatchFields) Indicates if the feature ID of the matched feature is included in the geocoding result.
void	setAddStandardizeStringToMatchFields(boolean bAddStandardizeStringToMatchFields) Indicates if the standardized address is included in the geocoding result.
void	setAddXYCoordsToMatchFields(boolean bAddXYCoordsToMatchFields) Indicates if the x and y coordinates of the address location are included in the geocoding result.
void	setDefaultInputFieldNames(String addressField, Object rhs2) Recognized names for a required input field.
void	setEndOffset(int endOffset) End offset percentage.
void	setIntersectionConnectors(String intersectionConnectors) Connector strings used to designate intersections.
void	setMatchIfScoresTie(boolean bMatchIfScoresTie) Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score.
void	setMinimumCandidateScore(int minimumCandidateScore) Minimum candidate score setting.
void	setMinimumMatchScore(int minimumMatchScore) Minimum match score setting.
void	setSideOffset(double sideOffset) Side offset distance.
void	setSideOffsetUnits(int sideOffsetUnits) Units used for the side offset.
void	setSpellingSensitivity(int spellingSensitivity) Spelling sensitivity setting.
void	setUseRelativePaths(boolean bUseRelativePaths) Indicates if the paths to the reference data should be stored relative to the locator.

Methods inherited from class com.esri.arcgis.location.IAddressInputsProxy

getAddressFields, getDefaultInputFieldNames

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.esri.arcgis.location.IAddressInputs

getAddressFields, getDefaultInputFieldNames

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGeocodingPropertiesProxy

public IGeocodingPropertiesProxy()

IGeocodingPropertiesProxy

public IGeocodingPropertiesProxy(Object obj)
                          throws IOException

Throws:

IOException

IGeocodingPropertiesProxy

protected IGeocodingPropertiesProxy(Object obj,
                                    String iid)
                             throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class IAddressInputsProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class IAddressInputsProxy

Throws:

IOException

getMinimumMatchScore

public int getMinimumMatchScore()
                         throws IOException,
                                AutomationException

Minimum match score setting.

Remarks

The MinimumMatchScore property specifies how well addresses have to match their most likely candidate in the reference data in order to be considered matched. A perfect match yields a score of 100. A match score between 75 and 100 can generally be considered a good match, depending upon the quality of your reference and address data. An address with no candidates with scores euqal to or greater than the minimum match score will not be matched.

The MinimumMatchScore property can have values between 0 and 100. If your application demands that addresses be located with a high level of confidence, you should specify a high value. If you want to maximize the number of addresses that can be matched and don’t mind if some addresses are potentially matched incorrectly, you can use a lower value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumMatchScore in interface IGeocodingProperties

Returns:

The minimumMatchScore

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumMatchScore

public void setMinimumMatchScore(int minimumMatchScore)
                          throws IOException,
                                 AutomationException

Minimum match score setting.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumMatchScore in interface IGeocodingProperties

Parameters:

minimumMatchScore - The minimumMatchScore (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumCandidateScore

public int getMinimumCandidateScore()
                             throws IOException,
                                    AutomationException

Minimum candidate score setting.

Remarks

Locators use the MinimumCandidateScore setting to filter the set of candidates that are returned by the IAddressCandidates::FindAddressCandidates, IAdvancedGeocoding::FindStandardizedAddressCandidates, and IAdvancedIntersectionGeocoding::FindStandardizedIntersectionCandidates methods. Only candidates with a score greater than the minimum candidate score will be returned by these methods.

The minimum candidate score for a locator can have values between 0 and 100. If the Locator is unable to come up with any likely candidates for an address that you want to geocode, you can specify a lower value so that candidates with very low scores are considered.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumCandidateScore in interface IGeocodingProperties

Returns:

The minimumCandidateScore

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumCandidateScore

public void setMinimumCandidateScore(int minimumCandidateScore)
                              throws IOException,
                                     AutomationException

Minimum candidate score setting.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumCandidateScore in interface IGeocodingProperties

Parameters:

minimumCandidateScore - The minimumCandidateScore (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpellingSensitivity

public int getSpellingSensitivity()
                           throws IOException,
                                  AutomationException

Spelling sensitivity setting.

Remarks

The SpellingSensitivity property controls how much variation the locator will allow when it searches for likely candidates in the reference data. A low value for spelling sensitivity will allow “Mane”, “Maine”, and “Man” to be treated as match candidates for “Main”. A higher value will restrict candidates to exact matches. The spelling sensitivity does not affect the match score of each candidate; it only controls how many candidates the locator considers. The locator then computes the match score of each candidate and ranks the candidates by score.

The SpellingSensitivity property can have values between 0 and 100. If you are sure that your addresses are spelled correctly, you can specify a higher value for the SpellingSensitivity. However, if you think that your addresses may contain spelling errors, then you should specify a lower value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpellingSensitivity in interface IGeocodingProperties

Returns:

The spellingSensitivity

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpellingSensitivity

public void setSpellingSensitivity(int spellingSensitivity)
                            throws IOException,
                                   AutomationException

Spelling sensitivity setting.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpellingSensitivity in interface IGeocodingProperties

Parameters:

spellingSensitivity - The spellingSensitivity (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndOffset

public int getEndOffset()
                 throws IOException,
                        AutomationException

End offset percentage.

Remarks

Locators that use polyline features as reference data interpolate positions along reference data features for geocoded addresses. In order to prevent features that are located at the end of a reference data feature from falling on top of other features (for example, a cross street), the locator can apply a “squeeze factor”, or end offset, to the location of a geocoded address.

The EndOffset property specifies by what amount to offset geocoded locations from the end of reference data features, and is expressed as a percentage of the length of the reference feature, between 0 percent and 50 percent. An EndOffset value of 0 will not offset features from the end of the reference feature. An EndOffset value of 50 percent will locate all geocoded addresses at the middle of the reference feature.

Warning: Do not use EndOffset in combination with EndOffsetDistanceUnits from IGeocodingProperties2 because it may produce some unexpected results. Use EndOffsetDistance in combination with EndOffsetDistanceUnits instead.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEndOffset in interface IGeocodingProperties

Returns:

The endOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndOffset

public void setEndOffset(int endOffset)
                  throws IOException,
                         AutomationException

End offset percentage.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEndOffset in interface IGeocodingProperties

Parameters:

endOffset - The endOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSideOffset

public double getSideOffset()
                     throws IOException,
                            AutomationException

Side offset distance.

Remarks

Some locators support geocoding addresses to a particular side of a street. For those locators, you can specify a side offset using the SideOffset property, which specifies how far from the correct side of the street geocoded addresses should be offset. The SideOffsetUnits property specifies the units for the side offset.

You can use these properties to improve the cartographic appearance of your geocoded feature classes. By default, the value of the SideOffsetUnits property is esriUnknownUnits, which indicates to use the reference data’s units.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSideOffset in interface IGeocodingProperties

Returns:

The sideOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSideOffset

public void setSideOffset(double sideOffset)
                   throws IOException,
                          AutomationException

Side offset distance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSideOffset in interface IGeocodingProperties

Parameters:

sideOffset - The sideOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSideOffsetUnits

public int getSideOffsetUnits()
                       throws IOException,
                              AutomationException

Units used for the side offset.

Remarks

Some locators support geocoding addresses to a particular side of a street. For those locators, you can specify a side offset using the SideOffset property, which specifies how far from the correct side of the street geocoded addresses should be offset. The SideOffsetUnits property specifies the units for the side offset.

You can use these properties to improve the cartographic appearance of your geocoded feature classes. By default, the value of the SideOffsetUnits property is esriUnknownUnits, which indicates to use the reference data’s units.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSideOffsetUnits in interface IGeocodingProperties

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSideOffsetUnits

public void setSideOffsetUnits(int sideOffsetUnits)
                        throws IOException,
                               AutomationException

Units used for the side offset.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSideOffsetUnits in interface IGeocodingProperties

Parameters:

sideOffsetUnits - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddXYCoordsToMatchFields

public boolean isAddXYCoordsToMatchFields()
                                   throws IOException,
                                          AutomationException

Indicates if the x and y coordinates of the address location are included in the geocoding result.

Remarks

The AddXYCoordsToMatchFields property indicates if the matches returned by the locator have attributes representing the x and y coordinates of the geocoded locations. If this property has a value of True, then the locator will return two additional attributes for matches — one each for the x and y coordinates of the geocoded features. These attributes will be included in the match fields for the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAddXYCoordsToMatchFields in interface IGeocodingProperties

Returns:

The bAddXYCoordsToMatchFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddXYCoordsToMatchFields

public void setAddXYCoordsToMatchFields(boolean bAddXYCoordsToMatchFields)
                                 throws IOException,
                                        AutomationException

Indicates if the x and y coordinates of the address location are included in the geocoding result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAddXYCoordsToMatchFields in interface IGeocodingProperties

Parameters:

bAddXYCoordsToMatchFields - The bAddXYCoordsToMatchFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddStandardizeStringToMatchFields

public boolean isAddStandardizeStringToMatchFields()
                                            throws IOException,
                                                   AutomationException

Indicates if the standardized address is included in the geocoding result.

Remarks

The AddStandardizeStringToMatchFields property indicates if the matches returned by the locator have an attribute containing a string representing the standardization of the address. The standardization string is a string with each component of the standardized address separated by pipe ("|") characters. If this property has a value of True, then this attribute will be included in the match fields for the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAddStandardizeStringToMatchFields in interface IGeocodingProperties

Returns:

The bAddStandardizeStringToMatchFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddStandardizeStringToMatchFields

public void setAddStandardizeStringToMatchFields(boolean bAddStandardizeStringToMatchFields)
                                          throws IOException,
                                                 AutomationException

Indicates if the standardized address is included in the geocoding result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAddStandardizeStringToMatchFields in interface IGeocodingProperties

Parameters:

bAddStandardizeStringToMatchFields - The bAddStandardizeStringToMatchFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddReferenceIDToMatchFields

public boolean isAddReferenceIDToMatchFields()
                                      throws IOException,
                                             AutomationException

Indicates if the feature ID of the matched feature is included in the geocoding result.

Remarks

The AddReferenceIDToMatchFields property indicates if the matches returned by the locator have an attribute containing the FeatureID of the reference data feature to which the address was matched. If this property has a value of True, then this attribute will be included in the match fields for the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAddReferenceIDToMatchFields in interface IGeocodingProperties

Returns:

The bAddReferenceIDToMatchFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddReferenceIDToMatchFields

public void setAddReferenceIDToMatchFields(boolean bAddReferenceIDToMatchFields)
                                    throws IOException,
                                           AutomationException

Indicates if the feature ID of the matched feature is included in the geocoding result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAddReferenceIDToMatchFields in interface IGeocodingProperties

Parameters:

bAddReferenceIDToMatchFields - The bAddReferenceIDToMatchFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddPercentAlongToMatchFields

public boolean isAddPercentAlongToMatchFields()
                                       throws IOException,
                                              AutomationException

Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result.

Remarks

For locators that interpolate geocoded locations along polyline reference data features, the AddPercentAlongToMatchFields property indicates if the matches returned by the locator have an attribute containing the percentage along the reference data feature at which the address was located, with values between 0 and 100. If this property has a value of True, then this attribute will be included in the match fields for the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAddPercentAlongToMatchFields in interface IGeocodingProperties

Returns:

The bAddPercentAlongToMatchFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddPercentAlongToMatchFields

public void setAddPercentAlongToMatchFields(boolean bAddPercentAlongToMatchFields)
                                     throws IOException,
                                            AutomationException

Indicates if the percentage along the reference feature at which the address is located is included in the geocoding result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAddPercentAlongToMatchFields in interface IGeocodingProperties

Parameters:

bAddPercentAlongToMatchFields - The bAddPercentAlongToMatchFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMatchIfScoresTie

public boolean isMatchIfScoresTie()
                           throws IOException,
                                  AutomationException

Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score.

Remarks

If the locator finds two or more candidates with the same best candidate score, and that score is greater than the minimum match score, then you can use the MatchIfCandidatesTie property to specify whether or not the locator should arbitrarily match the address to one of those candidates. If so, the locator will match the address to the first of these candidates that
it encounters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isMatchIfScoresTie in interface IGeocodingProperties

Returns:

The bMatchIfScoresTie

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMatchIfScoresTie

public void setMatchIfScoresTie(boolean bMatchIfScoresTie)
                         throws IOException,
                                AutomationException

Indicates whether addresses should be arbitrarily matched to a feature when two or more features have the same best score.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMatchIfScoresTie in interface IGeocodingProperties

Parameters:

bMatchIfScoresTie - The bMatchIfScoresTie (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultInputFieldNames

public void setDefaultInputFieldNames(String addressField,
                                      Object rhs2)
                               throws IOException,
                                      AutomationException

Recognized names for a required input field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDefaultInputFieldNames in interface IGeocodingProperties

Parameters:

addressField - The addressField (in)

rhs2 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIntersectionConnectors

public String getIntersectionConnectors()
                                 throws IOException,
                                        AutomationException

Connector strings used to designate intersections.

Remarks

The IntersectionConnectors property lets you specify strings that are used to delimit intersection addresses. Some address locators can geocode intersection addresses such as "New York St. & W. Redlands Blvd.". This property is a string containing all of the strings that can be used to delimit intersections (such as "&", "AND", or "AT"). Each intersection connector is separated by a space in this string.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIntersectionConnectors in interface IGeocodingProperties

Returns:

The intersectionConnectors

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIntersectionConnectors

public void setIntersectionConnectors(String intersectionConnectors)
                               throws IOException,
                                      AutomationException

Connector strings used to designate intersections.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIntersectionConnectors in interface IGeocodingProperties

Parameters:

intersectionConnectors - The intersectionConnectors (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseRelativePaths

public boolean isUseRelativePaths()
                           throws IOException,
                                  AutomationException

Indicates if the paths to the reference data should be stored relative to the locator.

Remarks

The UseRelativePaths property indicates if the locator stores paths to reference data sources as relative path names. Storing paths to reference data sources as relative paths names allows users to copy a locator and its reference data between folders in ArcCatalog without invalidating the locator. It also allows users to access the same locator from a shared network directory.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseRelativePaths in interface IGeocodingProperties

Returns:

The bUseRelativePaths

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseRelativePaths

public void setUseRelativePaths(boolean bUseRelativePaths)
                         throws IOException,
                                AutomationException

Indicates if the paths to the reference data should be stored relative to the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUseRelativePaths in interface IGeocodingProperties

Parameters:

bUseRelativePaths - The bUseRelativePaths (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.