com.esri.arcgis.networkanalyst
Class NALocation

java.lang.Object
  com.esri.arcgis.networkanalyst.NALocation

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INALocation, IDocumentVersionSupportGEN, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class NALocation
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INALocation, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'Defines the side and position of an analysis object on a feature.' 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.INALocation

IID, IID109c0d16_c677_4b96_b5c4_6b17e8d234d2, xxDummy

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

Constructor Summary

NALocation()
Constructs a NALocation using ArcGIS Engine.

NALocation(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NALocation theNALocation = (NALocation) obj;

Method Summary

java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getSide() The side of the feature.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getSourceID() The ID of the network source.
int	getSourceOID() The OID of the feature.
double	getSourcePosition() The position along the feature.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isLocated() Indicates if the location has been found on the network.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a NALocation.
void	save(IStream pstm, int fClearDirty) save
void	setSide(int side) The side of the feature.
void	setSourceID(int sourceID) The ID of the network source.
void	setSourceOID(int sourceOID) The OID of the feature.
void	setSourcePosition(double position) The position along the feature.
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

NALocation

public NALocation()
           throws java.io.IOException,
                  java.net.UnknownHostException

Constructs a NALocation using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NALocation

public NALocation(java.lang.Object obj)
           throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NALocation theNALocation = (NALocation) obj;

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

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 NALocation.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setSourceID

public void setSourceID(int sourceID)
                 throws java.io.IOException,
                        AutomationException

The ID of the network source.

Specified by:

setSourceID in interface INALocation

Parameters:

sourceID - The sourceID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceID

public int getSourceID()
                throws java.io.IOException,
                       AutomationException

The ID of the network source.

Specified by:

getSourceID in interface INALocation

Returns:

The sourceID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceOID

public void setSourceOID(int sourceOID)
                  throws java.io.IOException,
                         AutomationException

The OID of the feature.

Specified by:

setSourceOID in interface INALocation

Parameters:

sourceOID - The sourceOID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceOID

public int getSourceOID()
                 throws java.io.IOException,
                        AutomationException

The OID of the feature.

Specified by:

getSourceOID in interface INALocation

Returns:

The sourceOID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourcePosition

public void setSourcePosition(double position)
                       throws java.io.IOException,
                              AutomationException

The position along the feature.

Specified by:

setSourcePosition in interface INALocation

Parameters:

position - The position (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourcePosition

public double getSourcePosition()
                         throws java.io.IOException,
                                AutomationException

The position along the feature.

Specified by:

getSourcePosition in interface INALocation

Returns:

The position

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSide

public void setSide(int side)
             throws java.io.IOException,
                    AutomationException

The side of the feature.

Specified by:

setSide in interface INALocation

Parameters:

side - A com.esri.arcgis.networkanalyst.esriNAEdgeSideType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSide

public int getSide()
            throws java.io.IOException,
                   AutomationException

The side of the feature.

Specified by:

getSide in interface INALocation

Returns:

A com.esri.arcgis.networkanalyst.esriNAEdgeSideType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLocated

public boolean isLocated()
                  throws java.io.IOException,
                         AutomationException

Indicates if the location has been found on the network.

Specified by:

isLocated in interface INALocation

Returns:

The located

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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

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