com.esri.arcgis.geodatabase

Class RelQueryTableName

java.lang.Object

com.esri.arcgis.geodatabase.RelQueryTableName

All Implemented Interfaces:

IDatasetName, IRelQueryTableName, IRelQueryTableName2, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class RelQueryTableName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, IDatasetName, IRelQueryTableName, IRelQueryTableName2, IPersist, IPersistStream, java.io.Externalizable

COM Class 'RelQueryTableName'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'A name class that represents a RelQueryTable.' 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

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

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

IID, IID89e75917_c287_11d1_aa77_00c04fa33a15, xxDummy

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

IID, IID64485e14_dcca_4747_8046_ee7d82a01928, xxDummy

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

IID, IID7042b894_fb07_4bc4_917d_15e282ba1b27, 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

Constructor Summary

Constructors

Constructor and Description
RelQueryTableName() Constructs a RelQueryTableName using ArcGIS Engine.
RelQueryTableName(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RelQueryTableName theRelQueryTableName = (RelQueryTableName) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
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.
java.lang.String	getNameString() The name string of the object.
IName	getRelationshipClassName() The name object for the RelationshipClass that defines the RelQueryTable.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IQueryFilter	getSrcQueryFilter() A QueryFilter applied to a cursor opened from the RelQueryTable.
ISelectionSet	getSrcSelectionSet() A SelectionSet applied to a cursor opened from the RelQueryTable.
IEnumDatasetName	getSubsetNames() Subset names contained within this dataset name.
java.lang.String	getTargetColumns() The destination dataset columns available in a cursor opened from the RelTableTable.
int	getType() The type of the dataset.
IWorkspaceName	getWorkspaceName() The WorkspaceName of the DatasetName.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isDoNotPushJoinToDB() Indicates if the join is processed on the client.
boolean	isFireRowChangedEvents() Indicates if Fire row changed events.
boolean	isForwardDirection() Indicates if the originPrimaryClass of the RelationshipClass is the SourceTable.
boolean	isLeftOuterJoin() Indicates if the type of join will be a left outer join.
void	load(IStream pstm) load
java.lang.Object	open() Opens the object referred to by this name.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	setCategory(java.lang.String category) The category of the dataset.
void	setDoNotPushJoinToDB(boolean doNotPushJoinToDB) Indicates if the join is processed on the client.
void	setFireRowChangedEvents(boolean fireRowEvents) Indicates if Fire row changed events.
void	setForwardDirection(boolean forward) Indicates if the originPrimaryClass of the RelationshipClass is the SourceTable.
void	setLeftOuterJoin(boolean leftOuterJoin) Indicates if the type of join will be a left outer join.
void	setName(java.lang.String name) The name of the dataset.
void	setNameString(java.lang.String nameString) The name string of the object.
void	setRelationshipClassNameByRef(IName relClassName) The name object for the RelationshipClass that defines the RelQueryTable.
void	setSrcQueryFilterByRef(IQueryFilter queryFilter) A QueryFilter applied to a cursor opened from the RelQueryTable.
void	setSrcSelectionSetByRef(ISelectionSet selectionSet) A SelectionSet applied to a cursor opened from the RelQueryTable.
void	setTargetColumns(java.lang.String targetColumns) The destination dataset columns available in a cursor opened from the RelTableTable.
void	setWorkspaceNameByRef(IWorkspaceName workspaceName) The WorkspaceName of the DatasetName.
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

RelQueryTableName

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

Constructs a RelQueryTableName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RelQueryTableName

public RelQueryTableName(java.lang.Object obj)
                  throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RelQueryTableName theRelQueryTableName = (RelQueryTableName) obj;

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

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()

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.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNameString

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

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

open

public java.lang.Object open()
                      throws java.io.IOException,
                             AutomationException

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

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 IDatasetName

Returns:

The name

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 IDatasetName

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The type of the dataset.

Specified by:

getType in interface IDatasetName

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.

getCategory

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

The category of the dataset.

Specified by:

getCategory in interface IDatasetName

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException

The category of the dataset.

Specified by:

setCategory in interface IDatasetName

Parameters:

category - The category (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws java.io.IOException,
                                       AutomationException

The WorkspaceName of the DatasetName.

Specified by:

getWorkspaceName in interface IDatasetName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws java.io.IOException,
                                  AutomationException

The WorkspaceName of the DatasetName.

Specified by:

setWorkspaceNameByRef in interface IDatasetName

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubsetNames

public IEnumDatasetName getSubsetNames()
                                throws java.io.IOException,
                                       AutomationException

Subset names contained within this dataset name.

Specified by:

getSubsetNames in interface IDatasetName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelationshipClassNameByRef

public void setRelationshipClassNameByRef(IName relClassName)
                                   throws java.io.IOException,
                                          AutomationException

The name object for the RelationshipClass that defines the RelQueryTable.

Specified by:

setRelationshipClassNameByRef in interface IRelQueryTableName

Specified by:

setRelationshipClassNameByRef in interface IRelQueryTableName2

Parameters:

relClassName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipClassName

public IName getRelationshipClassName()
                               throws java.io.IOException,
                                      AutomationException

The name object for the RelationshipClass that defines the RelQueryTable.

Specified by:

getRelationshipClassName in interface IRelQueryTableName

Specified by:

getRelationshipClassName in interface IRelQueryTableName2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setForwardDirection

public void setForwardDirection(boolean forward)
                         throws java.io.IOException,
                                AutomationException

Indicates if the originPrimaryClass of the RelationshipClass is the SourceTable.

Specified by:

setForwardDirection in interface IRelQueryTableName

Specified by:

setForwardDirection in interface IRelQueryTableName2

Parameters:

forward - The forward (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isForwardDirection

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

Indicates if the originPrimaryClass of the RelationshipClass is the SourceTable.

Specified by:

isForwardDirection in interface IRelQueryTableName

Specified by:

isForwardDirection in interface IRelQueryTableName2

Returns:

The forward

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSrcQueryFilterByRef

public void setSrcQueryFilterByRef(IQueryFilter queryFilter)
                            throws java.io.IOException,
                                   AutomationException

A QueryFilter applied to a cursor opened from the RelQueryTable.

Specified by:

setSrcQueryFilterByRef in interface IRelQueryTableName

Specified by:

setSrcQueryFilterByRef in interface IRelQueryTableName2

Parameters:

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSrcQueryFilter

public IQueryFilter getSrcQueryFilter()
                               throws java.io.IOException,
                                      AutomationException

A QueryFilter applied to a cursor opened from the RelQueryTable.

Specified by:

getSrcQueryFilter in interface IRelQueryTableName

Specified by:

getSrcQueryFilter in interface IRelQueryTableName2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSrcSelectionSetByRef

public void setSrcSelectionSetByRef(ISelectionSet selectionSet)
                             throws java.io.IOException,
                                    AutomationException

A SelectionSet applied to a cursor opened from the RelQueryTable.

Specified by:

setSrcSelectionSetByRef in interface IRelQueryTableName

Specified by:

setSrcSelectionSetByRef in interface IRelQueryTableName2

Parameters:

selectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSrcSelectionSet

public ISelectionSet getSrcSelectionSet()
                                 throws java.io.IOException,
                                        AutomationException

A SelectionSet applied to a cursor opened from the RelQueryTable.

Specified by:

getSrcSelectionSet in interface IRelQueryTableName

Specified by:

getSrcSelectionSet in interface IRelQueryTableName2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTargetColumns

public void setTargetColumns(java.lang.String targetColumns)
                      throws java.io.IOException,
                             AutomationException

The destination dataset columns available in a cursor opened from the RelTableTable.

Specified by:

setTargetColumns in interface IRelQueryTableName

Specified by:

setTargetColumns in interface IRelQueryTableName2

Parameters:

targetColumns - The targetColumns (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTargetColumns

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

The destination dataset columns available in a cursor opened from the RelTableTable.

Specified by:

getTargetColumns in interface IRelQueryTableName

Specified by:

getTargetColumns in interface IRelQueryTableName2

Returns:

The targetColumns

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDoNotPushJoinToDB

public void setDoNotPushJoinToDB(boolean doNotPushJoinToDB)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the join is processed on the client.

Specified by:

setDoNotPushJoinToDB in interface IRelQueryTableName

Specified by:

setDoNotPushJoinToDB in interface IRelQueryTableName2

Parameters:

doNotPushJoinToDB - The doNotPushJoinToDB (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDoNotPushJoinToDB

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

Indicates if the join is processed on the client.

Specified by:

isDoNotPushJoinToDB in interface IRelQueryTableName

Specified by:

isDoNotPushJoinToDB in interface IRelQueryTableName2

Returns:

The doNotPushJoinToDB

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeftOuterJoin

public void setLeftOuterJoin(boolean leftOuterJoin)
                      throws java.io.IOException,
                             AutomationException

Indicates if the type of join will be a left outer join.

Specified by:

setLeftOuterJoin in interface IRelQueryTableName

Specified by:

setLeftOuterJoin in interface IRelQueryTableName2

Parameters:

leftOuterJoin - The leftOuterJoin (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLeftOuterJoin

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

Indicates if the type of join will be a left outer join.

Specified by:

isLeftOuterJoin in interface IRelQueryTableName

Specified by:

isLeftOuterJoin in interface IRelQueryTableName2

Returns:

The leftOuterJoin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFireRowChangedEvents

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

Indicates if Fire row changed events.

Specified by:

isFireRowChangedEvents in interface IRelQueryTableName2

Returns:

The fireRowEvents

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFireRowChangedEvents

public void setFireRowChangedEvents(boolean fireRowEvents)
                             throws java.io.IOException,
                                    AutomationException

Indicates if Fire row changed events.

Specified by:

setFireRowChangedEvents in interface IRelQueryTableName2

Parameters:

fireRowEvents - The fireRowEvents (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.

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