|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.location.GeocodeServer
public class GeocodeServer
COM Class 'GeocodeServer'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriLocation.olb'
Description 'A class that provides geocoding as a service.' 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 |
|---|
| Fields inherited from interface com.esri.arcgis.system.IRequestHandler2 |
|---|
IID, IID8319e7d0_8ad1_48ed_aa99_03f9d0c93ba8, xxDummy |
| Fields inherited from interface com.esri.arcgis.system.IRequestHandler |
|---|
IID46a0e2ea_3b64_4a46_bd78_88a1660f35bb |
| Fields inherited from interface com.esri.arcgis.location.IGeocodeServer |
|---|
IID, IID5918bc71_27dc_41d7_8282_a0871a612923, xxDummy |
| Fields inherited from interface com.esri.arcgis.location.IGeocodeServerObjects |
|---|
IID, IID2783ad51_2715_472d_9e1b_3ec780c732d3, xxDummy |
| Fields inherited from interface com.esri.arcgis.location.IGeocodeServerSingleLine |
|---|
IID, IID8986d461_8861_41cf_8a97_27d6c244d411, xxDummy |
| Fields inherited from interface com.esri.arcgis.location.IInitGeocodeServer |
|---|
IID, IID56480f27_f591_4140_a471_93782cffa59e, xxDummy |
| Fields inherited from interface com.esri.arcgis.server.IServerObject |
|---|
IID, IID0ad6ab40_9d6a_4bf8_8b86_eb89406dfc6c, xxDummy |
| Fields inherited from interface com.esri.arcgis.server.IServerObjectExtensionManager |
|---|
IID, IID25d8b9dd_c7e8_4da4_bf4b_08a67087ceea, xxDummy |
| Fields inherited from interface com.esri.arcgis.system.IRESTRequestHandler |
|---|
IID, IID9d66a418_d54a_48ed_88bd_043a25fa9c83, xxDummy |
| Constructor Summary | |
|---|---|
GeocodeServer()
Constructs a GeocodeServer using ArcGIS Engine. |
|
GeocodeServer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. GeocodeServer theGeocodeServer = (GeocodeServer) obj; |
|
| Method Summary | |
|---|---|
void |
attachToLocator(ILocatorName locName)
Attach this service to the locator specified by the locator name. |
void |
construct(IPropertySet props)
Two phase object construction. |
boolean |
equals(java.lang.Object o)
Compare this object with another |
IRecordSet |
findAddressCandidates(IPropertySet address,
IPropertySet propMods)
Generates candidates for an address (normal or standardized form). |
IServerObjectExtension |
findExtensionByCLSID(java.lang.String cLSID)
Returns a server object extension found using a string representation of its class ID. |
IServerObjectExtension |
findExtensionByTypeName(java.lang.String name)
Returns a server object extension found using its type name. |
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. |
ILocator |
getAddressLocator()
The address locator used by the geocode server. |
java.lang.String |
getAdjustableProperties()
The list of properties (comma delimited) that can be modified at runtime (for a given method). |
IFields |
getCandidateFields(IPropertySet propMods)
Fields contained in a list of candidates. |
static java.lang.String |
getClsid()
getClsid. |
java.lang.String |
getConfigurationName()
Name of the server object configuration that defines the server object. |
IPropertySet |
getDefaultInputFieldMapping()
Suggested field name mappings for all input fields. |
java.lang.Object |
getDefaultInputFieldNames()
Recognized names for the single line input field. |
IFields |
getIntersectionCandidateFields(IPropertySet propMods)
Fields contained by intersection candidates. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
IPropertySet |
getLocatorProperties()
Default properties for a locator. |
IFields |
getResultFields(IPropertySet propMods)
Fields contained in the geocoding result. |
java.lang.String |
getSchema()
This method returns the resource hierarchy of a REST based SOE. |
IField |
getSingleLineAddressField()
Field needed to geocode a single line address. |
IFields |
getStandardizedFields()
Fields contained in a standardized address. |
IFields |
getStandardizedIntersectionFields()
Fields contained in a standardized intersection. |
int |
getSuggestedBatchSize()
The suggested number of addresses to send to a server in one batch request. |
java.lang.String |
getTypeName()
Type of the server object (MapServer or GeocodeServer). |
byte[] |
handleBinaryRequest(byte[] request)
Handles a binary request. |
byte[] |
handleBinaryRequest2(java.lang.String capabilities,
byte[] request)
Handles a binary request with explicit capabilities. |
byte[] |
handleRESTRequest(java.lang.String capabilities,
java.lang.String resourceName,
java.lang.String operationName,
java.lang.String operationInput,
java.lang.String outputFormat,
java.lang.String requestProperties,
java.lang.String[] responseProperties)
Handles REST requests for SOE. |
java.lang.String |
handleStringRequest(java.lang.String capabilities,
java.lang.String request)
Handles a SOAP string request. |
int |
hashCode()
the hashcode for this object |
void |
release()
Release a GeocodeServer. |
IPropertySet |
reverseGeocode(IPoint location,
boolean bReturnIntersection,
IPropertySet propMods)
Generates an address for a point. |
void |
setAdjustableProperties(java.lang.String propertyList)
The list of properties (comma delimited) that can be modified at runtime (for a given method). |
void |
setSuggestedBatchSize(int size)
The suggested number of addresses to send to a server in one batch request. |
IPropertySet |
standardizeAddress(IPropertySet address,
IPropertySet propMods)
Standardizes an address. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public GeocodeServer()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public GeocodeServer(java.lang.Object obj)
throws java.io.IOException
GeocodeServer theGeocodeServer = (GeocodeServer) obj;
obj to GeocodeServer.
obj - an object returned from ArcGIS Engine or Server
java.io.IOException - if there are interop problems| Method Detail |
|---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRefpublic void release()
release in interface com.esri.arcgis.interop.RemoteObjRef
public void construct(IPropertySet props)
throws java.io.IOException,
AutomationException
construct in interface IObjectConstructprops - A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public byte[] handleBinaryRequest(byte[] request)
throws java.io.IOException,
AutomationException
handleBinaryRequest in interface IRequestHandlerrequest - An unsigned byte (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String handleStringRequest(java.lang.String capabilities,
java.lang.String request)
throws java.io.IOException,
AutomationException
handleStringRequest in interface IRequestHandlercapabilities - The capabilities (in)request - The request (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public byte[] handleBinaryRequest2(java.lang.String capabilities,
byte[] request)
throws java.io.IOException,
AutomationException
handleBinaryRequest2 in interface IRequestHandler2capabilities - The capabilities (in)request - An unsigned byte (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet geocodeAddress(IPropertySet address,
IPropertySet propMods)
throws java.io.IOException,
AutomationException
geocodeAddress in interface IGeocodeServeraddress - A reference to a com.esri.arcgis.system.IPropertySet (in)propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRecordSet geocodeAddresses(IRecordSet addressTable,
IPropertySet addressFieldMapping,
IPropertySet propMods)
throws java.io.IOException,
AutomationException
geocodeAddresses in interface IGeocodeServeraddressTable - 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet standardizeAddress(IPropertySet address,
IPropertySet propMods)
throws java.io.IOException,
AutomationException
standardizeAddress in interface IGeocodeServeraddress - A reference to a com.esri.arcgis.system.IPropertySet (in)propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRecordSet findAddressCandidates(IPropertySet address,
IPropertySet propMods)
throws java.io.IOException,
AutomationException
findAddressCandidates in interface IGeocodeServeraddress - A reference to a com.esri.arcgis.system.IPropertySet (in)propMods - A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getAddressFields()
throws java.io.IOException,
AutomationException
getAddressFields in interface IGeocodeServerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getCandidateFields(IPropertySet propMods)
throws java.io.IOException,
AutomationException
getCandidateFields in interface IGeocodeServerpropMods - A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getIntersectionCandidateFields(IPropertySet propMods)
throws java.io.IOException,
AutomationException
getIntersectionCandidateFields in interface IGeocodeServerpropMods - A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getStandardizedFields()
throws java.io.IOException,
AutomationException
getStandardizedFields in interface IGeocodeServerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getStandardizedIntersectionFields()
throws java.io.IOException,
AutomationException
getStandardizedIntersectionFields in interface IGeocodeServerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFields getResultFields(IPropertySet propMods)
throws java.io.IOException,
AutomationException
getResultFields in interface IGeocodeServerpropMods - A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getDefaultInputFieldMapping()
throws java.io.IOException,
AutomationException
getDefaultInputFieldMapping in interface IGeocodeServerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getLocatorProperties()
throws java.io.IOException,
AutomationException
getLocatorProperties in interface IGeocodeServerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet reverseGeocode(IPoint location,
boolean bReturnIntersection,
IPropertySet propMods)
throws java.io.IOException,
AutomationException
reverseGeocode in interface IGeocodeServerlocation - 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)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILocator getAddressLocator()
throws java.io.IOException,
AutomationException
getAddressLocator in interface IGeocodeServerObjectsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IField getSingleLineAddressField()
throws java.io.IOException,
AutomationException
getSingleLineAddressField in interface IGeocodeServerSingleLinejava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.Object getDefaultInputFieldNames()
throws java.io.IOException,
AutomationException
getDefaultInputFieldNames in interface IGeocodeServerSingleLinejava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void attachToLocator(ILocatorName locName)
throws java.io.IOException,
AutomationException
attachToLocator in interface IInitGeocodeServerlocName - A reference to a com.esri.arcgis.geodatabase.ILocatorName (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getAdjustableProperties()
throws java.io.IOException,
AutomationException
getAdjustableProperties in interface IInitGeocodeServerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setAdjustableProperties(java.lang.String propertyList)
throws java.io.IOException,
AutomationException
setAdjustableProperties in interface IInitGeocodeServerpropertyList - The propertyList (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSuggestedBatchSize()
throws java.io.IOException,
AutomationException
getSuggestedBatchSize in interface IInitGeocodeServerjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSuggestedBatchSize(int size)
throws java.io.IOException,
AutomationException
setSuggestedBatchSize in interface IInitGeocodeServersize - The size (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getConfigurationName()
throws java.io.IOException,
AutomationException
getConfigurationName in interface IServerObjectjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getTypeName()
throws java.io.IOException,
AutomationException
getTypeName in interface IServerObjectjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IServerObjectExtension findExtensionByCLSID(java.lang.String cLSID)
throws java.io.IOException,
AutomationException
findExtensionByCLSID in interface IServerObjectExtensionManagercLSID - The cLSID (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IServerObjectExtension findExtensionByTypeName(java.lang.String name)
throws java.io.IOException,
AutomationException
findExtensionByTypeName in interface IServerObjectExtensionManagername - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public byte[] handleRESTRequest(java.lang.String capabilities,
java.lang.String resourceName,
java.lang.String operationName,
java.lang.String operationInput,
java.lang.String outputFormat,
java.lang.String requestProperties,
java.lang.String[] responseProperties)
throws java.io.IOException,
AutomationException
This method is invoked by ArcGIS Server's REST handler, which intercepts client's request (in URL form), parses it and passes it on to this method in form of parameter values.
The REST SOE developer must add logic to use these parameter values to determine which resource/operation is being requested and accordingly handle these requests and generate responses in the output format indicated by the "outputFormat" parameter. For more information on developing REST SOEs, please consult the Java ArcObjects Developer Guide.
Developer doc: Developing extensions > Server Object Extensions > SOE Web Services > REST Web Services > Developing SOE REST Web Services
Samples: Samples > Server Object Extensions section
handleRESTRequest in interface IRESTRequestHandlercapabilities - The capabilities supported by the SOE. An admin can choose which
capabilities are enabled on a particular SOE (in ArcGIS Manager or ArcCatalog), based on certain criteria such as security roles.
This list of allowed capabilities is then sent to this method, at runtime, as a comma separated list. (in)resourceName - Name of the resource being addressed. If empty, its assumed
that root resource is being addressed. (in)operationName - Name of the operation being invoked. If empty, description of
resource is returned. (in)operationInput - Input parameters, in form of comma separated list, to the operation specified by operationName parameter. (in)outputFormat - OutputFormat of operation. Possible formats are JSON, HTML, AMF, etc. (in)requestProperties - The requestProperties (in)responseProperties - The responseProperties (out)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getSchema()
throws java.io.IOException,
AutomationException
For an SOE that has a root resource (called "root") with one operation ("operation0"), and 2 sub-resources with one operation each ("operation1" and "operation2" respectively), the schema would look like:
{
"name": "MyRESTSOE",
"description": "My REST SOE with 3 resources and 1 operation each.",
"isCollection": false,
"operations": [
{
"name": "operation0",
"parameters": ["param01"],
"supportedOutputFormats": ["json"]
}
],
"resources": [
{
"name": "subresource1",
"description": "Sub Resource 1",
"isCollection": true,
"operations": [
{
"name": "operation1",
"parameters": ["param10", "param11"],
"supportedOutputFormats": ["json"]
}
]
},
{
"name": "subresource2",
"description": "Sub Resource 2",
"isCollection": true,
"operations": [
{
"name": "operation2",
"parameters": ["param20", "param21"],
"supportedOutputFormats": ["json"]
}
]
}
]
}
getSchema in interface IRESTRequestHandlerjava.io.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 | ||||||||