com.esri.arcgis.display
Class RepresentationRule

java.lang.Object
  extended by com.esri.arcgis.display.RepresentationRule
All Implemented Interfaces:
IDrawingOutline, IFieldOverrides, IGeometricEffect, IGeometricEffects, IMapLevel, IRepresentationRule, IRepresentationRule2, IRepresentationRuleInit, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class RepresentationRule
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRepresentationRule, IRepresentationRule2, IRepresentationRuleInit, IMapLevel, IGeometricEffect, IGeometricEffects, IDrawingOutline, IFieldOverrides, IPersist, IPersistStream, IClone, ISupportErrorInfo, IDocumentVersionSupportGEN, IXMLSerialize, IXMLVersionSupport, Externalizable

An object defining a representation rule.

Description

RepresentationRule object is a collection of basic symbols such as BasicLineSymbol, BasicFillSymbol and BasicMarkerSymbol along with MarkerPlacement used for representing features within a representationclass. Complex symbols can be created by incorporating one or more geometric effects into your rule.

Standard ArcGIS symbols such as SimpleMarkerSymbol, SimpleLineSymbol etc implementing ISymbol interface can also be converted to a representation rule using IRepresentationRuleInit interface. When a standard ArcGIS symbol is converted to a representation rule, it may contain either one or more basic symbol layers.

The graphic attributes present for a rule can be overriden using regular attribute fields.

Use IRepresentationRule interface to manage the individual symbol layer within a rule.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
RepresentationRule()
          Constructs a RepresentationRule using ArcGIS Engine.
