com.esri.arcgis.geodatabasedistributed
Class GdbExporter

java.lang.Object
  com.esri.arcgis.geodatabasedistributed.GdbExporter

All Implemented Interfaces:

IGdbXmlExport, IXMLDocumentVersion, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GdbExporter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGdbXmlExport, IXMLDocumentVersion

Esri Geodatabase Exporter object.

Remarks

Use the GdbExporter coclass when you wish to export schema and data or just schema from a geodatabase to an XML document. Once the XML document is created, information about the PGDB or ArcSDE geodatabase is stored in XML and can be imported back to a PGDB or ArcSDE geodatabase. See the IGdbXMLExport methods for more on getting information about exporting geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

GdbImporter, Serialized Form

Constructor Summary

GdbExporter()
Constructs a GdbExporter using ArcGIS Engine.

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

Method Summary

void	addIFeatureProgressListener(IFeatureProgress theListener) addIFeatureProgressListener.
void	addIGdbXmlExportEventsListener(IGdbXmlExportEvents theListener) addIGdbXmlExportEventsListener.
void	addIOperationProgressListener(IOperationProgress theListener) addIOperationProgressListener.
boolean	equals(Object o) Compare this object with another
void	exportDatasets(IEnumNameMapping enumNameMapping, String outFile, boolean binaryGeometry, boolean compressed, boolean retrieveMetadata) Exports datasets to XML.
void	exportDatasetsSchema(IEnumNameMapping enumNameMapping, String outFile, boolean compressed, boolean retrieveMetadata) Exports datasets schema to XML.
void	exportRecordSet(ITableName pTableName, String outFile, boolean binaryGeometry, boolean compressed) Exports a single tabular dataset to XML.
void	exportWorkspace(IWorkspace workspace, String outFile, boolean binaryGeometry, boolean compressed, boolean retrieveMetadata) Exports a workspace to XML.
void	exportWorkspaceSchema(IWorkspace workspace, String outFile, boolean compressed, boolean retrieveMetadata) Exports a workspace schema to XML.
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	removeIFeatureProgressListener(IFeatureProgress theListener) removeIFeatureProgressListener.
void	removeIGdbXmlExportEventsListener(IGdbXmlExportEvents theListener) removeIGdbXmlExportEventsListener.
void	removeIOperationProgressListener(IOperationProgress theListener) removeIOperationProgressListener.
void	setNamespaceToExportTo(String rhs1) The namespace (version) to export to.

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

GdbExporter

public GdbExporter()
            throws IOException,
                   UnknownHostException

Constructs a GdbExporter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GdbExporter

public GdbExporter(Object obj)
            throws IOException

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

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

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

addIFeatureProgressListener

public void addIFeatureProgressListener(IFeatureProgress theListener)
                                 throws IOException

addIFeatureProgressListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabase.IFeatureProgress interface.

Throws:

IOException - If there are communications problems.

removeIFeatureProgressListener

public void removeIFeatureProgressListener(IFeatureProgress theListener)
                                    throws IOException

removeIFeatureProgressListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabase.IFeatureProgress interface.

Throws:

IOException - If there are communications problems.

addIOperationProgressListener

public void addIOperationProgressListener(IOperationProgress theListener)
                                   throws IOException

addIOperationProgressListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabasedistributed.IOperationProgress interface.

Throws:

IOException - If there are communications problems.

removeIOperationProgressListener

public void removeIOperationProgressListener(IOperationProgress theListener)
                                      throws IOException

removeIOperationProgressListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabasedistributed.IOperationProgress interface.

Throws:

IOException - If there are communications problems.

addIGdbXmlExportEventsListener

public void addIGdbXmlExportEventsListener(IGdbXmlExportEvents theListener)
                                    throws IOException

addIGdbXmlExportEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabasedistributed.IGdbXmlExportEvents interface.

Throws:

IOException - If there are communications problems.

removeIGdbXmlExportEventsListener

public void removeIGdbXmlExportEventsListener(IGdbXmlExportEvents theListener)
                                       throws IOException

removeIGdbXmlExportEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.geodatabasedistributed.IGdbXmlExportEvents interface.

Throws:

IOException - If there are communications problems.

exportWorkspace

public void exportWorkspace(IWorkspace workspace,
                            String outFile,
                            boolean binaryGeometry,
                            boolean compressed,
                            boolean retrieveMetadata)
                     throws IOException,
                            AutomationException

Exports a workspace to XML.

Remarks

The ExportWorkspace method exports a geodatabase workspace schema and data.

In order to export a workspace, you need to pass in IWorkspace. The outFile is a string that identifies the output XML filename. The filename must have a "xml" file extension, for example, "C:\temp\file.xml".

If you set binaryGeometry to TRUE, the exported workspace will be in binary format. Otherwise, the workspace will be in normalized format.

