com.esri.arcgis.networkanalyst
Class NALocatorFeatureAgent

java.lang.Object
  extended by com.esri.arcgis.networkanalyst.NALocatorFeatureAgent
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INALocatorAgent, INALocatorAgent2, INALocatorAgent3, INALocatorFeatureAgent, INALocatorFeatureAgent2, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class NALocatorFeatureAgent
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INALocatorFeatureAgent, INALocatorFeatureAgent2, INALocatorAgent, INALocatorAgent2, INALocatorAgent3, IPersistStream, IPersist, IClone, IXMLSerialize, java.io.Externalizable

COM Class 'NALocatorFeatureAgent'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description 'Finds network feature 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 =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INALocatorFeatureAgent2
IID, IID53fd8c11_8672_4c28_bfdb_d0c78472979e, xxDummy
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INALocatorFeatureAgent
IID011dc4a1_9d12_4bdb_871d_96e6df3d6e32
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INALocatorAgent3
IID, IID5d4d4bfc_9b56_4331_bd27_b3b94c786e00, xxDummy
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INALocatorAgent2
IID5d052c29_922a_44a1_975f_a7d2c19665e2
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INALocatorAgent
IIDdb329ebe_6baa_4596_8206_8ddc87a17b62
 
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
NALocatorFeatureAgent()
          Constructs a NALocatorFeatureAgent using ArcGIS Engine.
