com.esri.arcgis.location
Class RouteMeasureLocatorName

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

All Implemented Interfaces:

ILocatorName, IRouteLocatorName, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class RouteMeasureLocatorName
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, ILocatorName, IRouteLocatorName, IPersistStream, ISupportErrorInfo, Externalizable

Route measure locator name object.

Remarks

A RouteMeasureLocatorName object identifies a RouteMeasureLocator object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RouteMeasureLocatorName()
Constructs a RouteMeasureLocatorName using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
String	getCategory() Category of the locator.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getDescription() Description of the locator.
ILocatorWorkspaceName	getLocatorWorkspaceName() Name object for the locator workspace that contains the locator.
String	getName() Name of the locator.
String	getNameString() The name string of the object.
IName	getRouteFeatureClassName() The route feature class name (Polyline with M feature class name).
String	getRouteIDFieldName() The route identifier field of the route feature class.
int	getRouteMeasureUnit() The route measure units.
String	getRouteWhereClause() The where clause that limits the routes that events can be located on.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isRouteIDIsUnique() Indicates if the Route ID is unique (Obsolete).
boolean	isStyle() Indicates if this is a locator style.
void	load(IStream pstm) load
Object	open() Opens the object referred to by this name.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setCategory(String category) Category of the locator.
void	setDescription(String description) Description of the locator.
void	setLocatorWorkspaceNameByRef(ILocatorWorkspaceName locatorWorkspaceName) Name object for the locator workspace that contains the locator.
void	setName(String name) Name of the locator.
void	setNameString(String nameString) The name string of the object.
void	setRouteFeatureClassNameByRef(IName name) The route feature class name (Polyline with M feature class name).
void	setRouteIDFieldName(String routeIDFieldName) The route identifier field of the route feature class.
void	setRouteIDIsUnique(boolean routeIDIsUnique) Indicates if the Route ID is unique (Obsolete).
void	setRouteMeasureUnit(int units) The route measure units.
void	setRouteWhereClause(String whereClause) The where clause that limits the routes that events can be located on.
void	setStyle(boolean isStyle) Indicates if this is a locator style.
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

RouteMeasureLocatorName

public RouteMeasureLocatorName()
                        throws IOException,
                               UnknownHostException

Constructs a RouteMeasureLocatorName using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RouteMeasureLocatorName

public RouteMeasureLocatorName(Object obj)
                        throws IOException

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

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

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

setNameString

public void setNameString(String nameString)
                   throws IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public Object open()
            throws IOException,
                   AutomationException

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the locator.

Description

The Name property returns the name of the locator or locator style that the LocatorName object represents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ILocatorName

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Name of the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ILocatorName

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Description of the locator.

Description

The Description property returns the description of the locator or locator style that the LocatorName object represents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface ILocatorName

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String description)
                    throws IOException,
                           AutomationException

Description of the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDescription in interface ILocatorName

Parameters:

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

Category of the locator.

Description

The Category property returns the category of the locator or locator style represented by the LocatorName object.

Remarks

By default, address locator styles provided with ArcGIS, and address locators based on those locator styles, have a category of "Address".

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface ILocatorName

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILocatorWorkspace.getLocatorNames(int, String), ILocatorName.getCategory(), ILocatorWorkspace.getLocators(int, String)

setCategory

public void setCategory(String category)
                 throws IOException,
                        AutomationException

Category of the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCategory in interface ILocatorName

Parameters:

category - The category (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStyle

public boolean isStyle()
                throws IOException,
                       AutomationException

Indicates if this is a locator style.

Description

The Style property indicates if the LocatorName object represents a locator style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isStyle in interface ILocatorName

Returns:

The isStyle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStyle

public void setStyle(boolean isStyle)
              throws IOException,
                     AutomationException

Indicates if this is a locator style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStyle in interface ILocatorName

Parameters:

isStyle - The isStyle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocatorWorkspaceName

public ILocatorWorkspaceName getLocatorWorkspaceName()
                                              throws IOException,
                                                     AutomationException

Name object for the locator workspace that contains the locator.

Description

The LocatorWorkspaceName property returns the LocatorWorkspaceName object that represents the locator workspace that contains the locator or locator style represented by the LocatorName object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLocatorWorkspaceName in interface ILocatorName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocatorWorkspaceNameByRef

public void setLocatorWorkspaceNameByRef(ILocatorWorkspaceName locatorWorkspaceName)
                                  throws IOException,
                                         AutomationException

Name object for the locator workspace that contains the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLocatorWorkspaceNameByRef in interface ILocatorName

Parameters:

locatorWorkspaceName - A reference to a com.esri.arcgis.geodatabase.ILocatorWorkspaceName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteFeatureClassNameByRef

public void setRouteFeatureClassNameByRef(IName name)
                                   throws IOException,
                                          AutomationException

The route feature class name (Polyline with M feature class name).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRouteFeatureClassNameByRef in interface IRouteLocatorName

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteFeatureClassName

public IName getRouteFeatureClassName()
                               throws IOException,
                                      AutomationException

The route feature class name (Polyline with M feature class name).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRouteFeatureClassName in interface IRouteLocatorName

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteIDFieldName

public void setRouteIDFieldName(String routeIDFieldName)
                         throws IOException,
                                AutomationException

The route identifier field of the route feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRouteIDFieldName in interface IRouteLocatorName

Parameters:

routeIDFieldName - The routeIDFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldName

public String getRouteIDFieldName()
                           throws IOException,
                                  AutomationException

The route identifier field of the route feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRouteIDFieldName in interface IRouteLocatorName

Returns:

The routeIDFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteIDIsUnique

public void setRouteIDIsUnique(boolean routeIDIsUnique)
                        throws IOException,
                               AutomationException

Indicates if the Route ID is unique (Obsolete).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRouteIDIsUnique in interface IRouteLocatorName

Parameters:

routeIDIsUnique - The routeIDIsUnique (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsUnique

public boolean isRouteIDIsUnique()
                          throws IOException,
                                 AutomationException

Indicates if the Route ID is unique (Obsolete).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isRouteIDIsUnique in interface IRouteLocatorName

Returns:

The routeIDIsUnique

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteMeasureUnit

public void setRouteMeasureUnit(int units)
                         throws IOException,
                                AutomationException

The route measure units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRouteMeasureUnit in interface IRouteLocatorName

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteMeasureUnit

public int getRouteMeasureUnit()
                        throws IOException,
                               AutomationException

The route measure units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRouteMeasureUnit in interface IRouteLocatorName

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteWhereClause

public void setRouteWhereClause(String whereClause)
                         throws IOException,
                                AutomationException

The where clause that limits the routes that events can be located on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRouteWhereClause in interface IRouteLocatorName

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteWhereClause

public String getRouteWhereClause()
                           throws IOException,
                                  AutomationException

The where clause that limits the routes that events can be located on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRouteWhereClause in interface IRouteLocatorName

Returns:

The whereClause

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