If you set compressed to TRUE, the outFile file extension must be set to ".ZIP" or ".Z".

If you set retrieveMetadata to TRUE, the resulting XML file will contain metadata. Metadata must be created prior to exporting.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

exportWorkspace in interface IGdbXmlExport

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

outFile - The outFile (in)

binaryGeometry - The binaryGeometry (in)

compressed - The compressed (in)

retrieveMetadata - The retrieveMetadata (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportWorkspaceSchema

public void exportWorkspaceSchema(IWorkspace workspace,
                                  String outFile,
                                  boolean compressed,
                                  boolean retrieveMetadata)
                           throws IOException,
                                  AutomationException

Exports a workspace schema to XML.

Remarks

The ExportWorkspaceSchema method exports workspace schema only.

In order to export a workspace, you need to pass in IWorkspace. The outFile is a string that identifies the output XML filename. The filename must have a "xml" file extension, for example, "C:\temp\file.xml".

If you set compressed to TRUE, the outFile file extension must be set to ".ZIP" or ".Z".

If you set retrieveMetadata to TRUE, the resulting XML file will contain metadata. Metadata must be created prior to exporting.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

exportWorkspaceSchema in interface IGdbXmlExport

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

outFile - The outFile (in)

compressed - The compressed (in)

retrieveMetadata - The retrieveMetadata (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportDatasets

public void exportDatasets(IEnumNameMapping enumNameMapping,
                           String outFile,
                           boolean binaryGeometry,
                           boolean compressed,
                           boolean retrieveMetadata)
                    throws IOException,
                           AutomationException

Exports datasets to XML.

Remarks

The ExportDatasets method exports workspace schema and data.

In order to export datasets, you need to pass in IEnumNameMapping. The outFile is a string that identifies the output XML filename. The filename must have a "xml" file extension, for example, "C:\temp\file.xml".

If you set binaryGeometry to TRUE, the exported workspace will be in binary format. Otherwise, the workspace will be in normalized format.

If you set compressed to TRUE, the outFile file extension must be set to .ZIP or .Z.

If you set retrieveMetadata to TRUE, the resulting XML file will contain metadata. Metadata must be created prior to exporting.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

exportDatasets in interface IGdbXmlExport

Parameters:

enumNameMapping - A reference to a com.esri.arcgis.geodatabase.IEnumNameMapping (in)

outFile - The outFile (in)

binaryGeometry - The binaryGeometry (in)

compressed - The compressed (in)

retrieveMetadata - The retrieveMetadata (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportDatasetsSchema

public void exportDatasetsSchema(IEnumNameMapping enumNameMapping,
                                 String outFile,
                                 boolean compressed,
                                 boolean retrieveMetadata)
                          throws IOException,
                                 AutomationException

Exports datasets schema to XML.

Remarks

The ExportDatasetsSchema method exports workspace schema only.

In order to export datasets schema, you need to pass in IEnumNameMapping. The outFile is a string that identifies the output XML filename. The filename must have a "xml" file extension, for example, "C:\temp\file.xml".

If you set compressed to TRUE, the outFile file extension must be set to .ZIP or .Z.

If you set retrieveMetadata to TRUE, the resulting XML file will contain metadata. Metadata must be created prior to exporting.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

exportDatasetsSchema in interface IGdbXmlExport

Parameters:

enumNameMapping - A reference to a com.esri.arcgis.geodatabase.IEnumNameMapping (in)

outFile - The outFile (in)

compressed - The compressed (in)

retrieveMetadata - The retrieveMetadata (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportRecordSet

public void exportRecordSet(ITableName pTableName,
                            String outFile,
                            boolean binaryGeometry,
                            boolean compressed)
                     throws IOException,
                            AutomationException

Exports a single tabular dataset to XML.

Remarks

The ExportRecordSet method exports a recordset.

In order to export recordset, you need to pass in ITableName. The outFile is a string that identifies the output XML filename. The filename must have a "xml" file extension, for example, "C:\temp\file.xml".

If you set binaryGeometry to TRUE, the exported workspace will be in binary format. Otherwise, the workspace will be in normalized format.

If you set compressed to TRUE, the outFile file extension must be set to .ZIP or .Z.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

exportRecordSet in interface IGdbXmlExport

Parameters:

pTableName - A reference to a com.esri.arcgis.geodatabase.ITableName (in)

outFile - The outFile (in)

binaryGeometry - The binaryGeometry (in)

compressed - The compressed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNamespaceToExportTo

public void setNamespaceToExportTo(String rhs1)
                            throws IOException,
                                   AutomationException

The namespace (version) to export to.

Product Availability

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

Specified by:

setNamespaceToExportTo in interface IXMLDocumentVersion

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.