com.esri.arcgis.networkanalysis
Class EdgeFlagDisplay

java.lang.Object
  extended by com.esri.arcgis.networkanalysis.EdgeFlagDisplay
All Implemented Interfaces:
IFeatureDraw, com.esri.arcgis.interop.RemoteObjRef, IEdgeFlagDisplay, IFlagDisplay, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

public class EdgeFlagDisplay
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IFlagDisplay, IEdgeFlagDisplay, IFeatureDraw, ISupportErrorInfo, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'EdgeFlagDisplay'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriNetworkAnalysis.olb'

Description 'A container for defining and displaying a network flag or barrier on an edge feature of a network.' 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.networkanalysis.IFlagDisplay
IID, IID857dc0c9_c156_11d2_babe_00c04fa33c20, xxDummy
 
Fields inherited from interface com.esri.arcgis.networkanalysis.IEdgeFlagDisplay
IID, IID08855cab_c158_11d2_babe_00c04fa33c20, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IFeatureDraw
IID, IIDb0e8d294_3a9c_11d1_9aa1_080009ec734b, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, 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
EdgeFlagDisplay()
          Constructs a EdgeFlagDisplay using ArcGIS Engine.
EdgeFlagDisplay(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EdgeFlagDisplay theEdgeFlagDisplay = (EdgeFlagDisplay) obj;
 
Method Summary
 java.lang.Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 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
 void getClassID(GUID[] pClassID)
          getClassID
 int getClientClassID()
          User-specified client class ID of this flag.
 int getClientFID()
          User-specified feature ID of the flag.
static java.lang.String getClsid()
          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.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 double getPercentage()
          Position of the flag along the edge element.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 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)
          interfaceSupportsErrorInfo
 void isDirty()
          isDirty
 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 EdgeFlagDisplay.
 void save(IStream pstm, int fClearDirty)
          save
 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.
 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

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.
EdgeFlagDisplay theEdgeFlagDisplay = (EdgeFlagDisplay) obj;

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.

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getFID

public int getFID()
           throws java.io.IOException,
                  AutomationException
Feature ID of the network element on which the flag is placed.

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
Feature ID of the network element on which the flag is placed.

Specified by:
setFID in interface IFlagDisplay
Parameters:
fID - The fID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubID

public int getSubID()
             throws java.io.IOException,
                    AutomationException
Sub ID of the network element on which the flag is placed.

Specified by:
getSubID in interface IFlagDisplay
Returns:
The subID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubID

public void setSubID(int subID)
              throws java.io.IOException,
                     AutomationException
Sub ID of the network element on which the flag is placed.

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
Feature class ID of the element on which the flag is placed.

Specified by:
getFeatureClassID in interface IFlagDisplay
Returns:
The fClassID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureClassID

public void setFeatureClassID(int fClassID)
                       throws java.io.IOException,
                              AutomationException
Feature class ID of the element on which the flag is placed.

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
Symbol used to display the flag.

Specified by:
getSymbol in interface IFlagDisplay
Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

public void setSymbolByRef(ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException
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
Point object containing the flag's coordinates.

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
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
User-specified client class ID of this flag.

Specified by:
getClientClassID in interface IFlagDisplay
Returns:
The clientClassID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClientClassID

public void setClientClassID(int clientClassID)
                      throws java.io.IOException,
                             AutomationException
User-specified client class ID of this flag.

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
User-specified feature ID of the flag.

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
User-specified feature ID of the flag.

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
Position of the flag along the edge element.

Specified by:
getPercentage in interface IEdgeFlagDisplay
Returns:
The percentage
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPercentage

public void setPercentage(double percentage)
                   throws java.io.IOException,
                          AutomationException
Position of the flag along the edge element.

Specified by:
setPercentage in interface IEdgeFlagDisplay
Parameters:
percentage - The percentage (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

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

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
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
The area to be drawn.

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
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
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