com.esri.arcgis.geodatabasedistributed
Interface IGDSExportOptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
GDSExportOptions

public interface IGDSExportOptions
extends Serializable

Provides access to methods that control replica export.

Remarks

The IGDSExportOptions interface has properties that define how to export from a GeoDataServer.

Product Availability

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


Method Summary
 int getExportFormat()
          The format to export to.
 boolean isBinaryGeometry()
          Indicates if the geometry should be exported in binary format (valid for XML export).
 boolean isCompressed()
          Indicates whether the data should be compressed.
 void setBinaryGeometry(boolean binaryGeometry)
          Indicates if the geometry should be exported in binary format (valid for XML export).
 void setCompressed(boolean comp)
          Indicates whether the data should be compressed.
 void setExportFormat(int exportFormat)
          The format to export to.
 

Method Detail

getExportFormat

int getExportFormat()
                    throws IOException,
                           AutomationException
The format to export to.

Remarks

The format to use when exporting. Note that when using esriGDSExportFormatFileGDB or esriGDSExportFormatFileGDBTransport, the output is always compressed regardless of the IGDSExportOptions::Compressed property is set.

Product Availability

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

Returns:
A com.esri.arcgis.geodatabasedistributed.esriGDSExportFormat constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExportFormat

void setExportFormat(int exportFormat)
                     throws IOException,
                            AutomationException
The format to export to.

Remarks

The ExportFormat property returns a format type. The ExportFormat enumeration is used to specify the type of file format.

esriGDSExportFormat include the following:

0 - esriGDSExportFormatPersonalGDB

1 - esriGDSExportFormatXml

2 - esriGDSExportFormatFileGDB

Product Availability

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

Parameters:
exportFormat - A com.esri.arcgis.geodatabasedistributed.esriGDSExportFormat constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCompressed

boolean isCompressed()
                     throws IOException,
                            AutomationException
Indicates whether the data should be compressed.

Product Availability

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

Returns:
The comp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCompressed

void setCompressed(boolean comp)
                   throws IOException,
                          AutomationException
Indicates whether the data should be compressed.

Product Availability

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

Parameters:
comp - The comp (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBinaryGeometry

boolean isBinaryGeometry()
                         throws IOException,
                                AutomationException
Indicates if the geometry should be exported in binary format (valid for XML export).

Remarks

The BinaryGeometry method will determine what kind of geometry (binary or normalized) will be used. This setting is only used if the format is XML.

Product Availability

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

Returns:
The binaryGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBinaryGeometry

void setBinaryGeometry(boolean binaryGeometry)
                       throws IOException,
                              AutomationException
Indicates if the geometry should be exported in binary format (valid for XML export).

Remarks

The BinaryGeometry property returns a boolean. The Binarygeometry property is used to specify binary or normalized geometry.

Product Availability

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

Parameters:
binaryGeometry - The binaryGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.