com.esri.arcgis.geodatabase
Class GPReplicaDataset

java.lang.Object
  extended by com.esri.arcgis.geodatabase.GPReplicaDataset
All Implemented Interfaces:
IGPReplicaDataset, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

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

A replica dataset.

Remarks

A class the represents a dataset that is part of a replica in a geodatabase.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
GPReplicaDataset()
          Constructs a GPReplicaDataset using ArcGIS Engine.
GPReplicaDataset(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPReplicaDataset theGPReplicaDataset = (GPReplicaDataset) 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 getDatasetType()
          The dataset type.
 String getDefQuery()
          Definition query for the replica dataset.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 String getName()
          The name of the dataset.
 String getRelDestinationClass()
          The destination class for the relationship class.
 int getRelExtractDirection()
          Defines the direction of the replicated relationship class.
 String getRelOriginClass()
          The origin class for the relationship class.
 int getRowsType()
          Defines the replicated rows.
 ILongArray getSelectionIDs()
          Array of selected IDs.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isPrivate()
          Indicates if the replica dataset is private.
 boolean isUseGeometry()
          Indicates if the geometry defined in the replica description is applied to the replica dataset.
 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 setDatasetType(int datasetType)
          The dataset type.
 void setDefQuery(String defQuery)
          Definition query for the replica dataset.
 void setIsPrivate(boolean isPrivate)
          Indicates if the replica dataset is private.
 void setName(String name)
          The name of the dataset.
 void setRelDestinationClass(String destClass)
          The destination class for the relationship class.
 void setRelExtractDirection(int relExtractDir)
          Defines the direction of the replicated relationship class.
 void setRelOriginClass(String originClass)
          The origin class for the relationship class.
 void setRowsType(int rowsType)
          Defines the replicated rows.
 void setSelectionIDsByRef(ILongArray longArray)
          Array of selected IDs.
 void setUseGeometry(boolean useGeometry)
          Indicates if the geometry defined in the replica description is applied to the replica dataset.
 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

GPReplicaDataset

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

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

GPReplicaDataset

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

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

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

setName

public void setName(String name)
             throws IOException,
                    AutomationException
The name of the dataset.

Product Availability

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

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

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the dataset.

Remarks

Returns the name of the dataset.

Product Availability

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

Specified by:
getName in interface IGPReplicaDataset
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDatasetType

public void setDatasetType(int datasetType)
                    throws IOException,
                           AutomationException
The dataset type.

Product Availability

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

Specified by:
setDatasetType in interface IGPReplicaDataset
Parameters:
datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatasetType

public int getDatasetType()
                   throws IOException,
                          AutomationException
The dataset type.

Remarks

The DatasetType property will return one of the following:

EsriDTFeatureClass
EsriDTTable
EsriDTRelationshipClass

From these objects, you can determine the associated feature datasets, geometric networks or topologies.

Product Availability

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

Specified by:
getDatasetType in interface IGPReplicaDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRowsType

public void setRowsType(int rowsType)
                 throws IOException,
                        AutomationException
Defines the replicated rows.

Remarks

This property allows you to control, on an individual dataset level whether all data, only the schema or only data satisfying the other IGPReplicaDataset properties will be replicated.

By default, FeatureClasses are set to esriRowsTypeFilter while tables return esriRowsTypeNone. See the esriRowsType enumeration for more information.

Product Availability

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

Specified by:
setRowsType in interface IGPReplicaDataset
Parameters:
rowsType - A com.esri.arcgis.geodatabase.esriRowsType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRowsType

public int getRowsType()
                throws IOException,
                       AutomationException
Defines the replicated rows.

Remarks

Returns the rows type of the replica dataset as a value of the esriRowsType enumeration. Only datasets that return esriRowsTypeFilter apply the filters imposed by the other returned properties in IGPReplicaDataset.

See the esriRowsType enumeration for more information.

Product Availability

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

Specified by:
getRowsType in interface IGPReplicaDataset
Returns:
A com.esri.arcgis.geodatabase.esriRowsType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsPrivate

public void setIsPrivate(boolean isPrivate)
                  throws IOException,
                         AutomationException
Indicates if the replica dataset is private.

Product Availability

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

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

isPrivate

public boolean isPrivate()
                  throws IOException,
                         AutomationException
Indicates if the replica dataset is private.

Remarks

Returns TRUE if the dataset is private. Returns FALSE if it is not private

Product Availability

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

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

setUseGeometry

public void setUseGeometry(boolean useGeometry)
                    throws IOException,
                           AutomationException
Indicates if the geometry defined in the replica description is applied to the replica dataset.

Product Availability

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

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

isUseGeometry

public boolean isUseGeometry()
                      throws IOException,
                             AutomationException
Indicates if the geometry defined in the replica description is applied to the replica dataset.

Description

The property is TRUE by default.

Product Availability

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

Specified by:
isUseGeometry in interface IGPReplicaDataset
Returns:
The useGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefQuery

public void setDefQuery(String defQuery)
                 throws IOException,
                        AutomationException
Definition query for the replica dataset.

Product Availability

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

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

getDefQuery

public String getDefQuery()
                   throws IOException,
                          AutomationException
Definition query for the replica dataset.

Remarks

The definition query for the replica dataset.

Product Availability

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

Specified by:
getDefQuery in interface IGPReplicaDataset
Returns:
The defQuery
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionIDsByRef

public void setSelectionIDsByRef(ILongArray longArray)
                          throws IOException,
                                 AutomationException
Array of selected IDs.

Product Availability

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

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

getSelectionIDs

public ILongArray getSelectionIDs()
                           throws IOException,
                                  AutomationException
Array of selected IDs.

Product Availability

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

Specified by:
getSelectionIDs in interface IGPReplicaDataset
Returns:
A reference to a com.esri.arcgis.system.ILongArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelExtractDirection

public void setRelExtractDirection(int relExtractDir)
                            throws IOException,
                                   AutomationException
Defines the direction of the replicated relationship class.

Product Availability

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

Specified by:
setRelExtractDirection in interface IGPReplicaDataset
Parameters:
relExtractDir - A com.esri.arcgis.geodatabase.esriRelExtractDirection constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelExtractDirection

public int getRelExtractDirection()
                           throws IOException,
                                  AutomationException
Defines the direction of the replicated relationship class.

Product Availability

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

Specified by:
getRelExtractDirection in interface IGPReplicaDataset
Returns:
A com.esri.arcgis.geodatabase.esriRelExtractDirection constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelOriginClass

public void setRelOriginClass(String originClass)
                       throws IOException,
                              AutomationException
The origin class for the relationship class.

Product Availability

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

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

getRelOriginClass

public String getRelOriginClass()
                         throws IOException,
                                AutomationException
The origin class for the relationship class.

Product Availability

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

Specified by:
getRelOriginClass in interface IGPReplicaDataset
Returns:
The originClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelDestinationClass

public void setRelDestinationClass(String destClass)
                            throws IOException,
                                   AutomationException
The destination class for the relationship class.

Product Availability

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

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

getRelDestinationClass

public String getRelDestinationClass()
                              throws IOException,
                                     AutomationException
The destination class for the relationship class.

Product Availability

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

Specified by:
getRelDestinationClass in interface IGPReplicaDataset
Returns:
The destClass
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.

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.

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.

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