com.esri.arcgis.geodatabase
Class Representation

java.lang.Object
  extended by com.esri.arcgis.geodatabase.Representation
All Implemented Interfaces:
IGraphicsOutline, IOverride, IRepresentation, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class Representation
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRepresentation, IOverride, IGraphicsOutline, ISupportErrorInfo

COM Class 'Representation'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'A Feature Representation object.' 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
 
Fields inherited from interface com.esri.arcgis.geodatabase.IRepresentation
IID, IID2da11044_d45b_44ad_b982_d9b09c59928a, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IOverride
IID, IID60f814ef_730e_42a2_b043_bf28097a16d6, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IGraphicsOutline
IID, IID2af790ad_4539_43c8_870e_fa75a50b9988, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
Representation(java.lang.Object obj)
          Construct a Representation using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 IGeometry getAllOutlineParts(int type, int option, double buffer, IEnvelope clipEnvelope)
          Constructs the entire drawing outline of a graphics.
 IFeature getFeature()
          The feature associated with this representation.
 IRepresentationGraphics getGraphics()
          The Graphics object that describes the free representation.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IMapContext getMapContext()
          Map context in which the representation is defined.
 IRepresentationClass getRepresentationClass()
          The representation class to which this representation belongs.
 int getRuleID()
          Rule ID.
 IGeometry getShape()
          Representation geometry.
 IGeometry getShapeCopy()
          Copy of the representation geometry.
 IGeometry getShapeEdit()
          Representation geometry.
 java.lang.Object getValue(IGraphicAttributes attrs, int idx)
          The value of a representation property.
 int hashCode()
          the hashcode for this object
 boolean hitTest(IPoint point, double tolerance)
          Tests if a point is located on the graphics outline.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isHasAttributeOverride()
          Indicates if a graphical attribute is overriden.
 boolean isHasShapeOverride()
          Indicates if the shape is overriden.
 int isOverridenWithField(IGraphicAttributes attrs, int idx)
          Checks if the value of a graphical attribute comes from a feature field.
 IGeometry nextOutlinePart()
          Hands back the next drawing outline part.
 void release()
          Release a Representation.
 void removeOverride(IGraphicAttributes attrs, int idx)
          Removes a given override from the blob.
 void removeOverrides()
          Removes all attributes overrides from the representation.
 void removeShapeOverride()
          Removes the shape override.
 void reset(int type, int option, double buffer, IEnvelope clipEnvelope)
          Resets the collection of drawing outline parts to the beginning, before calling NextOutlinePart.
 void setGraphics(IRepresentationGraphics graphics)
          The Graphics object that describes the free representation.
 void setRuleID(int iD)
          Rule ID.
 void setShapeByRef(IGeometry shape)
          Representation geometry.
 void setValue(IGraphicAttributes attrs, int idx, java.lang.Object val)
          The value of a representation property.
 void updateFeature()
          Updates the feature fields with the information contained in the representation.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Representation

public Representation(java.lang.Object obj)
               throws java.io.IOException
Construct a Representation using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Representation.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
Representation o = (Representation)obj; // will not work

