|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.networkanalyst.NALocator
public class NALocator
COM Class 'NALocator'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'
Description 'Finds network locations for analysis.' 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 long |
serialVersionUID
|
| Fields inherited from interface com.esri.arcgis.networkanalyst.INALocator3 |
|---|
IID, IIDb8fa76f8_a6b2_489f_9b2d_c055ac351255, xxDummy |
| Fields inherited from interface com.esri.arcgis.networkanalyst.INALocator2 |
|---|
IID6a658ec8_139d_4b60_8765_c2504cd38d1a |
| Fields inherited from interface com.esri.arcgis.networkanalyst.INALocator |
|---|
IIDeca487a0_fce8_462c_8df2_37042db4591c |
| Fields inherited from interface com.esri.arcgis.system.IPersistStream |
|---|
IID, IID00000109_0000_0000_c000_000000000046, xxDummy |
| Fields inherited from interface com.esri.arcgis.system.IPersist |
|---|
IID0000010c_0000_0000_c000_000000000046 |
| Fields inherited from interface com.esri.arcgis.system.IClone |
|---|
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy |
| Fields inherited from interface com.esri.arcgis.system.IXMLSerialize |
|---|
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy |
| Constructor Summary | |
|---|---|
NALocator()
Constructs a NALocator using ArcGIS Engine. |
|
NALocator(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. NALocator theNALocator = (NALocator) obj; |
|
| Method Summary | |
|---|---|
void |
addLocatorAgent(INALocatorAgent locatorAgent)
Add a locator agent. |
void |
assign(IClone src)
Assigns the properties of src to the receiver. |
void |
bind(INetworkDataset pNetworkDataset,
IGPMessages pGPMessages)
Re-associate the locators with the given network dataset and its schema. |
void |
cacheRestrictedElements(INAContext context)
The locator will examine the NAContext and its associated NASolver to build a cache of network elements that cannot be located on due to restrictions, barriers, etc. |
void |
createDefault(IDENetworkDataset network)
Make the default locators. |
void |
deserialize(IXMLSerializeData data)
Deserializes an object from XML. |
boolean |
equals(java.lang.Object o)
Compare this object with another |
IClone |
esri_clone()
Clones the receiver and assigns the result to *clone. |
INALocation |
geocodeLocation(java.lang.String address,
ILocator addressLocator)
The network location at the specified address. |
void |
getClassID(GUID[] pClassID)
getClassID |
static java.lang.String |
getClsid()
getClsid. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
INALocatorAgent |
getLocatorAgent(int index)
The locator agent by index. |
int |
getLocatorAgentCount()
The number of locator agents added. |
double |
getMaxSnapTolerance()
The maximum distance that can be searched when expanding the snap tolerance. |
INetworkDataset |
getNetworkDataset()
The associated network dataset. |
ISpatialReference |
getOutputSpatialReference()
The spatial reference for points returned by the locator. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
double |
getSnapTolerance()
The distance to search. |
int |
getSnapToleranceUnits()
The units of the snap tolerance. |
int |
hashCode()
the hashcode for this object |
void |
isDirty()
isDirty |
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties. |
boolean |
isExcludeRestrictedElements()
Indicates whether to exclude restricted portions of the network when locating points. |
boolean |
isFindClosestAmongAllAgents()
Indicates if the closest location (only) should be returned. |
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object. |
void |
load(IStream pstm)
load |
void |
queryLocationByPoint(IPoint point,
INALocation[] location,
IPoint[] outPoint,
double[] distanceFromPoint)
Use the locator agents to find a network location from a point. |
void |
queryLocationByPointEx(IPoint point,
int curbApproach,
INALocation[] location,
IPoint[] outPoint,
double[] distanceFromPoint)
Use the locator agents to find a network location from a point and curb approach. |
void |
queryLocationByRow(IRow row,
INALocation[] location,
double[] distanceFromRow)
Use the locator agents to find a network location from a row. |
void |
queryLocationByRowEx(IRow row,
int curbApproach,
INALocation[] location,
double[] distanceFromRow)
Use the locator agents to find a network location from a row and curb approach. |
void |
queryLocationRangesByGeometry(IGeometry geometry,
INALocationRanges[] locationRanges)
Use the locator agents to find network location ranges from a geometry. |
void |
queryLocationRangesByRow(IRow row,
INALocationRanges[] locationRanges)
Use the locator agents to find a network location ranges from a row. |
void |
queryOffsetPoint(INALocation location,
double offset,
int units,
IPoint[] point)
The point offset from a network location. |
void |
queryPoint(INALocation location,
IPoint[] point)
The point for a network location. |
void |
readExternal(java.io.ObjectInput in)
|
void |
release()
Release a NALocator. |
void |
removeLocatorAgent(int index)
Remove a locator agent by index. |
java.lang.String |
reverseGeocodeLocation(INALocation location,
ILocator addressLocator)
The address of the network location. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
void |
setExcludeRestrictedElements(boolean excludeRestricted)
Indicates whether to exclude restricted portions of the network when locating points. |
void |
setFindClosestAmongAllAgents(boolean findClosest)
Indicates if the closest location (only) should be returned. |
void |
setMaxSnapTolerance(double maxTolerance)
The maximum distance that can be searched when expanding the snap tolerance. |
void |
setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
The spatial reference for points returned by the locator. |
void |
setSnapTolerance(double tolerance)
The distance to search. |
void |
setSnapToleranceUnits(int units)
The units of the snap tolerance. |
void |
writeExternal(java.io.ObjectOutput out)
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final long serialVersionUID
| Constructor Detail |
|---|
public NALocator()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public NALocator(java.lang.Object obj)
throws java.io.IOException
NALocator theNALocator = (NALocator) obj;
obj to NALocator.
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 INetworkDataset getNetworkDataset()
throws java.io.IOException,
AutomationException
getNetworkDataset in interface INALocatorjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSnapTolerance(double tolerance)
throws java.io.IOException,
AutomationException
setSnapTolerance in interface INALocatortolerance - The tolerance (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getSnapTolerance()
throws java.io.IOException,
AutomationException
getSnapTolerance in interface INALocatorjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSnapToleranceUnits(int units)
throws java.io.IOException,
AutomationException
setSnapToleranceUnits in interface INALocatorunits - A com.esri.arcgis.system.esriUnits constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSnapToleranceUnits()
throws java.io.IOException,
AutomationException
getSnapToleranceUnits in interface INALocatorjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFindClosestAmongAllAgents(boolean findClosest)
throws java.io.IOException,
AutomationException
setFindClosestAmongAllAgents in interface INALocatorfindClosest - The findClosest (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isFindClosestAmongAllAgents()
throws java.io.IOException,
AutomationException
isFindClosestAmongAllAgents in interface INALocatorjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLocatorAgentCount()
throws java.io.IOException,
AutomationException
getLocatorAgentCount in interface INALocatorjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INALocatorAgent getLocatorAgent(int index)
throws java.io.IOException,
AutomationException
getLocatorAgent in interface INALocatorindex - The index (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void createDefault(IDENetworkDataset network)
throws java.io.IOException,
AutomationException
createDefault in interface INALocatornetwork - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void addLocatorAgent(INALocatorAgent locatorAgent)
throws java.io.IOException,
AutomationException
addLocatorAgent in interface INALocatorlocatorAgent - A reference to a com.esri.arcgis.networkanalyst.INALocatorAgent (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void removeLocatorAgent(int index)
throws java.io.IOException,
AutomationException
removeLocatorAgent in interface INALocatorindex - The index (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryLocationByPoint(IPoint point,
INALocation[] location,
IPoint[] outPoint,
double[] distanceFromPoint)
throws java.io.IOException,
AutomationException
queryLocationByPoint in interface INALocatorpoint - A reference to a com.esri.arcgis.geometry.IPoint (in)location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in/out: use single element array)outPoint - A reference to a com.esri.arcgis.geometry.IPoint (in/out: use single element array)distanceFromPoint - The distanceFromPoint (in/out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryLocationByRow(IRow row,
INALocation[] location,
double[] distanceFromRow)
throws java.io.IOException,
AutomationException
queryLocationByRow in interface INALocatorrow - A reference to a com.esri.arcgis.geodatabase.IRow (in)location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in/out: use single element array)distanceFromRow - The distanceFromRow (in/out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryPoint(INALocation location,
IPoint[] point)
throws java.io.IOException,
AutomationException
queryPoint in interface INALocatorlocation - A reference to a com.esri.arcgis.networkanalyst.INALocation (in)point - A reference to a com.esri.arcgis.geometry.IPoint (in/out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void bind(INetworkDataset pNetworkDataset,
IGPMessages pGPMessages)
throws java.io.IOException,
AutomationException
bind in interface INALocatorpNetworkDataset - A reference to a com.esri.arcgis.geodatabase.INetworkDataset (in)pGPMessages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
throws java.io.IOException,
AutomationException
setOutputSpatialReferenceByRef in interface INALocatorspatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISpatialReference getOutputSpatialReference()
throws java.io.IOException,
AutomationException
getOutputSpatialReference in interface INALocatorjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getMaxSnapTolerance()
throws java.io.IOException,
AutomationException
getMaxSnapTolerance in interface INALocator2java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMaxSnapTolerance(double maxTolerance)
throws java.io.IOException,
AutomationException
setMaxSnapTolerance in interface INALocator2maxTolerance - The maxTolerance (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryOffsetPoint(INALocation location,
double offset,
int units,
IPoint[] point)
throws java.io.IOException,
AutomationException
queryOffsetPoint in interface INALocator2location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in)offset - The offset (in)units - A com.esri.arcgis.system.esriUnits constant (in)point - A reference to a com.esri.arcgis.geometry.IPoint (in/out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String reverseGeocodeLocation(INALocation location,
ILocator addressLocator)
throws java.io.IOException,
AutomationException
reverseGeocodeLocation in interface INALocator2location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in)addressLocator - A reference to a com.esri.arcgis.geodatabase.ILocator (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public INALocation geocodeLocation(java.lang.String address,
ILocator addressLocator)
throws java.io.IOException,
AutomationException
geocodeLocation in interface INALocator2address - The address (in)addressLocator - A reference to a com.esri.arcgis.geodatabase.ILocator (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryLocationRangesByGeometry(IGeometry geometry,
INALocationRanges[] locationRanges)
throws java.io.IOException,
AutomationException
queryLocationRangesByGeometry in interface INALocator3geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)locationRanges - A reference to a com.esri.arcgis.networkanalyst.INALocationRanges (in/out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryLocationRangesByRow(IRow row,
INALocationRanges[] locationRanges)
throws java.io.IOException,
AutomationException
queryLocationRangesByRow in interface INALocator3row - A reference to a com.esri.arcgis.geodatabase.IRow (in)locationRanges - A reference to a com.esri.arcgis.networkanalyst.INALocationRanges (in/out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExcludeRestrictedElements(boolean excludeRestricted)
throws java.io.IOException,
AutomationException
setExcludeRestrictedElements in interface INALocator3excludeRestricted - The excludeRestricted (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isExcludeRestrictedElements()
throws java.io.IOException,
AutomationException
isExcludeRestrictedElements in interface INALocator3java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void cacheRestrictedElements(INAContext context)
throws java.io.IOException,
AutomationException
cacheRestrictedElements in interface INALocator3context - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryLocationByPointEx(IPoint point,
int curbApproach,
INALocation[] location,
IPoint[] outPoint,
double[] distanceFromPoint)
throws java.io.IOException,
AutomationException
queryLocationByPointEx in interface INALocator3point - A reference to a com.esri.arcgis.geometry.IPoint (in)curbApproach - A com.esri.arcgis.networkanalyst.esriNACurbApproachType constant (in)location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in/out: use single element array)outPoint - A reference to a com.esri.arcgis.geometry.IPoint (in/out: use single element array)distanceFromPoint - The distanceFromPoint (in/out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void queryLocationByRowEx(IRow row,
int curbApproach,
INALocation[] location,
double[] distanceFromRow)
throws java.io.IOException,
AutomationException
queryLocationByRowEx in interface INALocator3row - A reference to a com.esri.arcgis.geodatabase.IRow (in)curbApproach - A com.esri.arcgis.networkanalyst.esriNACurbApproachType constant (in)location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in/out: use single element array)distanceFromRow - The distanceFromRow (in/out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws java.io.IOException,
AutomationException
isDirty in interface IPersistStreamjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws java.io.IOException,
AutomationException
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws java.io.IOException,
AutomationException
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws java.io.IOException,
AutomationException
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws java.io.IOException,
AutomationException
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IClone esri_clone()
throws java.io.IOException,
AutomationException
esri_clone in interface IClonejava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void assign(IClone src)
throws java.io.IOException,
AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEqual(IClone other)
throws java.io.IOException,
AutomationException
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isIdentical(IClone other)
throws java.io.IOException,
AutomationException
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void serialize(IXMLSerializeData data)
throws java.io.IOException,
AutomationException
serialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deserialize(IXMLSerializeData data)
throws java.io.IOException,
AutomationException
deserialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(java.io.ObjectOutput out)
throws java.io.IOException
writeExternal in interface java.io.Externalizablejava.io.IOException
public void readExternal(java.io.ObjectInput in)
throws java.io.IOException,
java.lang.ClassNotFoundException
readExternal in interface java.io.Externalizablejava.io.IOException
java.lang.ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||