com.esri.arcgis.cartoUI
Class AVObjectConverter

java.lang.Object
  com.esri.arcgis.cartoUI.AVObjectConverter

All Implemented Interfaces:

IAVObjectConverter, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class AVObjectConverter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAVObjectConverter

An ArcView (3.x) object converter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

AVObjectConverter()
Constructs a AVObjectConverter using ArcGIS Engine.

AVObjectConverter(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AVObjectConverter theAVObjectConverter = (AVObjectConverter) obj;

Method Summary

IMap	connectToView(IAVObject viewObject) Returns the map associated with an AV view object.
IEnvelope	convertBounds(IAVObject rectObject, double xOrigin, double yOrigin) Converts an AV rectangle (or MapDpy) object to an envelope.
IColor	convertColor(IAVObject colorObject) Converts an AV color object.
IElement	convertElement(IAVObject graphicObject, double xOrigin, double yOrigin, short pass, IGraphicsContainer gContainer) Converts an AV graphic object into an element.
Font	convertFont(IAVObject fontObject) Converts an AV font object.
IGeometry	convertGeometry(IAVObject shapeObject, double xOrigin, double yOrigin) Converts an AV shape object to a geometry object.
IFeatureRenderer	convertLegend(IAVObject legendObject) Returns a Renderer from an ArcView legend object.
ISpatialReference	convertProjection(IAVObject projectionObj) Converts an AV projection object to a spatial reference object.
ISymbol	convertSymbol(IAVObject symbolObj) Returns a symbol from an ArcView symbol object.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IMap	getMap(int index) The converted map at the given index.
int	getMapCount() The number of maps converted.
int	hashCode() the hashcode for this object
void	importLayout(String layoutName, IPageLayout pLayout) Imports a layout from an APR file.
void	importView(String viewName, IMap pMap) Imports a view from an APR file.
IAVObject	nextObject() Returns the next object in the project.
IFeatureClass	queryFeatureClass(IAVObject fThemeObject) Returns a feature class with the same properties as the input feature theme object.
IAVObject	queryObjectByID(int objID) Returns the object specified by the given object id.
IAVObject	queryObjectProperty(IAVObject obj, String propertyName) Returns the named property object associated with the given object.
void	readObjects(String filePath) Reads an ArcView 3.x ODL file.
void	reset() Resets the enumerator.
void	setFeatureSymbology(IAVObject themeObject, IFeatureLayer flayer) Sets the layer symbology for a given feature layer, based on a feature theme's legend.

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

AVObjectConverter

public AVObjectConverter()
                  throws IOException,
                         UnknownHostException

Constructs a AVObjectConverter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AVObjectConverter

public AVObjectConverter(Object obj)
                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AVObjectConverter theAVObjectConverter = (AVObjectConverter) obj;

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

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

readObjects

public void readObjects(String filePath)
                 throws IOException,
                        AutomationException

Reads an ArcView 3.x ODL file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

readObjects in interface IAVObjectConverter

Parameters:

filePath - The filePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextObject

public IAVObject nextObject()
                     throws IOException,
                            AutomationException

Returns the next object in the project.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

nextObject in interface IAVObjectConverter

Returns:

A reference to a com.esri.arcgis.cartoUI.IAVObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Resets the enumerator.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

reset in interface IAVObjectConverter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importView

public void importView(String viewName,
                       IMap pMap)
                throws IOException,
                       AutomationException

Imports a view from an APR file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

importView in interface IAVObjectConverter

Parameters:

viewName - The viewName (in)

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

importLayout

public void importLayout(String layoutName,
                         IPageLayout pLayout)
                  throws IOException,
                         AutomationException

Imports a layout from an APR file.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

importLayout in interface IAVObjectConverter

Parameters:

layoutName - The layoutName (in)

pLayout - A reference to a com.esri.arcgis.carto.IPageLayout (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryObjectProperty

public IAVObject queryObjectProperty(IAVObject obj,
                                     String propertyName)
                              throws IOException,
                                     AutomationException

Returns the named property object associated with the given object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

queryObjectProperty in interface IAVObjectConverter

Parameters:

obj - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

propertyName - The propertyName (in)

Returns:

A reference to a com.esri.arcgis.cartoUI.IAVObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryObjectByID

public IAVObject queryObjectByID(int objID)
                          throws IOException,
                                 AutomationException

Returns the object specified by the given object id.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

queryObjectByID in interface IAVObjectConverter

Parameters:

objID - The objID (in)

Returns:

A reference to a com.esri.arcgis.cartoUI.IAVObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryFeatureClass

public IFeatureClass queryFeatureClass(IAVObject fThemeObject)
                                throws IOException,
                                       AutomationException

Returns a feature class with the same properties as the input feature theme object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

queryFeatureClass in interface IAVObjectConverter

Parameters:

fThemeObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureSymbology

public void setFeatureSymbology(IAVObject themeObject,
                                IFeatureLayer flayer)
                         throws IOException,
                                AutomationException

Sets the layer symbology for a given feature layer, based on a feature theme's legend.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setFeatureSymbology in interface IAVObjectConverter

Parameters:

themeObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

flayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertLegend

public IFeatureRenderer convertLegend(IAVObject legendObject)
                               throws IOException,
                                      AutomationException

Returns a Renderer from an ArcView legend object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

convertLegend in interface IAVObjectConverter

Parameters:

legendObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.carto.IFeatureRenderer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertSymbol

public ISymbol convertSymbol(IAVObject symbolObj)
                      throws IOException,
                             AutomationException

Returns a symbol from an ArcView symbol object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

convertSymbol in interface IAVObjectConverter

Parameters:

symbolObj - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertColor

public IColor convertColor(IAVObject colorObject)
                    throws IOException,
                           AutomationException

Converts an AV color object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

convertColor in interface IAVObjectConverter

Parameters:

colorObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertFont

public Font convertFont(IAVObject fontObject)
                 throws IOException,
                        AutomationException

Converts an AV font object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

convertFont in interface IAVObjectConverter

Parameters:

fontObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertElement

public IElement convertElement(IAVObject graphicObject,
                               double xOrigin,
                               double yOrigin,
                               short pass,
                               IGraphicsContainer gContainer)
                        throws IOException,
                               AutomationException

Converts an AV graphic object into an element. All elements except MapSurrounds are converted when 'pass' is 0. Only MapSurrounds are converted when 'pass' is 1.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

convertElement in interface IAVObjectConverter

Parameters:

graphicObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

xOrigin - The xOrigin (in)

yOrigin - The yOrigin (in)

pass - The pass (in)

gContainer - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)

Returns:

A reference to a com.esri.arcgis.carto.IElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertBounds

public IEnvelope convertBounds(IAVObject rectObject,
                               double xOrigin,
                               double yOrigin)
                        throws IOException,
                               AutomationException

Converts an AV rectangle (or MapDpy) object to an envelope.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

convertBounds in interface IAVObjectConverter

Parameters:

rectObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

xOrigin - The xOrigin (in)

yOrigin - The yOrigin (in)

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertGeometry

public IGeometry convertGeometry(IAVObject shapeObject,
                                 double xOrigin,
                                 double yOrigin)
                          throws IOException,
                                 AutomationException

Converts an AV shape object to a geometry object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

convertGeometry in interface IAVObjectConverter

Parameters:

shapeObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

xOrigin - The xOrigin (in)

yOrigin - The yOrigin (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.

convertProjection

public ISpatialReference convertProjection(IAVObject projectionObj)
                                    throws IOException,
                                           AutomationException

Converts an AV projection object to a spatial reference object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

convertProjection in interface IAVObjectConverter

Parameters:

projectionObj - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connectToView

public IMap connectToView(IAVObject viewObject)
                   throws IOException,
                          AutomationException

Returns the map associated with an AV view object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

connectToView in interface IAVObjectConverter

Parameters:

viewObject - A reference to a com.esri.arcgis.cartoUI.IAVObject (in)

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapCount

public int getMapCount()
                throws IOException,
                       AutomationException

The number of maps converted.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getMapCount in interface IAVObjectConverter

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap(int index)
            throws IOException,
                   AutomationException

The converted map at the given index.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getMap in interface IAVObjectConverter

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.IMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.