com.esri.arcgis.display
Class RepresentationRule

java.lang.Object
  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, java.io.Externalizable, java.io.Serializable

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

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

Description 'An object defining a representation rule.' 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.display.IRepresentationRule2

IID, IIDbc4b25e7_e952_4b66_8606_0b5a315ab42b, xxDummy

Fields inherited from interface com.esri.arcgis.display.IRepresentationRule

IID2b7be3ab_bb72_49d0_a6ee_63acd1f9068c

Fields inherited from interface com.esri.arcgis.display.IRepresentationRuleInit

IID, IID7fe42275_2a90_4a53_af60_71453bc5e6cd, xxDummy

Fields inherited from interface com.esri.arcgis.display.IMapLevel

IID, IIDcef72580_c1d9_11d2_9888_0080c7e04196, xxDummy

Fields inherited from interface com.esri.arcgis.display.IGeometricEffect

IID, IIDa5a4ca1c_1164_4dc4_ae82_5611a8f807e5, xxDummy

Fields inherited from interface com.esri.arcgis.display.IGeometricEffects

IID, IID6f68089c_1026_4ba3_8930_a52d62eec539, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDrawingOutline

IID, IID5b50cf13_4f70_4bed_b1b7_55f3aa8d26f8, xxDummy

Fields inherited from interface com.esri.arcgis.display.IFieldOverrides

IID, IIDdc3e1eba_3de0_4deb_b063_218a3e381efe, 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

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, 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.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

RepresentationRule()
Constructs a RepresentationRule using ArcGIS Engine.

RepresentationRule(java.lang.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, java.lang.String fieldName) Creates an explicit override with field content.
void	assign(IClone src) Assigns the properties of src to the receiver.
java.lang.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(java.lang.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) Constructs 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 java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
java.lang.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) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if 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(java.io.ObjectInput in)
void	release() Release a RepresentationRule.
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(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

RepresentationRule

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

Constructs a RepresentationRule using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RepresentationRule

public RepresentationRule(java.lang.Object obj)
                   throws java.io.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:

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

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getLayerCount

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

Number of layers in the representation rule.

Specified by:

getLayerCount in interface IRepresentationRule

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

public IBasicSymbol getLayer(int index)
                      throws java.io.IOException,
                             AutomationException

Layer at a given index.

Specified by:

getLayer in interface IRepresentationRule

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertLayer

public void insertLayer(int index,
                        IBasicSymbol symbol)
                 throws java.io.IOException,
                        AutomationException

Adds a layer to the representation rule.

Specified by:

insertLayer in interface IRepresentationRule

Parameters:

index - The index (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeLayer

public void removeLayer(int index)
                 throws java.io.IOException,
                        AutomationException

Removes a layer from the representation rule.

Specified by:

removeLayer in interface IRepresentationRule

Parameters:

index - The index (in)

Throws:

java.io.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 java.io.IOException,
                 AutomationException

Draws a layer of a representation rule. If index is -1, all layers are drawn.

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:

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

AutomationException - If the ArcObject component throws an exception.

getIDFromAttributes

public int getIDFromAttributes(IGraphicAttributes attrList)
                        throws java.io.IOException,
                               AutomationException

Retrieves the identifier of an attribute list.

Specified by:

getIDFromAttributes in interface IRepresentationRule2

Parameters:

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

Returns:

The attrListID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAttributesFromID

public IGraphicAttributes getAttributesFromID(int attrListID)
                                       throws java.io.IOException,
                                              AutomationException

Retrieves the attribute list from an identifier.

Specified by:

getAttributesFromID in interface IRepresentationRule2

Parameters:

attrListID - The attrListID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureSeed

public void setFeatureSeed(int featureOID)
                    throws java.io.IOException,
                           AutomationException

Seed value to ensure stability of random effects. When drawing features, the object ID is used.

Specified by:

setFeatureSeed in interface IRepresentationRule2

Parameters:

featureOID - The featureOID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureSeed

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

Seed value to ensure stability of random effects. When drawing features, the object ID is used.

Specified by:

getFeatureSeed in interface IRepresentationRule2

Returns:

The featureOID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initWithSymbol

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

Initializes the representation rule with a symbol.

Specified by:

initWithSymbol in interface IRepresentationRuleInit

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.

getMapLevel

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

Current map level for drawing multi-level symbols.

Specified by:

getMapLevel in interface IMapLevel

Returns:

The mapLevel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException

Current map level for drawing multi-level symbols.

Specified by:

setMapLevel in interface IMapLevel

Parameters:

mapLevel - The mapLevel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputType

public int getOutputType(int inputType)
                  throws java.io.IOException,
                         AutomationException

The output type of the geometric effect.

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:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Resets the collection of generated geometries. Must be called before using NextGeometry.

Specified by:

reset in interface IGeometricEffect

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.

nextGeometry

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

Accesses the next geometry generated by th effect.

Specified by:

nextGeometry in interface IGeometricEffect

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.

getCount

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

Number of geometric effects.

Specified by:

getCount in interface IGeometricEffects

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElement

public IGeometricEffect getElement(int index)
                            throws java.io.IOException,
                                   AutomationException

The geometric effect at the specified position.

Specified by:

getElement in interface IGeometricEffects

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insert

public void insert(int index,
                   IGeometricEffect geomEffect)
            throws java.io.IOException,
                   AutomationException

Inserts a new geometric effect.

Specified by:

insert in interface IGeometricEffects

Parameters:

index - The index (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(IGeometricEffect geomEffect)
         throws java.io.IOException,
                AutomationException

Adds a new geometric effect.

Specified by:

add in interface IGeometricEffects

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws java.io.IOException,
                   AutomationException

Removes a geometric effect.

Specified by:

remove in interface IGeometricEffects

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws java.io.IOException,
                      AutomationException

Removes all geometric effects.

Specified by:

removeAll in interface IGeometricEffects

Throws:

java.io.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 java.io.IOException,
                       AutomationException

Tests if a point is located on the drawing outline.

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:

java.io.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 java.io.IOException,
                                    AutomationException

Constructs the entire drawing outline of a drawing rule.

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:

java.io.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 java.io.IOException,
                  AutomationException

Resets the outline part enumeration.

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:

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

Retrieves the next part of the outline.

Specified by:

nextOutlinePart in interface IDrawingOutline

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.

add

public void add(IGraphicAttributes attributes,
                int graphicAttributeIndex,
                java.lang.String fieldName)
         throws java.io.IOException,
                AutomationException

Creates an explicit override with field content. To erase an existing field override, pass in blank field name.

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:

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

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException

Resets the override collection, before calling Next.

Specified by:

reset in interface IFieldOverrides

Throws:

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

AutomationException - If the ArcObject component throws an exception.

next

public IFieldOverride next()
                    throws java.io.IOException,
                           AutomationException

Accesses the next field override in the collection.

Specified by:

next in interface IFieldOverrides

Returns:

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

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.

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.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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.

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.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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