Representation o = new Representation(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems Representation theRepresentation = (Representation) obj;
Method Detail

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

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

getRepresentationClass

public IRepresentationClass getRepresentationClass()
                                            throws java.io.IOException,
                                                   AutomationException
The representation class to which this representation belongs.

Specified by:
getRepresentationClass in interface IRepresentation
Returns:
A reference to a com.esri.arcgis.geodatabase.IRepresentationClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeature

public IFeature getFeature()
                    throws java.io.IOException,
                           AutomationException
The feature associated with this representation.

Specified by:
getFeature in interface IRepresentation
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeature
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapContext

public IMapContext getMapContext()
                          throws java.io.IOException,
                                 AutomationException
Map context in which the representation is defined.

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

getRuleID

public int getRuleID()
              throws java.io.IOException,
                     AutomationException
Rule ID.

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

setRuleID

public void setRuleID(int iD)
               throws java.io.IOException,
                      AutomationException
Rule ID.

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

getShape

public IGeometry getShape()
                   throws java.io.IOException,
                          AutomationException
Representation geometry.

Specified by:
getShape in interface IRepresentation
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.

getShapeEdit

public IGeometry getShapeEdit()
                       throws java.io.IOException,
                              AutomationException
Representation geometry. This geometry can be a copy of the shape if the shape override option is active.

Specified by:
getShapeEdit in interface IRepresentation
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.

getShapeCopy

public IGeometry getShapeCopy()
                       throws java.io.IOException,
                              AutomationException
Copy of the representation geometry.

Specified by:
getShapeCopy in interface IRepresentation
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.

setShapeByRef

public void setShapeByRef(IGeometry shape)
                   throws java.io.IOException,
                          AutomationException
Representation geometry.

Specified by:
setShapeByRef in interface IRepresentation
Parameters:
shape - 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.

isHasShapeOverride

public boolean isHasShapeOverride()
                           throws java.io.IOException,
                                  AutomationException
Indicates if the shape is overriden.

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

removeShapeOverride

public void removeShapeOverride()
                         throws java.io.IOException,
                                AutomationException
Removes the shape override.

Specified by:
removeShapeOverride in interface IRepresentation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGraphics

public IRepresentationGraphics getGraphics()
                                    throws java.io.IOException,
                                           AutomationException
The Graphics object that describes the free representation.

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

setGraphics

public void setGraphics(IRepresentationGraphics graphics)
                 throws java.io.IOException,
                        AutomationException
The Graphics object that describes the free representation.

Specified by:
setGraphics in interface IRepresentation
Parameters:
graphics - A reference to a com.esri.arcgis.display.IRepresentationGraphics (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateFeature

public void updateFeature()
                   throws java.io.IOException,
                          AutomationException
Updates the feature fields with the information contained in the representation.

Specified by:
updateFeature in interface IRepresentation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

public java.lang.Object getValue(IGraphicAttributes attrs,
                                 int idx)
                          throws java.io.IOException,
                                 AutomationException
The value of a representation property.

Specified by:
getValue in interface IRepresentation
Parameters:
attrs - A reference to a com.esri.arcgis.display.IGraphicAttributes (in)
idx - The idx (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(IGraphicAttributes attrs,
                     int idx,
                     java.lang.Object val)
              throws java.io.IOException,
                     AutomationException
The value of a representation property.

Specified by:
setValue in interface IRepresentation
Parameters:
attrs - A reference to a com.esri.arcgis.display.IGraphicAttributes (in)
idx - The idx (in)
val - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeOverride

public void removeOverride(IGraphicAttributes attrs,
                           int idx)
                    throws java.io.IOException,
                           AutomationException
Removes a given override from the blob.

Specified by:
removeOverride in interface IOverride
Parameters:
attrs - A reference to a com.esri.arcgis.display.IGraphicAttributes (in)
idx - The idx (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverridenWithField

public int isOverridenWithField(IGraphicAttributes attrs,
                                int idx)
                         throws java.io.IOException,
                                AutomationException
Checks if the value of a graphical attribute comes from a feature field.

Specified by:
isOverridenWithField in interface IOverride
Parameters:
attrs - A reference to a com.esri.arcgis.display.IGraphicAttributes (in)
idx - The idx (in)
Returns:
The fldIdx
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeOverrides

public void removeOverrides()
                     throws java.io.IOException,
                            AutomationException
Removes all attributes overrides from the representation.

Specified by:
removeOverrides in interface IOverride
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasAttributeOverride

public boolean isHasAttributeOverride()
                               throws java.io.IOException,
                                      AutomationException
Indicates if a graphical attribute is overriden.

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

hitTest

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

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:
java.io.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 java.io.IOException,
                                    AutomationException
Constructs the entire drawing outline of a graphics.

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:
java.io.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 java.io.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.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

nextOutlinePart

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

Specified by:
nextOutlinePart in interface IGraphicsOutline
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.

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.