com.esri.arcgis.geodatabasedistributed
Interface IGdbXmlExport

All Superinterfaces:

Serializable

All Known Implementing Classes:

GdbExporter

public interface IGdbXmlExport
extends Serializable

Provides access to members that support exporting a geodatabase to XML.

Remarks

The IGdbXmlExport interface provides five methods for exporting a geodatabase to an XML file. The ExportWorkspace method exports workspace and data while ExportWorkspaceSchema method exports workspace schema only. The ExportDatasets method exports workspace and data at the dataset level of a PGDB and ArcSDE geodatabase, while ExportDatasetsSchema method exports workspace schema only. The ExportRecordSet method exports a recordset.

Product Availability

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

See Also:

GdbExporter

Method Summary

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.

Method Detail

exportWorkspace

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

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

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

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

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

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

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

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

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

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.