com.esri.arcgis.geodatabasedistributed
Interface IGdbXmlImport

All Superinterfaces:
Serializable
All Known Implementing Classes:
GdbImporter

public interface IGdbXmlImport
extends Serializable

Provides access to members that support importing a geodatabase from XML.

Remarks

The IGdbXmlImport has methods to specify importing a geodatabase workspace and recordset. The GenerateNameMapping method generates a name mapping enumeration where you pass in inFile, IWorkspace, and IEnumNameMapping. The ImportWorkspace method imports a geodatabase workspace schema and data. The ImportRecordSet method imports a geodatabase recordset. The GetRecordSetFields method retrieves recordset fields and records from resulting XML document.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
GdbImporter

Method Summary
 boolean generateNameMapping(String inFile, IWorkspace workspace, IEnumNameMapping[] enumNameMapping)
          Generate a list of objects to import.
 IFields getRecordSetFields(String inFile)
          Generate a fieldset to load from xml.
 void importRecordSet(String inFile, IFields sourceFields, IFields targetMappedFields, ITable pTable)
          Loading data from xml recordset.
 void importWorkspace(String inFile, IEnumNameMapping enumNameMapping, IWorkspace pWorkspace, boolean schemaOnly)
          Imports a workspace from XML.
 

Method Detail

generateNameMapping

boolean generateNameMapping(String inFile,
                            IWorkspace workspace,
                            IEnumNameMapping[] enumNameMapping)
                            throws IOException,
                                   AutomationException
Generate a list of objects to import.

Remarks

The GenerateNameMapping method generates a name mapping enumeration where you pass in inFile, IWorkspace, and IEnumNameMapping.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
inFile - The inFile (in)
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
enumNameMapping - A reference to a com.esri.arcgis.geodatabase.IEnumNameMapping (out: use single element array)
Returns:
The hasConflict
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

importWorkspace

void importWorkspace(String inFile,
                     IEnumNameMapping enumNameMapping,
                     IWorkspace pWorkspace,
                     boolean schemaOnly)
                     throws IOException,
                            AutomationException
Imports a workspace from XML.

Remarks

The ImportWorkspace method imports a geodatabase workspace schema and data.

In order to import a workspace, you need to pass in IEnumNameMapping and IWorkspace. The inFile is a string that identifies the input XML filename. The filename must have a "xml" file extension, for example, "c:\temp\file.xml". Otherwise, the inFile is a .ZIP or .Z file extension.

If you set schemaOnly to TRUE, the imported workspace will contain the schema and no data. Otherwise, the workspace being imported will contain schema and data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
inFile - The inFile (in)
enumNameMapping - A reference to a com.esri.arcgis.geodatabase.IEnumNameMapping (in)
pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
schemaOnly - The schemaOnly (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

importRecordSet

void importRecordSet(String inFile,
                     IFields sourceFields,
                     IFields targetMappedFields,
                     ITable pTable)
                     throws IOException,
                            AutomationException
Loading data from xml recordset.

Remarks

The ImportRecordSet method imports a geodatabase recordset.

In order to import a recordset, you need to pass in IFields and ITable. The inFile is a string that identifies the input XML filename. The filename must have a "xml" file extension, for example, "c:\temp\file.xml". Otherwise, the inFile is a .ZIP or .Z file extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
inFile - The inFile (in)
sourceFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
targetMappedFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRecordSetFields

IFields getRecordSetFields(String inFile)
                           throws IOException,
                                  AutomationException
Generate a fieldset to load from xml.

Remarks

The GetRecordSetFields method retrieves recordset fields and records from resulting XML file. You need to pass in inFile as a string that identifies the input XML file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
inFile - The inFile (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.