RepresentationRule(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RepresentationRule theRepresentationRule = (RepresentationRule) obj;
 
Method Summary
 void add(IGeometricEffect geomEffect)
          Adds a new geometric effect.
 void add(IGraphicAttributes attributes, int graphicAttributeIndex, String fieldName)
          Creates an explicit override with field content.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void draw(int index, IOutputContext context, IGeometry geometry, IEnvelope envelope)
          Draws a layer of a representation rule.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 IGeometry getAllOutlineParts(IGeometry geometry, int type, int option, double buffer, IEnvelope clipEnvelope)
          Returns the entire drawing outline of a drawing rule.
 IGraphicAttributes getAttributesFromID(int attrListID)
          Retrieves the attribute list from an identifier.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getCount()
          Number of geometric effects.
 IGeometricEffect getElement(int index)
          The geometric effect at the specified position.
 int getFeatureSeed()
          Seed value to ensure stability of random effects.
 int getIDFromAttributes(IGraphicAttributes attrList)
          Retrieves the identifier of an attribute list.
 IBasicSymbol getLayer(int index)
          Layer at a given index.
 int getLayerCount()
          Number of layers in the representation rule.
 int getMapLevel()
          Current map level for drawing multi-level symbols.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 int getOutputType(int inputType)
          The output type of the geometric effect.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 boolean hitTest(IGeometry geometry, IPoint point, double tolerance)
          Tests if a point is located on the drawing outline.
 void initWithSymbol(ISymbol symbol)
          Initializes the representation rule with a symbol.
 void insert(int index, IGeometricEffect geomEffect)
          Inserts a new geometric effect.
 void insertLayer(int index, IBasicSymbol symbol)
          Adds a layer to the representation rule.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 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
 IFieldOverride next()
          Accesses the next field override in the collection.
 IGeometry nextGeometry()
          Accesses the next geometry generated by th effect.
 IGeometry nextOutlinePart()
          Retrieves the next part of the outline.
 void readExternal(ObjectInput in)
           
 void remove(int index)
          Removes a geometric effect.
 void removeAll()
          Removes all geometric effects.
 void removeLayer(int index)
          Removes a layer from the representation rule.
 void reset()
          Resets the override collection, before calling Next.
 void reset(IGeometry geometry)
          Resets the collection of generated geometries.
 void reset(IGeometry geometry, int type, int option, double buffer, IEnvelope clipEnvelope)
          Resets the outline part enumeration.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setFeatureSeed(int featureOID)
          Seed value to ensure stability of random effects.
 void setMapLevel(int mapLevel)
          Current map level for drawing multi-level symbols.
 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

RepresentationRule

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

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

RepresentationRule

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

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

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

getLayerCount

public int getLayerCount()
                  throws IOException,
                         AutomationException
Number of layers in the representation rule.

Product Availability

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

Specified by:
getLayerCount in interface IRepresentationRule
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public IBasicSymbol getLayer(int index)
                      throws IOException,
                             AutomationException
Layer at a given index.

Product Availability

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

Specified by:
getLayer in interface IRepresentationRule
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.IBasicSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertLayer

public void insertLayer(int index,
                        IBasicSymbol symbol)
                 throws IOException,
                        AutomationException
Adds a layer to the representation rule.

Product Availability

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

Specified by:
insertLayer in interface IRepresentationRule
Parameters:
index - The index (in)
symbol - A reference to a com.esri.arcgis.display.IBasicSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeLayer

public void removeLayer(int index)
                 throws IOException,
                        AutomationException
Removes a layer from the representation rule.

Remarks

If RemoveLayer method is used to remove the very last symbol layer present in a representation rule, it is the responsibility of the developer to add atleast one symbol layer. Use InsertLayer or IRepresentationRuleInit::InitWithSymbol methods to achieve this.

Product Availability

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

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

draw

public void draw(int index,
                 IOutputContext context,
                 IGeometry geometry,
                 IEnvelope envelope)
          throws IOException,
                 AutomationException
Draws a layer of a representation rule. If index is -1, all layers are drawn.

Product Availability

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

Specified by:
draw in interface IRepresentationRule
Parameters:
index - The index (in)
context - A reference to a com.esri.arcgis.display.IOutputContext (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (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.

getIDFromAttributes

public int getIDFromAttributes(IGraphicAttributes attrList)
                        throws IOException,
                               AutomationException
Retrieves the identifier of an attribute list.

Product Availability

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

Specified by:
getIDFromAttributes in interface IRepresentationRule2
Parameters:
attrList - A reference to a com.esri.arcgis.display.IGraphicAttributes (in)
Returns:
The attrListID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributesFromID

public IGraphicAttributes getAttributesFromID(int attrListID)
                                       throws IOException,
                                              AutomationException
Retrieves the attribute list from an identifier.

Product Availability

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

Specified by:
getAttributesFromID in interface IRepresentationRule2
Parameters:
attrListID - The attrListID (in)
Returns:
A reference to a com.esri.arcgis.display.IGraphicAttributes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureSeed

public void setFeatureSeed(int featureOID)
                    throws IOException,
                           AutomationException
Seed value to ensure stability of random effects. When drawing features, the object ID is used.

Product Availability

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

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

getFeatureSeed

public int getFeatureSeed()
                   throws IOException,
                          AutomationException
Seed value to ensure stability of random effects. When drawing features, the object ID is used.

Product Availability

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

Specified by:
getFeatureSeed in interface IRepresentationRule2
Returns:
The featureOID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initWithSymbol

public void initWithSymbol(ISymbol symbol)
                    throws IOException,
                           AutomationException
Initializes the representation rule with a symbol.

Remarks

Use this piece of code to create and initilize a regular ArcGIS symbol to a RepresentationRule object.

Public Sub RepRuleInit()

      Dim pRepresentationRules As IRepresentationRules

      Dim pDiamond As ISimpleMarkerSymbol

      Dim pRepresentationRule As IRepresentationRule

      Dim pRepRuleInit As IRepresentationRuleInit

      Dim lDiamondID As Long



      'Create new RepresentationRules for this Representation Class

      Set pRepresentationRules = New RepresentationRules



      'Create new Simple Marker Symbol (diamond)

      Set pDiamond = New SimpleMarkerSymbol

      pDiamond.Style = esriSMSDiamond

      pDiamond.size = 4



      'Create a new RepresentationRule using a SimpleMarkerSymbol object that implements ISymbol interface and add to Collection

      Set pRepresentationRule = New RepresentationRule

      Set pRepRuleInit = pRepresentationRule

      pRepRuleInit.InitWithSymbol pDiamond

      'Initializes with standard ArcGIS symbols

      lDiamondID = pRepresentationRules.Add(pRepresentationRule)

      pRepresentationRules.Name(lDiamondID) = "diamond"

End Sub

Product Availability

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

Specified by:
initWithSymbol in interface IRepresentationRuleInit
Parameters:
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapLevel

public int getMapLevel()
                throws IOException,
                       AutomationException
Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMapLevel in interface IMapLevel
Returns:
The mapLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws IOException,
                        AutomationException
Current map level for drawing multi-level symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getOutputType

public int getOutputType(int inputType)
                  throws IOException,
                         AutomationException
The output type of the geometric effect.

Product Availability

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

Specified by:
getOutputType in interface IGeometricEffect
Parameters:
inputType - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset(IGeometry geometry)
           throws IOException,
                  AutomationException
Resets the collection of generated geometries. Must be called before using NextGeometry.

Product Availability

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

Specified by:
reset in interface IGeometricEffect
Parameters:
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.

nextGeometry

public IGeometry nextGeometry()
                       throws IOException,
                              AutomationException
Accesses the next geometry generated by th effect.

Product Availability

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

Specified by:
nextGeometry in interface IGeometricEffect
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.

getCount

public int getCount()
             throws IOException,
                    AutomationException
Number of geometric effects.

Product Availability

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

Specified by:
getCount in interface IGeometricEffects
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElement

public IGeometricEffect getElement(int index)
                            throws IOException,
                                   AutomationException
The geometric effect at the specified position.

Product Availability

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

Specified by:
getElement in interface IGeometricEffects
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.IGeometricEffect
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   IGeometricEffect geomEffect)
            throws IOException,
                   AutomationException
Inserts a new geometric effect.

Product Availability

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

Specified by:
insert in interface IGeometricEffects
Parameters:
index - The index (in)
geomEffect - A reference to a com.esri.arcgis.display.IGeometricEffect (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IGeometricEffect geomEffect)
         throws IOException,
                AutomationException
Adds a new geometric effect.

Product Availability

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

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

remove

public void remove(int index)
            throws IOException,
                   AutomationException
Removes a geometric effect.

Product Availability

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

Specified by:
remove in interface IGeometricEffects
Parameters:
index - The index (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 geometric effects.

Product Availability

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

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

hitTest

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

Product Availability

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

Specified by:
hitTest in interface IDrawingOutline
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
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(IGeometry geometry,
                                    int type,
                                    int option,
                                    double buffer,
                                    IEnvelope clipEnvelope)
                             throws IOException,
                                    AutomationException
Returns the entire drawing outline of a drawing rule.

Product Availability

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

Specified by:
getAllOutlineParts in interface IDrawingOutline
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
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(IGeometry geometry,
                  int type,
                  int option,
                  double buffer,
                  IEnvelope clipEnvelope)
           throws IOException,
                  AutomationException
Resets the outline part enumeration.

Product Availability

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

Specified by:
reset in interface IDrawingOutline
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
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
Retrieves the next part of the outline.

Product Availability

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

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

add

public void add(IGraphicAttributes attributes,
                int graphicAttributeIndex,
                String fieldName)
         throws IOException,
                AutomationException
Creates an explicit override with field content. To erase an existing field override, pass in blank field name.

Product Availability

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

Specified by:
add in interface IFieldOverrides
Parameters:
attributes - A reference to a com.esri.arcgis.display.IGraphicAttributes (in)
graphicAttributeIndex - The graphicAttributeIndex (in)
fieldName - The fieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Resets the override collection, before calling Next.

Product Availability

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

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

next

public IFieldOverride next()
                    throws IOException,
                           AutomationException
Accesses the next field override in the collection.

Product Availability

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

Specified by:
next in interface IFieldOverrides
Returns:
A reference to a com.esri.arcgis.display.IFieldOverride
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.

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.

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