public class RelationshipClass extends java.lang.Object implements com.esri.arcgis.interop.RemoteObjRef, IRelationshipClass, IDataset, IRelationshipClass2, IRelClassSchemaEdit
Description 'Esri Relationship Class object.' 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 =
IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy
IID, IIDc9c39723_40b6_454f_a7ff_a25491c72256, xxDummy
IID22b00693_8895_11d2_8a0d_006097aff44e
IID, IIDbb7071f4_1678_4029_a358_14b5d33ad7cf, xxDummy
Constructor and Description |
---|
RelationshipClass(java.lang.Object obj)
Construct a RelationshipClass using a reference to such an object returned from ArcGIS Engine or Server.
|
Modifier and Type | Method and Description |
---|---|
void |
addRelationshipRule(IRule rule)
Adds a relationship rule to this relationship class.
|
void |
alterBackwardPathLabel(java.lang.String backwardLabel)
Changes the backward path label for this relationship class.
|
void |
alterForwardPathLabel(java.lang.String forwardLabel)
Changes the forward path label for this relationship class.
|
void |
alterIsComposite(boolean isComposite)
Changes the type of this relationship class.
|
boolean |
canCopy()
True if this dataset can be copied.
|
boolean |
canDelete()
True if this dataset can be deleted.
|
boolean |
canRename()
True if this dataset can be renamed.
|
IDataset |
copy(java.lang.String copyName,
IWorkspace copyWorkspace)
Copies this dataset to a new dataset with the specified name.
|
IRelationship |
createRelationship(IObject originObject,
IObject destinationObject)
Creates a new relationship between the two specified objects.
|
void |
delete()
Deletes this dataset.
|
void |
deleteRelationship(IObject originObject,
IObject destinationObject)
Deletes the relationship that associates the two specified objects.
|
void |
deleteRelationshipRule(IRule rule)
Deletes a relationship rule from this relationship class.
|
void |
deleteRelationshipsForObject(IObject anObject)
Deletes all relationships that apply to a specified object.
|
void |
deleteRelationshipsForObjectSet(ISet anObjectSet)
Deletes all relationships that apply to the specified origin or destination object set.
|
boolean |
equals(java.lang.Object o)
Compare this object with another
|
java.lang.String |
getBackwardPathLabel()
The backward path label for the relationship class.
|
java.lang.String |
getBrowseName()
The browse name of the dataset.
|
int |
getCardinality()
The cardinality for the relationship class.
|
java.lang.String |
getCategory()
The category of the dataset.
|
IObjectClass |
getDestinationClass()
The destination object class.
|
java.lang.String |
getDestinationForeignKey()
The relationship destination foreign Key.
|
java.lang.String |
getDestinationPrimaryKey()
The relationship destination primary Key.
|
IFeatureDataset |
getFeatureDataset()
The feature dataset, if any, to which this relationship class belongs.
|
java.lang.String |
getForwardPathLabel()
The forward path label for the relationship class.
|
IName |
getFullName()
The associated name object.
|
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this
interface indicates the implementing class references.
|
java.lang.String |
getName()
The name of the Dataset.
|
int |
getNotification()
The notification direction for the relationship class.
|
IRelClassEnumRowPairs |
getObjectsMatchingObjectArray(IArray srcObjectArray,
IQueryFilter queryFilterAppliedToMatchingObjects,
boolean returnAllObjectMatches)
Gets rows pairs of objects that are related to the specified origin or destination object array, that also meet the query filter expression.
|
IRelClassEnumRowPairs |
getObjectsMatchingObjectSet(ISet srcObjectSet)
Gets rows pairs of objects that are related to the specified origin or destination object set.
|
IRelClassEnumRowPairs |
getObjectsMatchingObjectSetEx(ISet srcObjectSet,
IQueryFilter queryFilterAppliedToMatchingObjects,
boolean returnAllObjectMatches)
Gets rows pairs of objects that are related to the specified origin or destination object set, that also meet the query filter expression.
|
ISet |
getObjectsRelatedToObject(IObject anObject)
Gets the objects that are related to the specified object.
|
ISet |
getObjectsRelatedToObjectSet(ISet anObjectSet)
Gets the objects that are related to the specified origin or destination object set.
|
IObjectClass |
getOriginClass()
The origin object class.
|
java.lang.String |
getOriginForeignKey()
The relationship origin foreign Key.
|
java.lang.String |
getOriginPrimaryKey()
The relationship origin primary Key.
|
IPropertySet |
getPropertySet()
The set of properties for the dataset.
|
IRelationship |
getRelationship(IObject originObject,
IObject destinationObject)
Get the relationship that associates the two specified objects.
|
int |
getRelationshipClassID()
The relationship class ID.
|
IEnumRule |
getRelationshipRules()
The relationship rules that apply to this relationship class.
|
IEnumRelationship |
getRelationshipsForObject(IObject anObject)
Get all relationships that apply to a specified object.
|
IEnumRelationship |
getRelationshipsForObjectSet(ISet anObjectSet)
Get all relationships that apply to the specified origin or destination object set.
|
IEnumDataset |
getSubsets()
Datasets contained within this dataset.
|
int |
getType()
The type of the Dataset.
|
IWorkspace |
getWorkspace()
The workspace containing this dataset.
|
int |
hashCode()
the hashcode for this object
|
boolean |
isAttributed()
Indicates if the relationships in this relationship class have attributes.
|
boolean |
isComposite()
Indicates if the relationship class represents a composite relationship in which the origin object class represents the composite object.
|
void |
release()
Release this COM object reference
|
void |
rename(java.lang.String name)
Renames this Dataset.
|
void |
setBrowseName(java.lang.String name)
The browse name of the dataset.
|
public RelationshipClass(java.lang.Object obj) throws java.io.IOException
obj
to RelationshipClass
. *
RelationshipClass o = (RelationshipClass)obj; // will not work
RelationshipClass o = new RelationshipClass(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Serverjava.io.IOException
- if there are interop problems
RelationshipClass theRelationshipClass = (RelationshipClass) obj;
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public java.lang.String getOriginPrimaryKey() throws java.io.IOException, AutomationException
getOriginPrimaryKey
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getDestinationPrimaryKey() throws java.io.IOException, AutomationException
getDestinationPrimaryKey
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getOriginForeignKey() throws java.io.IOException, AutomationException
getOriginForeignKey
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getDestinationForeignKey() throws java.io.IOException, AutomationException
getDestinationForeignKey
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public int getRelationshipClassID() throws java.io.IOException, AutomationException
getRelationshipClassID
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IObjectClass getOriginClass() throws java.io.IOException, AutomationException
getOriginClass
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IObjectClass getDestinationClass() throws java.io.IOException, AutomationException
getDestinationClass
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IFeatureDataset getFeatureDataset() throws java.io.IOException, AutomationException
getFeatureDataset
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getForwardPathLabel() throws java.io.IOException, AutomationException
getForwardPathLabel
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getBackwardPathLabel() throws java.io.IOException, AutomationException
getBackwardPathLabel
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public int getCardinality() throws java.io.IOException, AutomationException
getCardinality
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public int getNotification() throws java.io.IOException, AutomationException
getNotification
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean isAttributed() throws java.io.IOException, AutomationException
isAttributed
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean isComposite() throws java.io.IOException, AutomationException
isComposite
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IRelationship createRelationship(IObject originObject, IObject destinationObject) throws java.io.IOException, AutomationException
createRelationship
in interface IRelationshipClass
originObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)destinationObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IRelationship getRelationship(IObject originObject, IObject destinationObject) throws java.io.IOException, AutomationException
getRelationship
in interface IRelationshipClass
originObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)destinationObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void deleteRelationship(IObject originObject, IObject destinationObject) throws java.io.IOException, AutomationException
deleteRelationship
in interface IRelationshipClass
originObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)destinationObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public ISet getObjectsRelatedToObject(IObject anObject) throws java.io.IOException, AutomationException
getObjectsRelatedToObject
in interface IRelationshipClass
anObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IEnumRelationship getRelationshipsForObject(IObject anObject) throws java.io.IOException, AutomationException
getRelationshipsForObject
in interface IRelationshipClass
anObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void deleteRelationshipsForObject(IObject anObject) throws java.io.IOException, AutomationException
deleteRelationshipsForObject
in interface IRelationshipClass
anObject
- A reference to a com.esri.arcgis.geodatabase.IObject (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public ISet getObjectsRelatedToObjectSet(ISet anObjectSet) throws java.io.IOException, AutomationException
getObjectsRelatedToObjectSet
in interface IRelationshipClass
anObjectSet
- A reference to a com.esri.arcgis.system.ISet (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IEnumRelationship getRelationshipsForObjectSet(ISet anObjectSet) throws java.io.IOException, AutomationException
getRelationshipsForObjectSet
in interface IRelationshipClass
anObjectSet
- A reference to a com.esri.arcgis.system.ISet (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IRelClassEnumRowPairs getObjectsMatchingObjectSet(ISet srcObjectSet) throws java.io.IOException, AutomationException
getObjectsMatchingObjectSet
in interface IRelationshipClass
srcObjectSet
- A reference to a com.esri.arcgis.system.ISet (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void deleteRelationshipsForObjectSet(ISet anObjectSet) throws java.io.IOException, AutomationException
deleteRelationshipsForObjectSet
in interface IRelationshipClass
anObjectSet
- A reference to a com.esri.arcgis.system.ISet (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IEnumRule getRelationshipRules() throws java.io.IOException, AutomationException
getRelationshipRules
in interface IRelationshipClass
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void addRelationshipRule(IRule rule) throws java.io.IOException, AutomationException
addRelationshipRule
in interface IRelationshipClass
rule
- A reference to a com.esri.arcgis.geodatabase.IRule (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void deleteRelationshipRule(IRule rule) throws java.io.IOException, AutomationException
deleteRelationshipRule
in interface IRelationshipClass
rule
- A reference to a com.esri.arcgis.geodatabase.IRule (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getName() throws java.io.IOException, AutomationException
getName
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IName getFullName() throws java.io.IOException, AutomationException
getFullName
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getBrowseName() throws java.io.IOException, AutomationException
getBrowseName
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setBrowseName(java.lang.String name) throws java.io.IOException, AutomationException
setBrowseName
in interface IDataset
name
- The name (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public int getType() throws java.io.IOException, AutomationException
getType
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getCategory() throws java.io.IOException, AutomationException
getCategory
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IEnumDataset getSubsets() throws java.io.IOException, AutomationException
getSubsets
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IWorkspace getWorkspace() throws java.io.IOException, AutomationException
getWorkspace
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IPropertySet getPropertySet() throws java.io.IOException, AutomationException
getPropertySet
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean canCopy() throws java.io.IOException, AutomationException
canCopy
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IDataset copy(java.lang.String copyName, IWorkspace copyWorkspace) throws java.io.IOException, AutomationException
copy
in interface IDataset
copyName
- The copyName (in)copyWorkspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean canDelete() throws java.io.IOException, AutomationException
canDelete
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void delete() throws java.io.IOException, AutomationException
delete
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean canRename() throws java.io.IOException, AutomationException
canRename
in interface IDataset
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void rename(java.lang.String name) throws java.io.IOException, AutomationException
rename
in interface IDataset
name
- The name (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IRelClassEnumRowPairs getObjectsMatchingObjectSetEx(ISet srcObjectSet, IQueryFilter queryFilterAppliedToMatchingObjects, boolean returnAllObjectMatches) throws java.io.IOException, AutomationException
getObjectsMatchingObjectSetEx
in interface IRelationshipClass2
srcObjectSet
- A reference to a com.esri.arcgis.system.ISet (in)queryFilterAppliedToMatchingObjects
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)returnAllObjectMatches
- The returnAllObjectMatches (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IRelClassEnumRowPairs getObjectsMatchingObjectArray(IArray srcObjectArray, IQueryFilter queryFilterAppliedToMatchingObjects, boolean returnAllObjectMatches) throws java.io.IOException, AutomationException
getObjectsMatchingObjectArray
in interface IRelationshipClass2
srcObjectArray
- A reference to a com.esri.arcgis.system.IArray (in)queryFilterAppliedToMatchingObjects
- A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)returnAllObjectMatches
- The returnAllObjectMatches (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void alterForwardPathLabel(java.lang.String forwardLabel) throws java.io.IOException, AutomationException
alterForwardPathLabel
in interface IRelClassSchemaEdit
forwardLabel
- The forwardLabel (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void alterBackwardPathLabel(java.lang.String backwardLabel) throws java.io.IOException, AutomationException
alterBackwardPathLabel
in interface IRelClassSchemaEdit
backwardLabel
- The backwardLabel (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void alterIsComposite(boolean isComposite) throws java.io.IOException, AutomationException
alterIsComposite
in interface IRelClassSchemaEdit
isComposite
- The isComposite (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.