com.esri.arcgis.networkanalysis
Class EdgeFlagDisplay

java.lang.Object
  com.esri.arcgis.networkanalysis.EdgeFlagDisplay

All Implemented Interfaces:

IEdgeFlagDisplay, IFeatureDraw, IFlagDisplay, ISupportErrorInfo, java.io.Serializable

public class EdgeFlagDisplay

extends java.lang.Object

implements IFlagDisplay, IEdgeFlagDisplay, IFeatureDraw, ISupportErrorInfo

A container for defining and displaying a network flag or barrier on an edge feature of a network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

EdgeFlagDisplay()
Constructs a EdgeFlagDisplay using ArcGIS Engine.

EdgeFlagDisplay(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	draw(int drawPhase, IDisplay display, ISymbol symbol, boolean symbolInstalled, IGeometry geometry, int drawStyle) Draws the feature on the display.
boolean	equals(java.lang.Object o) Compare this object with another
IEdgeFlagDisplay	getAsIEdgeFlagDisplay() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IFeatureDraw	getAsIFeatureDraw() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IFlagDisplay	getAsIFlagDisplay() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
int	getClientClassID() User-specified client class ID of this flag.
int	getClientFID() User-specified feature ID of the flag.
static java.lang.String	getClsid()
int	getFeatureClassID() Feature class ID of the element on which the flag is placed.
int	getFID() Feature ID of the network element on which the flag is placed.
IGeometry	getGeometry() Point object containing the flag's coordinates.
IInvalidArea	getInvalidArea() The area to be drawn.
double	getPercentage() Position of the flag along the edge element.
int	getSubID() Sub ID of the network element on which the flag is placed.
ISymbol	getSymbol() Symbol used to display the flag.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
void	setClientClassID(int clientClassID) User-specified client class ID of this flag.
void	setClientFID(int clientFID) User-specified feature ID of the flag.
void	setFeatureClassID(int fClassID) Feature class ID of the element on which the flag is placed.
void	setFID(int fID) Feature ID of the network element on which the flag is placed.
void	setGeometryByRef(IGeometry geometry) Point object containing the flag's coordinates.
void	setInvalidAreaByRef(IInvalidArea invalidArea) The area to be drawn.
void	setPercentage(double percentage) Position of the flag along the edge element.
void	setSubID(int subID) Sub ID of the network element on which the flag is placed.
void	setSymbolByRef(ISymbol symbol) Symbol used to display the flag.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EdgeFlagDisplay

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

Constructs a EdgeFlagDisplay using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

EdgeFlagDisplay

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a EdgeFlagDisplay using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to EdgeFlagDisplay.
EdgeFlagDisplay theEdgeFlagDisplay = (EdgeFlagDisplay) obj;

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()

getAsIFlagDisplay

public IFlagDisplay getAsIFlagDisplay()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIEdgeFlagDisplay

public IEdgeFlagDisplay getAsIEdgeFlagDisplay()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIFeatureDraw

public IFeatureDraw getAsIFeatureDraw()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getFID

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

Description copied from interface: IFlagDisplay

Feature ID of the network element on which the flag is placed.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFID in interface IFlagDisplay

Returns:

The fID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFID

public void setFID(int fID)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IFlagDisplay

Feature ID of the network element on which the flag is placed.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFID in interface IFlagDisplay

Parameters:

fID - The fID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSubID

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

Description copied from interface: IFlagDisplay

Sub ID of the network element on which the flag is placed.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSubID in interface IFlagDisplay

Returns:

The subID

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSubID

public void setSubID(int subID)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IFlagDisplay

Sub ID of the network element on which the flag is placed.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSubID in interface IFlagDisplay

Parameters:

subID - The subID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureClassID

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

Description copied from interface: IFlagDisplay

Feature class ID of the element on which the flag is placed.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureClassID in interface IFlagDisplay

Returns:

The fClassID

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFeatureClassID

public void setFeatureClassID(int fClassID)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IFlagDisplay

Feature class ID of the element on which the flag is placed.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureClassID in interface IFlagDisplay

Parameters:

fClassID - The fClassID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IFlagDisplay

Symbol used to display the flag.

Supported Platforms

Windows, Solaris, Linux

Remarks

This property is used only for displaying of the flag in ArcMap.

Specified by:

getSymbol in interface IFlagDisplay

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IFlagDisplay

Symbol used to display the flag.

Specified by:

setSymbolByRef in interface IFlagDisplay

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IFlagDisplay

Point object containing the flag's coordinates.

Supported Platforms

Windows, Solaris, Linux

Remarks

This property is primarily used for displaying the flag in ArcMap.

It is also used by the Utility Network Analysis extension for relocating the flag on the geometric network after edits have been made to the geodatabase.

Specified by:

getGeometry in interface IFlagDisplay

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

public void setGeometryByRef(IGeometry geometry)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IFlagDisplay

Point object containing the flag's coordinates.

Specified by:

setGeometryByRef in interface IFlagDisplay

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClientClassID

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

Description copied from interface: IFlagDisplay

User-specified client class ID of this flag.

Supported Platforms

Windows, Solaris, Linux

Remarks

Use the ClientClassID property if you want to associate flags with features that do not participate in the network. For example, if you wanted to create flags from a point feature class that did not participate in the network, you could create a flag object for each feature in the feature class, and assign the feature class ID and feature ID from the original feature class to each flag you create.

Specified by:

getClientClassID in interface IFlagDisplay

Returns:

The clientClassID

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setClientClassID

public void setClientClassID(int clientClassID)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IFlagDisplay

User-specified client class ID of this flag.

Supported Platforms

Windows, Solaris, Linux

Remarks

Use the ClientClassID property if you want to associate flags with features that do not participate in the network. For example, if you wanted to create flags from a point feature class that did not participate in the network, you could create a flag object for each feature in the feature class, and assign the feature class ID and feature ID from the original feature class to each flag you create.

Specified by:

setClientClassID in interface IFlagDisplay

Parameters:

clientClassID - The clientClassID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClientFID

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

Description copied from interface: IFlagDisplay

User-specified feature ID of the flag.

Supported Platforms

Windows, Solaris, Linux

Remarks

Use the ClientFID property if you want to associate flags with features that do not participate in the network. For example, if you wanted to create flags from a point feature class that did not participate in the network, you could create a flag object for each feature in the feature class, and assign the feature class ID and feature ID from the original feature class to each flag you create.

Specified by:

getClientFID in interface IFlagDisplay

Returns:

The clientFID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClientFID

public void setClientFID(int clientFID)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IFlagDisplay

User-specified feature ID of the flag.

Supported Platforms

Windows, Solaris, Linux

Remarks

Use the ClientFID property if you want to associate flags with features that do not participate in the network. For example, if you wanted to create flags from a point feature class that did not participate in the network, you could create a flag object for each feature in the feature class, and assign the feature class ID and feature ID from the original feature class to each flag you create.

Specified by:

setClientFID in interface IFlagDisplay

Parameters:

clientFID - The clientFID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPercentage

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

Description copied from interface: IEdgeFlagDisplay

Position of the flag along the edge element.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Percentage property specifies the percentage along the feature, measured from the start node of the feature's geometry, at which the flag is located.

The percentage can be a value between 0 and 1.

Specified by:

getPercentage in interface IEdgeFlagDisplay

Returns:

The percentage

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPercentage

public void setPercentage(double percentage)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IEdgeFlagDisplay

Position of the flag along the edge element.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Percentage property specifies the percentage along the feature, measured from the start node of the feature's geometry, at which the flag is located.

The percentage can be a value between 0 and 1.

Specified by:

setPercentage in interface IEdgeFlagDisplay

Parameters:

percentage - The percentage (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ISymbol symbol,
                 boolean symbolInstalled,
                 IGeometry geometry,
                 int drawStyle)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IFeatureDraw

Draws the feature on the display.

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IFeatureDraw

Parameters:

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

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

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

symbolInstalled - The symbolInstalled (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

drawStyle - A com.esri.arcgis.geodatabase.esriDrawStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInvalidAreaByRef

public void setInvalidAreaByRef(IInvalidArea invalidArea)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IFeatureDraw

The area to be drawn.

Specified by:

setInvalidAreaByRef in interface IFeatureDraw

Parameters:

invalidArea - A reference to a com.esri.arcgis.geodatabase.IInvalidArea (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInvalidArea

public IInvalidArea getInvalidArea()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IFeatureDraw

The area to be drawn.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInvalidArea in interface IFeatureDraw

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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