com.esri.arcgis.geodatabase
Class GPReplicaDataset

java.lang.Object
  com.esri.arcgis.geodatabase.GPReplicaDataset

All Implemented Interfaces:

IGPReplicaDataset, IGPReplicaDataset2, IGPValue, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class GPReplicaDataset
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPValue, IGPReplicaDataset, IGPReplicaDataset2, IXMLSerialize, IPersist, IPersistStream, IXMLVersionSupport, java.io.Externalizable

COM Class 'GPReplicaDataset'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'A replica dataset.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue

IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IGPReplicaDataset2

IID, IID484704ee_1f3c_4342_961b_0337217cf20a, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IGPReplicaDataset

IID7b913e1b_4de7_4d37_82fc_81e458964cd6

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

GPReplicaDataset()
Constructs a GPReplicaDataset using ArcGIS Engine.

GPReplicaDataset(java.lang.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.
void	empty() Clears the value object.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getDatasetID() Set datasetID for a ReplicaDataset.
int	getDatasetType() The dataset type.
java.lang.String	getDefQuery() Definition query for the replica dataset.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLayerID() Set layerID for a ReplicaDataset.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
java.lang.String	getName() The name of the dataset.
java.lang.String	getParentDatabase() Set parent dbase for the GPReplicaDataset.
java.lang.String	getParentOwner() Set parent owner for the GPReplicaDataset.
java.lang.String	getRelDestinationClass() The destination class for the relationship class.
int	getRelExtractDirection() Defines the direction of the replicated relationship class.
java.lang.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
java.lang.String	getTargetName() The target name for the GPReplicaDataset.
int	hashCode() the hashcode for this object
IGPDataType	IGPValue_getDataType() The data type of the value object.
void	isDirty() isDirty
boolean	isEmpty() Indicates if the value object is empty.
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(java.io.ObjectInput in)
void	release() Release a GPReplicaDataset.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
IGPMessage	setAsText(java.lang.String text) Provides the value of the value object with the given string value.
void	setDatasetID(int datasetID) Set datasetID for a ReplicaDataset.
void	setDatasetType(int datasetType) The dataset type.
void	setDefQuery(java.lang.String defQuery) Definition query for the replica dataset.
void	setIsPrivate(boolean isPrivate) Indicates if the replica dataset is private.
void	setLayerID(int layerID) Set layerID for a ReplicaDataset.
void	setName(java.lang.String name) The name of the dataset.
void	setParentDatabase(java.lang.String parentDBase) Set parent dbase for the GPReplicaDataset.
void	setParentOwner(java.lang.String parentOwner) Set parent owner for the GPReplicaDataset.
void	setRelDestinationClass(java.lang.String destClass) The destination class for the relationship class.
void	setRelExtractDirection(int relExtractDir) Defines the direction of the replicated relationship class.
void	setRelOriginClass(java.lang.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	setTargetName(java.lang.String targetName) The target name for the GPReplicaDataset.
void	setUseGeometry(boolean useGeometry) Indicates if the geometry defined in the replica description is applied to the replica dataset.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

GPReplicaDataset

public GPReplicaDataset()
                 throws java.io.IOException,
                        java.net.UnknownHostException

Constructs a GPReplicaDataset using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPReplicaDataset

public GPReplicaDataset(java.lang.Object obj)
                 throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GPReplicaDataset.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException

The data type of the value object.

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPDataType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEmpty

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

Indicates if the value object is empty.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws java.io.IOException,
                  AutomationException

Clears the value object.

Specified by:

empty in interface IGPValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsText

public java.lang.String getAsText()
                           throws java.io.IOException,
                                  AutomationException

Provides the value of the value object.

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of the dataset.

Specified by:

setName in interface IGPReplicaDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the dataset.

Specified by:

getName in interface IGPReplicaDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDatasetType

public void setDatasetType(int datasetType)
                    throws java.io.IOException,
                           AutomationException

The dataset type.

Specified by:

setDatasetType in interface IGPReplicaDataset

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetType

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

The dataset type.

Specified by:

getDatasetType in interface IGPReplicaDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRowsType

public void setRowsType(int rowsType)
                 throws java.io.IOException,
                        AutomationException

Defines the replicated rows.

Specified by:

setRowsType in interface IGPReplicaDataset

Parameters:

rowsType - A com.esri.arcgis.geodatabase.esriRowsType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRowsType

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

Defines the replicated rows.

Specified by:

getRowsType in interface IGPReplicaDataset

Returns:

A com.esri.arcgis.geodatabase.esriRowsType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsPrivate

public void setIsPrivate(boolean isPrivate)
                  throws java.io.IOException,
                         AutomationException

Indicates if the replica dataset is private.

Specified by:

setIsPrivate in interface IGPReplicaDataset

Parameters:

isPrivate - The isPrivate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPrivate

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

Indicates if the replica dataset is private.

Specified by:

isPrivate in interface IGPReplicaDataset

Returns:

The isPrivate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseGeometry

public void setUseGeometry(boolean useGeometry)
                    throws java.io.IOException,
                           AutomationException

Indicates if the geometry defined in the replica description is applied to the replica dataset.

Specified by:

setUseGeometry in interface IGPReplicaDataset

Parameters:

useGeometry - The useGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseGeometry

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

Indicates if the geometry defined in the replica description is applied to the replica dataset.

Specified by:

isUseGeometry in interface IGPReplicaDataset

Returns:

The useGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefQuery

public void setDefQuery(java.lang.String defQuery)
                 throws java.io.IOException,
                        AutomationException

Definition query for the replica dataset.

Specified by:

setDefQuery in interface IGPReplicaDataset

Parameters:

defQuery - The defQuery (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefQuery

public java.lang.String getDefQuery()
                             throws java.io.IOException,
                                    AutomationException

Definition query for the replica dataset.

Specified by:

getDefQuery in interface IGPReplicaDataset

Returns:

The defQuery

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionIDsByRef

public void setSelectionIDsByRef(ILongArray longArray)
                          throws java.io.IOException,
                                 AutomationException

Array of selected IDs.

Specified by:

setSelectionIDsByRef in interface IGPReplicaDataset

Parameters:

longArray - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectionIDs

public ILongArray getSelectionIDs()
                           throws java.io.IOException,
                                  AutomationException

Array of selected IDs.

Specified by:

getSelectionIDs in interface IGPReplicaDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelExtractDirection

public void setRelExtractDirection(int relExtractDir)
                            throws java.io.IOException,
                                   AutomationException

Defines the direction of the replicated relationship class.

Specified by:

setRelExtractDirection in interface IGPReplicaDataset

Parameters:

relExtractDir - A com.esri.arcgis.geodatabase.esriRelExtractDirection constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelExtractDirection

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

Defines the direction of the replicated relationship class.

Specified by:

getRelExtractDirection in interface IGPReplicaDataset

Returns:

A com.esri.arcgis.geodatabase.esriRelExtractDirection constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelOriginClass

public void setRelOriginClass(java.lang.String originClass)
                       throws java.io.IOException,
                              AutomationException

The origin class for the relationship class.

Specified by:

setRelOriginClass in interface IGPReplicaDataset

Parameters:

originClass - The originClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelOriginClass

public java.lang.String getRelOriginClass()
                                   throws java.io.IOException,
                                          AutomationException

The origin class for the relationship class.

Specified by:

getRelOriginClass in interface IGPReplicaDataset

Returns:

The originClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelDestinationClass

public void setRelDestinationClass(java.lang.String destClass)
                            throws java.io.IOException,
                                   AutomationException

The destination class for the relationship class.

Specified by:

setRelDestinationClass in interface IGPReplicaDataset

Parameters:

destClass - The destClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelDestinationClass

public java.lang.String getRelDestinationClass()
                                        throws java.io.IOException,
                                               AutomationException

The destination class for the relationship class.

Specified by:

getRelDestinationClass in interface IGPReplicaDataset

Returns:

The destClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTargetName

public void setTargetName(java.lang.String targetName)
                   throws java.io.IOException,
                          AutomationException

The target name for the GPReplicaDataset.

Specified by:

setTargetName in interface IGPReplicaDataset2

Parameters:

targetName - The targetName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTargetName

public java.lang.String getTargetName()
                               throws java.io.IOException,
                                      AutomationException

The target name for the GPReplicaDataset.

Specified by:

getTargetName in interface IGPReplicaDataset2

Returns:

The targetName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParentOwner

public void setParentOwner(java.lang.String parentOwner)
                    throws java.io.IOException,
                           AutomationException

Set parent owner for the GPReplicaDataset.

Specified by:

setParentOwner in interface IGPReplicaDataset2

Parameters:

parentOwner - The parentOwner (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParentOwner

public java.lang.String getParentOwner()
                                throws java.io.IOException,
                                       AutomationException

Set parent owner for the GPReplicaDataset.

Specified by:

getParentOwner in interface IGPReplicaDataset2

Returns:

The parentOwner

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParentDatabase

public void setParentDatabase(java.lang.String parentDBase)
                       throws java.io.IOException,
                              AutomationException

Set parent dbase for the GPReplicaDataset.

Specified by:

setParentDatabase in interface IGPReplicaDataset2

Parameters:

parentDBase - The parentDBase (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParentDatabase

public java.lang.String getParentDatabase()
                                   throws java.io.IOException,
                                          AutomationException

Set parent dbase for the GPReplicaDataset.

Specified by:

getParentDatabase in interface IGPReplicaDataset2

Returns:

The parentDBase

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDatasetID

public void setDatasetID(int datasetID)
                  throws java.io.IOException,
                         AutomationException

Set datasetID for a ReplicaDataset.

Specified by:

setDatasetID in interface IGPReplicaDataset2

Parameters:

datasetID - The datasetID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetID

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

Set datasetID for a ReplicaDataset.

Specified by:

getDatasetID in interface IGPReplicaDataset2

Returns:

The datasetID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerID

public void setLayerID(int layerID)
                throws java.io.IOException,
                       AutomationException

Set layerID for a ReplicaDataset.

Specified by:

setLayerID in interface IGPReplicaDataset2

Parameters:

layerID - The layerID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerID

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

Set layerID for a ReplicaDataset.

Specified by:

getLayerID in interface IGPReplicaDataset2

Returns:

The layerID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException