com.esri.arcgis.location
Class RouteMeasureLineProperties

java.lang.Object
  extended by com.esri.arcgis.location.RouteMeasureLineProperties
All Implemented Interfaces:
IRouteEventProperties, IRouteEventProperties2, com.esri.arcgis.interop.RemoteObjRef, IRouteMeasureLineProperties, IClone, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class RouteMeasureLineProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRouteEventProperties2, IRouteMeasureLineProperties, IClone, IPersistStream, ISupportErrorInfo, Externalizable

Properties for route measure line event tables.

Remarks

Route event properties identify certian characteristics of a table so that it can be recognized as a table containing route events.

RouteMeasureLineProperties identify a table as a line event table.

RouteMeasureLineProperties are helper objects for a RouteEventSource.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RouteMeasureLineProperties()
          Constructs a RouteMeasureLineProperties using ArcGIS Engine.
RouteMeasureLineProperties(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureLineProperties theRouteMeasureLineProperties = (RouteMeasureLineProperties) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean equals(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 String getClsid()
          getClsid.
 String getErrorFieldName()
          Name of the error field name.
 int getEventMeasureUnit()
          The units of the event measure(s).
 String getEventRouteIDFieldName()
          The route identifier field name.
 String getFromMeasureFieldName()
          The from-measure field name.
 String getLateralOffsetFieldName()
          The lateral offset field name.
 void getSettingError()
          The state of the object (see if all the required field names have been set).
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 String getToMeasureFieldName()
          The to-measure field name.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isAddErrorField()
          Indicates if the error field should be added to the field set.
 boolean isALineEvent()
          Is a line event.
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isMDirectionOffsetting()
          Indicates if the offset should based onthe M direction or the digitized direction.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setAddErrorField(boolean value)
          Indicates if the error field should be added to the field set.
 void setErrorFieldName(String fieldName)
          Name of the error field name.
 void setEventMeasureUnit(int units)
          The units of the event measure(s).
 void setEventRouteIDFieldName(String fieldName)
          The route identifier field name.
 void setFromMeasureFieldName(String fieldName)
          The from-measure field name.
 void setLateralOffsetFieldName(String fieldName)
          The lateral offset field name.
 void setMDirectionOffsetting(boolean value)
          Indicates if the offset should based onthe M direction or the digitized direction.
 void setToMeasureFieldName(String fieldName)
          The to-measure 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

RouteMeasureLineProperties

public RouteMeasureLineProperties()
                           throws IOException,
                                  UnknownHostException
Constructs a RouteMeasureLineProperties using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RouteMeasureLineProperties

public RouteMeasureLineProperties(Object obj)
                           throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureLineProperties theRouteMeasureLineProperties = (RouteMeasureLineProperties) obj;

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

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

setAddErrorField

public void setAddErrorField(boolean value)
                      throws IOException,
                             AutomationException
Indicates if the error field should be added to the field set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAddErrorField in interface IRouteEventProperties2
Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAddErrorField

public boolean isAddErrorField()
                        throws IOException,
                               AutomationException
Indicates if the error field should be added to the field set.

Remarks

This property allows you to add a non editable and dynamic field to the route event source to provide information about whether the events were located or not.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isAddErrorField in interface IRouteEventProperties2
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setErrorFieldName

public void setErrorFieldName(String fieldName)
                       throws IOException,
                              AutomationException
Name of the error field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setErrorFieldName in interface IRouteEventProperties2
Parameters:
fieldName - The fieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getErrorFieldName

public String getErrorFieldName()
                         throws IOException,
                                AutomationException
Name of the error field name.

Remarks

If the AddErrorField property is set to True, this property is used to set the name of the field which will contain the locating errors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getErrorFieldName in interface IRouteEventProperties2
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMDirectionOffsetting

public void setMDirectionOffsetting(boolean value)
                             throws IOException,
                                    AutomationException
Indicates if the offset should based onthe M direction or the digitized direction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMDirectionOffsetting in interface IRouteEventProperties2
Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMDirectionOffsetting

public boolean isMDirectionOffsetting()
                               throws IOException,
                                      AutomationException
Indicates if the offset should based onthe M direction or the digitized direction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isMDirectionOffsetting in interface IRouteEventProperties2
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEventRouteIDFieldName

public void setEventRouteIDFieldName(String fieldName)
                              throws IOException,
                                     AutomationException
The route identifier field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setEventRouteIDFieldName in interface IRouteEventProperties
Parameters:
fieldName - The fieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEventRouteIDFieldName

public String getEventRouteIDFieldName()
                                throws IOException,
                                       AutomationException
The route identifier field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEventRouteIDFieldName in interface IRouteEventProperties
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEventMeasureUnit

public void setEventMeasureUnit(int units)
                         throws IOException,
                                AutomationException
The units of the event measure(s).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setEventMeasureUnit in interface IRouteEventProperties
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.

getEventMeasureUnit

public int getEventMeasureUnit()
                        throws IOException,
                               AutomationException
The units of the event measure(s).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEventMeasureUnit in interface IRouteEventProperties
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLateralOffsetFieldName

public void setLateralOffsetFieldName(String fieldName)
                               throws IOException,
                                      AutomationException
The lateral offset field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLateralOffsetFieldName in interface IRouteEventProperties
Parameters:
fieldName - The fieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLateralOffsetFieldName

public String getLateralOffsetFieldName()
                                 throws IOException,
                                        AutomationException
The lateral offset field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLateralOffsetFieldName in interface IRouteEventProperties
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isALineEvent

public boolean isALineEvent()
                     throws IOException,
                            AutomationException
Is a line event.

Product Availability

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

Specified by:
isALineEvent in interface IRouteEventProperties
Returns:
The lineEvent
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSettingError

public void getSettingError()
                     throws IOException,
                            AutomationException
The state of the object (see if all the required field names have been set).

Product Availability

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

Specified by:
getSettingError in interface IRouteEventProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFromMeasureFieldName

public void setFromMeasureFieldName(String fieldName)
                             throws IOException,
                                    AutomationException
The from-measure field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFromMeasureFieldName in interface IRouteMeasureLineProperties
Parameters:
fieldName - The fieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFromMeasureFieldName

public String getFromMeasureFieldName()
                               throws IOException,
                                      AutomationException
The from-measure field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFromMeasureFieldName in interface IRouteMeasureLineProperties
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setToMeasureFieldName

public void setToMeasureFieldName(String fieldName)
                           throws IOException,
                                  AutomationException
The to-measure field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setToMeasureFieldName in interface IRouteMeasureLineProperties
Parameters:
fieldName - The fieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToMeasureFieldName

public String getToMeasureFieldName()
                             throws IOException,
                                    AutomationException
The to-measure field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getToMeasureFieldName in interface IRouteMeasureLineProperties
Returns:
The fieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

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

Product Availability

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

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

assign

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

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
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