NALocatorFeatureAgent(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NALocatorFeatureAgent theNALocatorFeatureAgent = (NALocatorFeatureAgent) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void bind(INetworkDataset pNetworkDataset, IGPMessages pGPMessages)
          Re-associate the locator with the given network dataset and its schema.
 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.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.String getFullWhereClause()
          The full where clause including the subtype predicate in the UseSubtype case.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getName()
          The name of the locator agent.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getSnapType()
          The method of snapping used.
 java.lang.String getSourceName()
          The network source name.
 int getSubtypeCode()
          The subtype to be used to locate features.
 java.lang.String getWhereClause()
          The where clause to filter candidate locations not including the subtype predicate in the UseSubtype case.
 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 isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 boolean isUseSubtype()
          Indicates if subtypes should be used to locate features.
 void load(IStream pstm)
          load
 void queryGeometry(INALocation location, IGeometry[] geometry)
          The geometry for the given network location.
 void queryLocationByPoint(IPoint point, double tolerance, INALocation[] location, IPoint[] outPoint, double[] distanceFromPoint)
          Find a network location from a point.
 void queryLocationByPointEx(IPoint point, double tolerance, int curbApproach, INALocation[] location, IPoint[] outPoint, double[] distanceFromPoint)
          Find a network location from a point and curb approach.
 void queryLocationByRow(IRow row, double tolerance, INALocation[] location, double[] distanceFromPoint)
          Find a network location from a row.
 void queryLocationByRowEx(IRow row, double tolerance, int curbApproach, INALocation[] location, double[] distanceFromRow)
          Find a network location from a row and curb approach.
 void queryLocationRangesByGeometry(IGeometry geometry, INALocationRanges[] locationRanges)
          Find network location ranges from a geometry.
 void queryLocationRangesByRow(IRow row, INALocationRanges[] locationRanges)
          Find network location ranges from a row.
 void queryPoint(INALocation location, IPoint[] point)
          The point for the given network location.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a NALocatorFeatureAgent.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setSnapType(int pHitPartType)
          The method of snapping used.
 void setSourceName(java.lang.String sourceName)
          The network source name.
 void setSubtypeCode(int subtypeCode)
          The subtype to be used to locate features.
 void setUseSubtype(boolean useSubtype)
          Indicates if subtypes should be used to locate features.
 void setWhereClause(java.lang.String whereClause)
          The where clause to filter candidate locations not including the subtype predicate in the UseSubtype case.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

NALocatorFeatureAgent

public NALocatorFeatureAgent()
                      throws java.io.IOException,
                             java.net.UnknownHostException
Constructs a NALocatorFeatureAgent using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

NALocatorFeatureAgent

public NALocatorFeatureAgent(java.lang.Object obj)
                      throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NALocatorFeatureAgent theNALocatorFeatureAgent = (NALocatorFeatureAgent) obj;

Construct a NALocatorFeatureAgent using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NALocatorFeatureAgent.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a NALocatorFeatureAgent.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setSourceName

public void setSourceName(java.lang.String sourceName)
                   throws java.io.IOException,
                          AutomationException
The network source name.

Specified by:
setSourceName in interface INALocatorFeatureAgent
Parameters:
sourceName - The sourceName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSourceName

public java.lang.String getSourceName()
                               throws java.io.IOException,
                                      AutomationException
The network source name.

Specified by:
getSourceName in interface INALocatorFeatureAgent
Returns:
The sourceName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSnapType

public void setSnapType(int pHitPartType)
                 throws java.io.IOException,
                        AutomationException
The method of snapping used.

Specified by:
setSnapType in interface INALocatorFeatureAgent
Parameters:
pHitPartType - A com.esri.arcgis.geometry.esriGeometryHitPartType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSnapType

public int getSnapType()
                throws java.io.IOException,
                       AutomationException
The method of snapping used.

Specified by:
getSnapType in interface INALocatorFeatureAgent
Returns:
A com.esri.arcgis.geometry.esriGeometryHitPartType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseSubtype

public void setUseSubtype(boolean useSubtype)
                   throws java.io.IOException,
                          AutomationException
Indicates if subtypes should be used to locate features.

Specified by:
setUseSubtype in interface INALocatorFeatureAgent
Parameters:
useSubtype - The useSubtype (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseSubtype

public boolean isUseSubtype()
                     throws java.io.IOException,
                            AutomationException
Indicates if subtypes should be used to locate features.

Specified by:
isUseSubtype in interface INALocatorFeatureAgent
Returns:
The useSubtype
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubtypeCode

public void setSubtypeCode(int subtypeCode)
                    throws java.io.IOException,
                           AutomationException
The subtype to be used to locate features.

Specified by:
setSubtypeCode in interface INALocatorFeatureAgent
Parameters:
subtypeCode - The subtypeCode (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubtypeCode

public int getSubtypeCode()
                   throws java.io.IOException,
                          AutomationException
The subtype to be used to locate features.

Specified by:
getSubtypeCode in interface INALocatorFeatureAgent
Returns:
The subtypeCode
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(java.lang.String whereClause)
                    throws java.io.IOException,
                           AutomationException
The where clause to filter candidate locations not including the subtype predicate in the UseSubtype case.

Specified by:
setWhereClause in interface INALocatorFeatureAgent2
Parameters:
whereClause - The whereClause (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWhereClause

public java.lang.String getWhereClause()
                                throws java.io.IOException,
                                       AutomationException
The where clause to filter candidate locations not including the subtype predicate in the UseSubtype case.

Specified by:
getWhereClause in interface INALocatorFeatureAgent2
Returns:
The whereClause
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullWhereClause

public java.lang.String getFullWhereClause()
                                    throws java.io.IOException,
                                           AutomationException
The full where clause including the subtype predicate in the UseSubtype case.

Specified by:
getFullWhereClause in interface INALocatorFeatureAgent2
Returns:
The fullWhereClause
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the locator agent.

Specified by:
getName in interface INALocatorAgent
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocationByPoint

public void queryLocationByPoint(IPoint point,
                                 double tolerance,
                                 INALocation[] location,
                                 IPoint[] outPoint,
                                 double[] distanceFromPoint)
                          throws java.io.IOException,
                                 AutomationException
Find a network location from a point.

Specified by:
queryLocationByPoint in interface INALocatorAgent
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
tolerance - The tolerance (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)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocationByRow

public void queryLocationByRow(IRow row,
                               double tolerance,
                               INALocation[] location,
                               double[] distanceFromPoint)
                        throws java.io.IOException,
                               AutomationException
Find a network location from a row.

Specified by:
queryLocationByRow in interface INALocatorAgent
Parameters:
row - A reference to a com.esri.arcgis.geodatabase.IRow (in)
tolerance - The tolerance (in)
location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in/out: use single element array)
distanceFromPoint - The distanceFromPoint (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryPoint

public void queryPoint(INALocation location,
                       IPoint[] point)
                throws java.io.IOException,
                       AutomationException
The point for the given network location.

Specified by:
queryPoint in interface INALocatorAgent
Parameters:
location - 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)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

bind

public void bind(INetworkDataset pNetworkDataset,
                 IGPMessages pGPMessages)
          throws java.io.IOException,
                 AutomationException
Re-associate the locator with the given network dataset and its schema.

Specified by:
bind in interface INALocatorAgent
Parameters:
pNetworkDataset - A reference to a com.esri.arcgis.geodatabase.INetworkDataset (in)
pGPMessages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryGeometry

public void queryGeometry(INALocation location,
                          IGeometry[] geometry)
                   throws java.io.IOException,
                          AutomationException
The geometry for the given network location.

Specified by:
queryGeometry in interface INALocatorAgent2
Parameters:
location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocationRangesByGeometry

public void queryLocationRangesByGeometry(IGeometry geometry,
                                          INALocationRanges[] locationRanges)
                                   throws java.io.IOException,
                                          AutomationException
Find network location ranges from a geometry.

Specified by:
queryLocationRangesByGeometry in interface INALocatorAgent3
Parameters:
geometry - 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)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocationRangesByRow

public void queryLocationRangesByRow(IRow row,
                                     INALocationRanges[] locationRanges)
                              throws java.io.IOException,
                                     AutomationException
Find network location ranges from a row.

Specified by:
queryLocationRangesByRow in interface INALocatorAgent3
Parameters:
row - 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)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocationByPointEx

public void queryLocationByPointEx(IPoint point,
                                   double tolerance,
                                   int curbApproach,
                                   INALocation[] location,
                                   IPoint[] outPoint,
                                   double[] distanceFromPoint)
                            throws java.io.IOException,
                                   AutomationException
Find a network location from a point and curb approach.

Specified by:
queryLocationByPointEx in interface INALocatorAgent3
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
tolerance - The tolerance (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)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryLocationByRowEx

public void queryLocationByRowEx(IRow row,
                                 double tolerance,
                                 int curbApproach,
                                 INALocation[] location,
                                 double[] distanceFromRow)
                          throws java.io.IOException,
                                 AutomationException
Find a network location from a row and curb approach.

Specified by:
queryLocationByRowEx in interface INALocatorAgent3
Parameters:
row - A reference to a com.esri.arcgis.geodatabase.IRow (in)
tolerance - The tolerance (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)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException
Indicates if the receiver and other have the same properties.

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException
Indicates if the receiver and other are the same object.

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException