com.esri.arcgis.geodatabasedistributed
Interface IGDSData

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GDSData, IGDSDataProxy

public interface IGDSData

extends java.io.Serializable

Provides access to methods supported by a GDSReplicaData object.

Product Availability

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

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.

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.
java.lang.String	getURL() The url where the replica data is located.
boolean	isCompressed() Returns whether the data has been compressed.
void	setCompressed(boolean comp) Returns 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(java.lang.String uRL) The url where the replica data is located.

Method Detail

isCompressed

public boolean isCompressed()
                     throws java.io.IOException,
                            AutomationException

Returns 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.

Returns:

The comp

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompressed

public void setCompressed(boolean comp)
                   throws java.io.IOException,
                          AutomationException

Returns whether the data has been compressed.

Parameters:

comp - The comp (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransportType

public int getTransportType()
                     throws java.io.IOException,
                            AutomationException

The transport type used to transfer the replica data.

Returns:

A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransportType

public void setTransportType(int pTransport)
                      throws java.io.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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURL

public java.lang.String getURL()
                        throws java.io.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.

Returns:

The uRL

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setURL

public void setURL(java.lang.String uRL)
            throws java.io.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.

Parameters:

uRL - The uRL (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEmbeddedData

public byte[] getEmbeddedData()
                       throws java.io.IOException,
                              AutomationException

The embedded replica data.

Remarks

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

Returns:

An unsigned byte

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmbeddedData

public void setEmbeddedData(byte[] data)
                     throws java.io.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.

Parameters:

data - An unsigned byte (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionPropertiesByRef

public void setConnectionPropertiesByRef(IPropertySet connProps)
                                  throws java.io.IOException,
                                         AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws java.io.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.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.