|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.location.AGSLocatorWorkspace
public class AGSLocatorWorkspace
A locator workspace that exposes geocoding services from an ArcGIS Server.
An AGSLocatorWorkspace is a read-only locator workspace that contains locators representing GeocodeServer objects served by an ArcGIS Server. Because it is a read-only locator workspace, developers cannot modify the set of locators in an AGSLocatorWorkspace using the ILocatorWorkspace interface.
AGSLocatorWorkspaces contain locators but do not contain locator styles.
IEnumServerObjectType
,
AGSLocatorWorkspace
,
IEnumServerObjectTypeInfo
,
GeocodeServer
,
ILocatorManager2.getAGSLocatorWorkspace(com.esri.arcgis.gisclient.IAGSServerConnectionName)
,
ServerObject
,
ILocatorWorkspaceName2.getAGSServerConnectionName()
,
AGSAddressLocator
,
Serialized FormConstructor Summary | |
---|---|
AGSLocatorWorkspace(Object obj)
Construct a AGSLocatorWorkspace using a reference to such an object returned from ArcGIS Engine or Server. |
Method Summary | |
---|---|
ILocator |
addLocator(String name,
ILocator locator,
String configKeyword,
ITrackCancel cancelTracker)
Adds a locator to the locator workspace. |
void |
addLocatorStyle(String name,
String category,
ILocatorStyle locatorStyle)
Adds a locator style. |
void |
attachLocator(ILocator locator,
ITable attachToTable,
ITable inputTable,
String inputFieldNames,
String inputJoinFieldName,
ITable outputTable,
String outputFieldNames,
String outputJoinFieldName)
Attaches a locator to a table. |
void |
attachLocator(ILocator locator,
ITable attachToTable,
String inputFieldNames,
String outputFieldNames)
Attaches a locator to a table (simple function). |
void |
copyLocator(String srcName,
String dstName)
Copies a locator. |
void |
deleteLocator(String name)
Deletes a locator. |
boolean |
equals(Object o)
Compare this object with another |
IAGSServerConnectionName |
getAGSServerConnection()
The ArcGIS server connection that contains the locator workspace. |
ILocator |
getLocator(String name)
Gets a locator. |
ILocatorName |
getLocatorName(String name)
Gets a LocatorName object. |
IEnumLocatorName |
getLocatorNames(int queryType,
String category)
LocatorName objects in the locator workspace. |
IEnumLocator |
getLocators(int queryType,
String category)
Locators in the locator workspace. |
ILocatorStyle |
getLocatorStyle(String name)
Gets a locator style. |
ILocatorWorkspaceName |
getName()
The Name object for the locator workspace. |
int |
hashCode()
the hashcode for this object |
void |
interfaceSupportsErrorInfo(GUID riid)
interfaceSupportsErrorInfo |
void |
renameLocator(String oldName,
String newName)
Renames a locator. |
void |
updateLocator(ILocator locator)
Modifies the properties of a locator. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public AGSLocatorWorkspace(Object obj) throws IOException
obj
to AGSLocatorWorkspace
. *
AGSLocatorWorkspace o = (AGSLocatorWorkspace)obj; // will not work
AGSLocatorWorkspace o = new AGSLocatorWorkspace(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server
IOException
- if there are interop problems
AGSLocatorWorkspace theAGSLocatorWorkspace = (AGSLocatorWorkspace) obj;
Method Detail |
---|
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public ILocatorWorkspaceName getName() throws IOException, AutomationException
The Name property returns a reference to a LocatorWorkspaceName object that represents the locator workspace.
getName
in interface ILocatorWorkspace
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorWorkspace.getName()
public IEnumLocatorName getLocatorNames(int queryType, String category) throws IOException, AutomationException
getLocatorNames
in interface ILocatorWorkspace
queryType
- A com.esri.arcgis.geodatabase.esriLocatorQuery constant (in)category
- The category (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumLocator getLocators(int queryType, String category) throws IOException, AutomationException
getLocators
in interface ILocatorWorkspace
queryType
- A com.esri.arcgis.geodatabase.esriLocatorQuery constant (in)category
- The category (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILocatorName getLocatorName(String name) throws IOException, AutomationException
The GetLocatorName method retrieves a LocatorName object from a locator workspace.
The Name parameter is the name of the locator that you want to retrieve from the locator workspace.
In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator". When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.
getLocatorName
in interface ILocatorWorkspace
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorName
,
LocatorName
,
ILocatorWorkspace.getLocatorName(String)
public ILocator getLocator(String name) throws IOException, AutomationException
The GetLocator method retrieves a locator from a locator workspace.
The Name parameter is the name of the locator that you want to retrieve from the locator workspace.
Within the default local locator workspace, and within ArcSDE locator workspaces, locator names are prefixed by a user name, as in "jack.My Locator". In local locator workspaces, the locator name is prefixed by the user name of the current user. In ArcSDE workspaces, the locator name is prefixed by the name of the ArcSDE user that owns the locator. When you call methods in ArcObjects that have parameters that specify locators in a locator workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.
getLocator
in interface ILocatorWorkspace
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorWorkspace.updateLocator(com.esri.arcgis.geodatabase.ILocator)
,
StreetMapAddressLocatorStyle
,
com.esri.arcgis.locationui.GxLocator
,
ESRIFDOAddressLocatorStyle
,
ILocatorWorkspace.getLocator(String)
,
ILocator
,
ESRIFDOAddressLocator
,
StreetMapAddressLocator
,
com.esri.arcgis.locationui.LocatorExtension
,
com.esri.arcgis.catalogUI.IGxLocator
public ILocatorStyle getLocatorStyle(String name) throws IOException, AutomationException
The GetLocatorStyle method retrieves a locator style from a locator workspace.
The Name parameter is the name of the locator style that you want to retrieve from the locator workspace.
Within ArcSDE locator workspaces, locator style names are prefixed by the name of the SDE user that owns the locator style (usually the default SDE user), as in "SDE.US Streets with Zone". You must specify the SDE user as a part of the Name parameter when calling the GetLocatorStyle method on an ArcSDE locator workspace.
getLocatorStyle
in interface ILocatorWorkspace
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorStyle
,
StreetMapAddressLocatorStyle
,
ESRIFDOAddressLocatorStyle
,
com.esri.arcgis.locationui.IGxNewLocator
,
ILocatorWorkspace.getLocatorStyle(String)
public ILocator addLocator(String name, ILocator locator, String configKeyword, ITrackCancel cancelTracker) throws IOException, AutomationException
The AddLocator method adds the specified locator to the locator workspace with the specified name.
In general, when creating a locator, you will first retrieve a locator style from the locator workspace, set the properties on the locator style, then use the AddLocator method to create a new locator.
The Name parameter specifies the name for the new locator.
The Locator parameter is a reference to the locator that you want to add to the locator workspace.
The ConfigKeyword parameter is used to specify the ArcSDE storage keyword used to create the reference data indexes for the new locator. This parameter is only used if the locator workspace is in an ArcSDE database. Using a configuration keyword specifies certain parameters for storing tables to the ArcSDE database, and the proper configuration can improve the performance of your locators. For more information on ArcSDE configuration keywords, refer to the ArcSDE Configuration and Tuning Guide for your relational database management system (RDBMS). To use the default storage keyword for the ArcSDE database, specify a blank string for this parameter.
ICancelTracker is an optional parameter that you can use to specify a CancelTracker object that is used to display the reference data index building progress and allows the user to cancel the process.
addLocator
in interface ILocatorWorkspace
name
- The name (in)locator
- A reference to a com.esri.arcgis.geodatabase.ILocator (in)configKeyword
- The configKeyword (in)cancelTracker
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorWorkspace.addLocator(String, com.esri.arcgis.geodatabase.ILocator, String, com.esri.arcgis.system.ITrackCancel)
,
ILocatorWorkspace.deleteLocator(String)
,
ILocatorWorkspace.copyLocator(String, String)
public void addLocatorStyle(String name, String category, ILocatorStyle locatorStyle) throws IOException, AutomationException
The AddLocatorStyle method adds the specified locator style to the locator workspace.
Note: This method is deprecated in versions of ArcGIS later than 9.3.1.
In general, you will only use this method if you have created your own custom locator style and want to copy it from one locator workspace to another.
The Name parameter specifies the name for the new locator style.
The Category parameter is used to specify the category of the new locator style. Address locator styles provided with ArcGIS all have a category of "Address".
The LocatorStyle parameter is a reference to the locator style to add to the locator workspace.
addLocatorStyle
in interface ILocatorWorkspace
name
- The name (in)category
- The category (in)locatorStyle
- A reference to a com.esri.arcgis.geodatabase.ILocatorStyle (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorWorkspace.addLocatorStyle(String, String, com.esri.arcgis.geodatabase.ILocatorStyle)
public void updateLocator(ILocator locator) throws IOException, AutomationException
To update a locator or locator style, first get the locator or locator style from the locator workspace using one of the members of the ILocatorWorkspace interface. Modify the properties of the locator or locator style, then update the locator or locator style using this method.
updateLocator
in interface ILocatorWorkspace
locator
- A reference to a com.esri.arcgis.geodatabase.ILocator (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorWorkspace.updateLocator(com.esri.arcgis.geodatabase.ILocator)
,
StreetMapAddressLocatorStyle
,
com.esri.arcgis.locationui.GxLocator
,
ESRIFDOAddressLocatorStyle
,
ILocatorWorkspace.getLocator(String)
,
ILocator
,
ESRIFDOAddressLocator
,
StreetMapAddressLocator
,
com.esri.arcgis.locationui.LocatorExtension
,
com.esri.arcgis.catalogUI.IGxLocator
public void deleteLocator(String name) throws IOException, AutomationException
The DeleteLocator method deletes a locator or locator style from a locator workspace.
The Name parameter is the name of the locator or locator style that you want to remove from the locator workspace.
In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator". When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.
deleteLocator
in interface ILocatorWorkspace
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorWorkspace.addLocator(String, com.esri.arcgis.geodatabase.ILocator, String, com.esri.arcgis.system.ITrackCancel)
,
ILocatorWorkspace.deleteLocator(String)
,
ILocatorWorkspace.copyLocator(String, String)
public void renameLocator(String oldName, String newName) throws IOException, AutomationException
The oldName parameter is the current name of the locator or locator style that you want to rename. The newName parameter is the new name for the locator or locator style.
In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator". When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error. You must fully-qualify the oldName parameter with a user name. Do not qualify the newName parameter with a user name; the locator workspace will add the user name automatically.
renameLocator
in interface ILocatorWorkspace
oldName
- The oldName (in)newName
- The newName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorWorkspace.updateLocator(com.esri.arcgis.geodatabase.ILocator)
,
ILocatorStyle
,
com.esri.arcgis.locationui.GxLocatorFolder
,
StreetMapAddressLocatorStyle
,
com.esri.arcgis.locationui.GxLocator
,
ESRIFDOAddressLocatorStyle
,
ILocatorWorkspace.getLocator(String)
,
ILocator
,
ESRIFDOAddressLocator
,
ILocalLocatorWorkspace
,
StreetMapAddressLocator
,
com.esri.arcgis.locationui.GxGeocodingServiceExtension
,
com.esri.arcgis.locationui.LocatorExtension
,
com.esri.arcgis.locationui.IGxLocatorFolder
,
com.esri.arcgis.locationui.GxLocatorFactory
,
com.esri.arcgis.locationui.IGxNewLocator
,
ILocalLocatorWorkspace.getPath()
,
ILocatorManager.getLocatorWorkspace(com.esri.arcgis.geodatabase.IWorkspace)
,
ILocatorWorkspace.getLocatorStyle(String)
,
com.esri.arcgis.catalogUI.IGxLocator
public void copyLocator(String srcName, String dstName) throws IOException, AutomationException
The CopyLocator method creates a copy of the specified locator in the same locator workspace.
The srcName parameter is the name of the locator that you want to copy. The dstName parameter is the name for the copy of the locator.
In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator". When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.
copyLocator
in interface ILocatorWorkspace
srcName
- The srcName (in)dstName
- The dstName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorWorkspace.addLocator(String, com.esri.arcgis.geodatabase.ILocator, String, com.esri.arcgis.system.ITrackCancel)
,
ILocatorWorkspace.deleteLocator(String)
,
ILocatorWorkspace.copyLocator(String, String)
public IAGSServerConnectionName getAGSServerConnection() throws IOException, AutomationException
getAGSServerConnection
in interface IAGSLocatorWorkspace
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void attachLocator(ILocator locator, ITable attachToTable, ITable inputTable, String inputFieldNames, String inputJoinFieldName, ITable outputTable, String outputFieldNames, String outputJoinFieldName) throws IOException, AutomationException
The AttachLocator method attaches a locator to a dataset. After creating a dataset using a locator, you should attach the locator to the dataset so that it can be rematched.
The Locator parameter specifies the locator that you want to attach to the dataset. Usually, this is the locator that you used to create the dataset.
The attachToTable parameter specifies the dataset to which you want to attach the locator.
The InputTable parameter specifies the dataset that contains the input attributes required by the locator. When you locate a table, you should copy the input attributes to the output dataset, and this property should then refer to the located dataset.
The InputFieldNames parameter is a comma-delimited string that specifies the names of the fields in InputTable that contain the input attributes required by the locator.
Use the InputJoinFieldName parameter to specify the attribute in InputTable that relates records in the input table to records in the located dataset. Normally, you will use the name of the ObjectID attribute in the located dataset for this parameter.
The OutputFieldNames parameter is a comma-delimited string that specifies the names of the fields in the located dataset that contain the match attributes generated by the locator. If the locator supports the IAddressGeocoding interface, you can use the MatchFields property to determine which fields contain the match attributes.
Use the OutputJoinFieldName parameter to specify the attribute in the located dataset that relates records in the located dataset to records in InputTable. Normally, you will use the name of the ObjectID attribute in the located dataset for this parameter.
The OutputTable parameter specifies the dataset that contains the result fields created by the address locator. Typically, this is the geocoded feature class, and is the dataset to which you are attaching the locator.
attachLocator
in interface ILocatorAttach
locator
- A reference to a com.esri.arcgis.geodatabase.ILocator (in)attachToTable
- A reference to a com.esri.arcgis.geodatabase.ITable (in)inputTable
- A reference to a com.esri.arcgis.geodatabase.ITable (in)inputFieldNames
- The inputFieldNames (in)inputJoinFieldName
- The inputJoinFieldName (in)outputTable
- A reference to a com.esri.arcgis.geodatabase.ITable (in)outputFieldNames
- The outputFieldNames (in)outputJoinFieldName
- The outputJoinFieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void attachLocator(ILocator locator, ITable attachToTable, String inputFieldNames, String outputFieldNames) throws IOException, AutomationException
The AttachLocator method attaches a copy of a locator to a dataset. This is generally done after geocoding a table of addresses to a feature class. A copy of the locator that was used to geocode the table of addresses is then attached to the geocoded feature class so that the geocoded feature class can be rematched at a later time.
The Locator parameter is the locator of which a copy will be attached to the dataset specified by the attachToTable parameter. Generally, the attachToTable parameter is a reference to a geocoded feature class, and the Locator parameter is a reference to the locator that was used to create it.
The InputFieldNames parameter is a comma-delimited list of the fields in the dataset represented by the attachToTable parameter that map to the input fields used by the locator. The OutputFieldNames parameter is a comma-delimited list of the fields in the dataset represented by the attachToTable parameter that contain the match attributes generated by the locator. Use the IAddressGeocoding::MatchFields property to determine which match attributes the locator generates.
To retrieve an attached locator from a dataset, use the ILocatorManager::GetLocatorFromDataset method.
attachLocator
in interface ILocatorAttach2
locator
- A reference to a com.esri.arcgis.geodatabase.ILocator (in)attachToTable
- A reference to a com.esri.arcgis.geodatabase.ITable (in)inputFieldNames
- The inputFieldNames (in)outputFieldNames
- The outputFieldNames (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IAddressGeocoding.matchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, com.esri.arcgis.system.IPropertySet, com.esri.arcgis.system.ITrackCancel)
,
AttachedLocator
,
ILocatorAttach2
,
IAttachedLocator
,
ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName)
,
ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset)
,
ILocatorAttach2.attachLocator(com.esri.arcgis.geodatabase.ILocator, com.esri.arcgis.geodatabase.ITable, String, String)
public void interfaceSupportsErrorInfo(GUID riid) throws IOException, AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |