com.esri.arcgis.location
Class RouteLayerExtension

java.lang.Object
  com.esri.arcgis.location.RouteLayerExtension

All Implemented Interfaces:

ILayerExtensionDraw, com.esri.arcgis.interop.RemoteObjRef, IRouteLayerExtension, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class RouteLayerExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRouteLayerExtension, ILayerExtensionDraw, IPersistStream, ISupportErrorInfo, Externalizable

Layer Extension for route feature class.

Remarks

The RouteLayerExtension is a FeatureLayer extension which provides information about RouteMeasureLocatorName, and allows you to set the route reference's route identifier. In ArcMap, RouteLayerExtension object gets created everytime a PolylineM feature class is added.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RouteLayerExtension()
Constructs a RouteLayerExtension using ArcGIS Engine.

RouteLayerExtension(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteLayerExtension theRouteLayerExtension = (RouteLayerExtension) obj;

Method Summary

void	afterLayerDraw(ILayer pLayer, int drawPhase, IDisplay pDisplay, ITrackCancel pTrackCancel) Drawing event called after layer draws.
void	beforeLayerDraw(ILayer pLayer, int drawPhase, IDisplay pDisplay, ITrackCancel pTrackCancel) Drawing event called before layer draws.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getRouteIDFieldName() The route id field name.
IRouteLocatorName	getRouteLocatorName(ILayer layer) The route locator name.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setRouteIDFieldName(ILayer layer, String fieldName) Set the route id field name.
void	writeExternal(ObjectOutput out)

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

RouteLayerExtension

public RouteLayerExtension()
                    throws IOException,
                           UnknownHostException

Constructs a RouteLayerExtension using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RouteLayerExtension

public RouteLayerExtension(Object obj)
                    throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getRouteLocatorName

public IRouteLocatorName getRouteLocatorName(ILayer layer)
                                      throws IOException,
                                             AutomationException

The route locator name.

Product Availability

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

Specified by:

getRouteLocatorName in interface IRouteLayerExtension

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRouteLocatorName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldName

public String getRouteIDFieldName()
                           throws IOException,
                                  AutomationException

The route id field name.

Remarks

This is used to get the route identifer (RouteIDFieldName) from the IRouteLocatorName interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRouteIDFieldName in interface IRouteLayerExtension

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteIDFieldName

public void setRouteIDFieldName(ILayer layer,
                                String fieldName)
                         throws IOException,
                                AutomationException

Set the route id field name.

Remarks

This sets the RouteIDFieldName for the route layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRouteIDFieldName in interface IRouteLayerExtension

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeLayerDraw

public void beforeLayerDraw(ILayer pLayer,
                            int drawPhase,
                            IDisplay pDisplay,
                            ITrackCancel pTrackCancel)
                     throws IOException,
                            AutomationException

Drawing event called before layer draws.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

beforeLayerDraw in interface ILayerExtensionDraw

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

afterLayerDraw

public void afterLayerDraw(ILayer pLayer,
                           int drawPhase,
                           IDisplay pDisplay,
                           ITrackCancel pTrackCancel)
                    throws IOException,
                           AutomationException

Drawing event called after layer draws.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

afterLayerDraw in interface ILayerExtensionDraw

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException