com.esri.arcgis.display
Class RepresentationMarker

java.lang.Object
  extended by com.esri.arcgis.display.RepresentationMarker
All Implemented Interfaces:
IGraphicsOutline, IRepresentationGraphics, IRepresentationMarker, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class RepresentationMarker
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRepresentationMarker, IRepresentationGraphics, IGraphicsOutline, IPersist, IPersistStream, IClone, IDocumentVersionSupportGEN, IXMLSerialize, IXMLVersionSupport, Externalizable

A representation marker object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
RepresentationMarker()
          Constructs a RepresentationMarker using ArcGIS Engine.
RepresentationMarker(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RepresentationMarker theRepresentationMarker = (RepresentationMarker) obj;
 
Method Summary
 void add(IGeometry geometry, IRepresentationRule repRule)
          Adds a new graphic.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void changeGeometry(int iD, IGeometry geometry)
          Changes a geometry.
 Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void draw(IOutputContext context, IAffineTransformation2D transfo, IEnvelope envelope)
          Draws the representation marker.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 IGeometry getAllOutlineParts(int type, int option, double buffer, IEnvelope clipEnvelope)
          Returns the entire drawing outline of a graphics.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 double getHeight()
          The height in points (1/72 of an inch) of the marker.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 IGeometry getOutline(int type)
          The outline of the marker, returned as a polygon.
 double getSize()
          The size in points (1/72 of an inch) of the marker.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 double getWidth()
          The width in points (1/72 of an inch) of the marker.
 int hashCode()
          the hashcode for this object
 boolean hitTest(IPoint point, double tolerance)
          Tests if a point is located on the graphics outline.
 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 isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 void load(IStream pstm)
          load
 void next(IGeometry[] geometry, IRepresentationRule[] repRule)
          Retrieves the next graphic.
 void nextGeometry(int[] iD, IGeometry[] geometry)
          Accesses the next geometry.
 IGeometry nextOutlinePart()
          Returns the next drawing outline part.
 void readExternal(ObjectInput in)
           
 void remove(IGeometry geometry, IRepresentationRule repRule)
          Removes a graphic.
 void removeAll()
          Removes all graphics.
 void reset()
          Resets the graphic enumeration.
 void reset(int type, int option, double buffer, IEnvelope clipEnvelope)
          Resets the collection of drawing outline parts to the beginning, before calling NextOutlinePart.
 void resetGeometry()
          Resets the geometry collection.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 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

RepresentationMarker

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

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

RepresentationMarker

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

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

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

draw

public void draw(IOutputContext context,
                 IAffineTransformation2D transfo,
                 IEnvelope envelope)
          throws IOException,
                 AutomationException
Draws the representation marker.

Product Availability

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

Specified by:
draw in interface IRepresentationMarker
Parameters:
context - A reference to a com.esri.arcgis.display.IOutputContext (in)
transfo - A reference to a com.esri.arcgis.geometry.IAffineTransformation2D (in)
envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutline

public IGeometry getOutline(int type)
                     throws IOException,
                            AutomationException
The outline of the marker, returned as a polygon.

Product Availability

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

Specified by:
getOutline in interface IRepresentationMarker
Parameters:
type - A com.esri.arcgis.display.esriOutlineType constant (in)
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSize

public double getSize()
               throws IOException,
                      AutomationException
The size in points (1/72 of an inch) of the marker.

Product Availability

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

Specified by:
getSize in interface IRepresentationMarker
Returns:
The size
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

public double getWidth()
                throws IOException,
                       AutomationException
The width in points (1/72 of an inch) of the marker.

Product Availability

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

Specified by:
getWidth in interface IRepresentationMarker
Returns:
The width
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

public double getHeight()
                 throws IOException,
                        AutomationException
The height in points (1/72 of an inch) of the marker.

Product Availability

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

Specified by:
getHeight in interface IRepresentationMarker
Returns:
The height
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Resets the graphic enumeration.

Product Availability

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

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

next

public void next(IGeometry[] geometry,
                 IRepresentationRule[] repRule)
          throws IOException,
                 AutomationException
Retrieves the next graphic.

Product Availability

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

Specified by:
next in interface IRepresentationGraphics
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
repRule - A reference to a com.esri.arcgis.display.IRepresentationRule (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IGeometry geometry,
                IRepresentationRule repRule)
         throws IOException,
                AutomationException
Adds a new graphic.

Remarks

Add method can be used to add representation graphics to a RepresentationGraphics object. This method takes arguments such as geometry and representation rule. The geometry is in map coordinates.

Product Availability

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

Specified by:
add in interface IRepresentationGraphics
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
repRule - A reference to a com.esri.arcgis.display.IRepresentationRule (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

public void remove(IGeometry geometry,
                   IRepresentationRule repRule)
            throws IOException,
                   AutomationException
Removes a graphic.

Product Availability

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

Specified by:
remove in interface IRepresentationGraphics
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
repRule - A reference to a com.esri.arcgis.display.IRepresentationRule (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException
Removes all graphics.

Product Availability

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

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

resetGeometry

public void resetGeometry()
                   throws IOException,
                          AutomationException
Resets the geometry collection.

Product Availability

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

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

nextGeometry

public void nextGeometry(int[] iD,
                         IGeometry[] geometry)
                  throws IOException,
                         AutomationException
Accesses the next geometry.

Remarks

NextGeometry method can be used to call the geometries present in a RepresentationGraphics or RepresentationMarker. Reset method has to be called prior to calling this method as this will reset the collection of geometries to the starting.

Product Availability

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

Specified by:
nextGeometry in interface IRepresentationGraphics
Parameters:
iD - The iD (out: use single element array)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

changeGeometry

public void changeGeometry(int iD,
                           IGeometry geometry)
                    throws IOException,
                           AutomationException
Changes a geometry.

Product Availability

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

Specified by:
changeGeometry in interface IRepresentationGraphics
Parameters:
iD - The iD (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hitTest

public boolean hitTest(IPoint point,
                       double tolerance)
                throws IOException,
                       AutomationException
Tests if a point is located on the graphics outline.

Product Availability

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

Specified by:
hitTest in interface IGraphicsOutline
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
tolerance - The tolerance (in)
Returns:
The hit
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAllOutlineParts

public IGeometry getAllOutlineParts(int type,
                                    int option,
                                    double buffer,
                                    IEnvelope clipEnvelope)
                             throws IOException,
                                    AutomationException
Returns the entire drawing outline of a graphics.

Product Availability

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

Specified by:
getAllOutlineParts in interface IGraphicsOutline
Parameters:
type - A com.esri.arcgis.display.esriOutlineType constant (in)
option - A com.esri.arcgis.display.esriOutlineOption constant (in)
buffer - The buffer (in)
clipEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset(int type,
                  int option,
                  double buffer,
                  IEnvelope clipEnvelope)
           throws IOException,
                  AutomationException
Resets the collection of drawing outline parts to the beginning, before calling NextOutlinePart. To be used when drawing outline of a graphics is accessed part by part.

Product Availability

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

Specified by:
reset in interface IGraphicsOutline
Parameters:
type - A com.esri.arcgis.display.esriOutlineType constant (in)
option - A com.esri.arcgis.display.esriOutlineOption constant (in)
buffer - The buffer (in)
clipEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextOutlinePart

public IGeometry nextOutlinePart()
                          throws IOException,
                                 AutomationException
Returns the next drawing outline part. It is necessary to call the Reset method before iterating with the NextOutlinePart method.

Product Availability

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

Specified by:
nextOutlinePart in interface IGraphicsOutline
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
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.

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.

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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
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