|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.geodatabase.GPReplicaDataset
public class GPReplicaDataset
A replica dataset.
A class the represents a dataset that is part of a replica in a geodatabase.
| 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. |
void |
empty()
Clears the value object. |
boolean |
equals(Object o)
Compare this object with another |
String |
getAsText()
Provides the value of the value object. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
int |
getDatasetID()
Set datasetID for a ReplicaDataset. |
int |
getDatasetType()
The dataset type. |
String |
getDefQuery()
Definition query for the replica dataset. |
int |
getLayerID()
Set layerID for a ReplicaDataset. |
String |
getMinNamespaceSupported()
The minimum namespace the class can serialize to (eg the 90 namespace). |
String |
getName()
The name of the dataset. |
String |
getParentDatabase()
Set parent dbase for the GPReplicaDataset. |
String |
getParentOwner()
Set parent owner for the GPReplicaDataset. |
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 |
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(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
serialize(IXMLSerializeData data)
Serializes an object to XML. |
IGPMessage |
setAsText(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(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(String name)
The name of the dataset. |
void |
setParentDatabase(String parentDBase)
Set parent dbase for the GPReplicaDataset. |
void |
setParentOwner(String parentOwner)
Set parent owner for the GPReplicaDataset. |
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 |
setTargetName(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(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 |
|---|
public GPReplicaDataset()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public GPReplicaDataset(Object obj)
throws IOException
GPReplicaDataset theGPReplicaDataset = (GPReplicaDataset) obj;
obj to GPReplicaDataset.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public IGPDataType IGPValue_getDataType()
throws IOException,
AutomationException
IGPValue_getDataType in interface IGPValueIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEmpty()
throws IOException,
AutomationException
The IsEmpty method returns if this Value object has been set or not.
isEmpty in interface IGPValueIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void empty()
throws IOException,
AutomationException
The Empty method clears this Value object and releases any associated objects.
empty in interface IGPValueIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getAsText()
throws IOException,
AutomationException
The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.
getAsText in interface IGPValueIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IGPMessage setAsText(String text)
throws IOException,
AutomationException
The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.
setAsText in interface IGPValuetext - The text (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setName(String name)
throws IOException,
AutomationException
setName in interface IGPReplicaDatasetname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getName()
throws IOException,
AutomationException
Returns the name of the dataset.
getName in interface IGPReplicaDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDatasetType(int datasetType)
throws IOException,
AutomationException
setDatasetType in interface IGPReplicaDatasetdatasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getDatasetType()
throws IOException,
AutomationException
The DatasetType property will return one of the following:
esriDTFeatureClass
esriDTTable
esriDTRelationshipClass
From these values, you can determine the associated feature datasets, geometric networks or topologies.
getDatasetType in interface IGPReplicaDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRowsType(int rowsType)
throws IOException,
AutomationException
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.
setRowsType in interface IGPReplicaDatasetrowsType - A com.esri.arcgis.geodatabase.esriRowsType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getRowsType()
throws IOException,
AutomationException
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.
getRowsType in interface IGPReplicaDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setIsPrivate(boolean isPrivate)
throws IOException,
AutomationException
setIsPrivate in interface IGPReplicaDatasetisPrivate - The isPrivate (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isPrivate()
throws IOException,
AutomationException
Returns TRUE if the dataset is private. Returns FALSE if it is not private
isPrivate in interface IGPReplicaDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setUseGeometry(boolean useGeometry)
throws IOException,
AutomationException
setUseGeometry in interface IGPReplicaDatasetuseGeometry - The useGeometry (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isUseGeometry()
throws IOException,
AutomationException
The property is TRUE by default.
isUseGeometry in interface IGPReplicaDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDefQuery(String defQuery)
throws IOException,
AutomationException
setDefQuery in interface IGPReplicaDatasetdefQuery - The defQuery (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getDefQuery()
throws IOException,
AutomationException
The definition query for the replica dataset.
getDefQuery in interface IGPReplicaDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSelectionIDsByRef(ILongArray longArray)
throws IOException,
AutomationException
setSelectionIDsByRef in interface IGPReplicaDatasetlongArray - A reference to a com.esri.arcgis.system.ILongArray (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ILongArray getSelectionIDs()
throws IOException,
AutomationException
getSelectionIDs in interface IGPReplicaDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRelExtractDirection(int relExtractDir)
throws IOException,
AutomationException
setRelExtractDirection in interface IGPReplicaDatasetrelExtractDir - A com.esri.arcgis.geodatabase.esriRelExtractDirection constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getRelExtractDirection()
throws IOException,
AutomationException
getRelExtractDirection in interface IGPReplicaDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRelOriginClass(String originClass)
throws IOException,
AutomationException
setRelOriginClass in interface IGPReplicaDatasetoriginClass - The originClass (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getRelOriginClass()
throws IOException,
AutomationException
getRelOriginClass in interface IGPReplicaDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRelDestinationClass(String destClass)
throws IOException,
AutomationException
setRelDestinationClass in interface IGPReplicaDatasetdestClass - The destClass (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getRelDestinationClass()
throws IOException,
AutomationException
getRelDestinationClass in interface IGPReplicaDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTargetName(String targetName)
throws IOException,
AutomationException
setTargetName in interface IGPReplicaDataset2targetName - The targetName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getTargetName()
throws IOException,
AutomationException
getTargetName in interface IGPReplicaDataset2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setParentOwner(String parentOwner)
throws IOException,
AutomationException
setParentOwner in interface IGPReplicaDataset2parentOwner - The parentOwner (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getParentOwner()
throws IOException,
AutomationException
getParentOwner in interface IGPReplicaDataset2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setParentDatabase(String parentDBase)
throws IOException,
AutomationException
setParentDatabase in interface IGPReplicaDataset2parentDBase - The parentDBase (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getParentDatabase()
throws IOException,
AutomationException
getParentDatabase in interface IGPReplicaDataset2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDatasetID(int datasetID)
throws IOException,
AutomationException
setDatasetID in interface IGPReplicaDataset2datasetID - The datasetID (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getDatasetID()
throws IOException,
AutomationException
getDatasetID in interface IGPReplicaDataset2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLayerID(int layerID)
throws IOException,
AutomationException
setLayerID in interface IGPReplicaDataset2layerID - The layerID (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getLayerID()
throws IOException,
AutomationException
getLayerID in interface IGPReplicaDataset2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void serialize(IXMLSerializeData data)
throws IOException,
AutomationException
serialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deserialize(IXMLSerializeData data)
throws IOException,
AutomationException
deserialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getClassID(GUID[] pClassID)
throws IOException,
AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void isDirty()
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty in interface IPersistStreamIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void load(IStream pstm)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void save(IStream pstm,
int fClearDirty)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
throws IOException,
AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getMinNamespaceSupported()
throws IOException,
AutomationException
getMinNamespaceSupported in interface IXMLVersionSupportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void writeExternal(ObjectOutput out)
throws IOException
writeExternal in interface ExternalizableIOException
public void readExternal(ObjectInput in)
throws IOException,
ClassNotFoundException
readExternal in interface ExternalizableIOException
ClassNotFoundException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||