com.esri.arcgis.geodatabasedistributed
Class GDSExportOptions

java.lang.Object
  extended by com.esri.arcgis.geodatabasedistributed.GDSExportOptions
All Implemented Interfaces:
IGDSExportOptions, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class GDSExportOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGDSExportOptions, IXMLSerialize, IPersistStream, IPersist, IXMLVersionSupport, Externalizable

An object used to specify GeoDataServer export options.

Remarks

The GDSExportOptions coclass allows you to specify export options when exporting from a GeoDataServer. This includes operations such as data extration, replica creation and exporting data changes.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
GDSExportOptions()
          Constructs a GDSExportOptions using ArcGIS Engine.
GDSExportOptions(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GDSExportOptions theGDSExportOptions = (GDSExportOptions) obj;
 
Method Summary
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getExportFormat()
          The format to export to.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 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 isDirty()
          isDirty
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 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.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

GDSExportOptions

public GDSExportOptions()
                 throws IOException,
                        UnknownHostException
Constructs a GDSExportOptions using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GDSExportOptions

public GDSExportOptions(Object obj)
                 throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GDSExportOptions theGDSExportOptions = (GDSExportOptions) obj;

Construct a GDSExportOptions using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GDSExportOptions.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getExportFormat

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

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

setExportFormat

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

Specified by:
setExportFormat in interface IGDSExportOptions
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

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

Product Availability

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

Specified by:
isCompressed in interface IGDSExportOptions
Returns:
The comp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCompressed

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

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

isBinaryGeometry

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

Specified by:
isBinaryGeometry in interface IGDSExportOptions
Returns:
The binaryGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBinaryGeometry

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

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

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException