com.esri.arcgis.geodatabasedistributed
Interface IGDSData

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGDSData2

All Known Implementing Classes:

GDSData

public interface IGDSData
extends Serializable

Provides access to methods supported by a GDSReplicaData object.

Remarks

The IGDSData interface is provides proprties that define how data is exported from or imported into a GeoDataServer. See the GDSData coclass for more information.

Product Availability

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

Method Summary

IPropertySet	getConnectionProperties() The properties to be used when downloading the data (if transport type is URL).
byte[]	getEmbeddedData() The embedded replica data.
int	getTransportType() The transport type used to transfer the replica data.
String	getURL() The url where the replica data is located.
boolean	isCompressed() Indicates whether the data has been compressed.
void	setCompressed(boolean comp) Indicates whether the data has been compressed.
void	setConnectionPropertiesByRef(IPropertySet connProps) The properties to be used when downloading the data (if transport type is URL).
void	setEmbeddedData(byte[] data) The embedded replica data.
void	setTransportType(int pTransport) The transport type used to transfer the replica data.
void	setURL(String uRL) The url where the replica data is located.

Method Detail

isCompressed

boolean isCompressed()
                     throws IOException,
                            AutomationException

Indicates whether the data has been compressed.

Remarks

The get_Compressed method returns whether the data has been compressed. Compressed data is stored in the .zip format.

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 has been 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.

getTransportType

int getTransportType()
                     throws IOException,
                            AutomationException

The transport type used to transfer the replica data.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransportType

void setTransportType(int pTransport)
                      throws IOException,
                             AutomationException

The transport type used to transfer the replica data.

Remarks

The TransportType method returns a compression type. The CompressionType enumeration is used to specify the type of compression.

esriTransportType include the following:

0 - esriGDSTransportTypeEmbedded

1 - esriGDSTransportTypeUrl

2 - esriGDSTransportTypeFile

Product Availability

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

Parameters:

pTransport - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURL

String getURL()
              throws IOException,
                     AutomationException

The url where the replica data is located.

Remarks

The URL is used to specify the location of the local or virtual directory where the data is located. This is not set when the TransportType of embedded.

Product Availability

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

Returns:

The uRL

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setURL

void setURL(String uRL)
            throws IOException,
                   AutomationException

The url where the replica data is located.

Remarks

The URL method returns a string. The URL is used to specify the location of the actual or virtual directory. Note: The default directory location is the Temp folder.

Product Availability

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

Parameters:

uRL - The uRL (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEmbeddedData

byte[] getEmbeddedData()
                       throws IOException,
                              AutomationException

The embedded replica data.

Remarks

The EmbeddedData property returns a byte array with the actual data if the transport type is embedded.

Product Availability

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

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmbeddedData

void setEmbeddedData(byte[] data)
                     throws IOException,
                            AutomationException

The embedded replica data.

Remarks

The EmbeddedData property returns a Byte. The EmbeddedData has a byte array with the actual data. The client needs to create a file with this array. This property is valid for GeoDataServer and GDSData coclasses. Note: The default directory location is the Temp folder.

Product Availability

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

Parameters:

data - An unsigned byte (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionPropertiesByRef

void setConnectionPropertiesByRef(IPropertySet connProps)
                                  throws IOException,
                                         AutomationException

The properties to be used when downloading the data (if transport type is URL).

Product Availability

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

Parameters:

connProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

IPropertySet getConnectionProperties()
                                     throws IOException,
                                            AutomationException

The properties to be used when downloading the data (if transport type is URL).

Remarks

The connection properties needed to connect to the URL specified in the IGDSData::URL property.

This property does not need to be set if the data is embedded or if the URL allows anonymous access. If the URL has http authentication enabled, then it is recommended you use an encrypted communication channel which can be enabled through ssl.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.