|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.geodatabase.RelQueryTableName
public class RelQueryTableName
A name class that represents a RelQueryTable.
A RelQueryTableName is a representation of a RelQueryTable. A RelQueryTableName can be used to create new, work with existing or persist RelQueryTables.
The RelQueryTableName class implements the IDatasetName interface, but the following properties do not have meaning when used with a RelQueryTableName:
IDatasetName::Category - Always returns a blank string
IDatasetName::WorkspaceName - Always returns nothing
| Constructor Summary | |
|---|---|
RelQueryTableName()
Constructs a RelQueryTableName using ArcGIS Engine. |
|
RelQueryTableName(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RelQueryTableName theRelQueryTableName = (RelQueryTableName) obj; |
|
| Method Summary | |
|---|---|
boolean |
equals(Object o)
Compare this object with another |
String |
getCategory()
The category of the dataset. |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
String |
getName()
The name of the dataset. |
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. |
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 |
Object |
open()
Opens the object referred to by this name. |
void |
readExternal(ObjectInput in)
|
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setCategory(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(String name)
The name of the dataset. |
void |
setNameString(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(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(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 RelQueryTableName()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public RelQueryTableName(Object obj)
throws IOException
RelQueryTableName theRelQueryTableName = (RelQueryTableName) obj;
obj to RelQueryTableName.
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 void setNameString(String nameString)
throws IOException,
AutomationException
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.
setNameString in interface INamenameString - The nameString (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getNameString()
throws IOException,
AutomationException
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.
getNameString in interface INameIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object open()
throws IOException,
AutomationException
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.
IName pName = pFeatureClassName;
pFeatureClass = new IFeatureClassProxy(pName.open());
open in interface INameIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getName()
throws IOException,
AutomationException
getName in interface IDatasetNameIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setName(String name)
throws IOException,
AutomationException
setName in interface IDatasetNamename - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getType()
throws IOException,
AutomationException
getType in interface IDatasetNameIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCategory()
throws IOException,
AutomationException
getCategory in interface IDatasetNameIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCategory(String category)
throws IOException,
AutomationException
setCategory in interface IDatasetNamecategory - The category (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IWorkspaceName getWorkspaceName()
throws IOException,
AutomationException
getWorkspaceName in interface IDatasetNameIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
throws IOException,
AutomationException
setWorkspaceNameByRef in interface IDatasetNameworkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumDatasetName getSubsetNames()
throws IOException,
AutomationException
getSubsetNames in interface IDatasetNameIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setRelationshipClassNameByRef(IName relClassName)
throws IOException,
AutomationException
setRelationshipClassNameByRef in interface IRelQueryTableNamesetRelationshipClassNameByRef in interface IRelQueryTableName2relClassName - A reference to a com.esri.arcgis.system.IName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IName getRelationshipClassName()
throws IOException,
AutomationException
This is the RelationshipClassName that defines the join tables and join fields as well as the cardinality.
You can set this property using a RelationshipClassName that refers to either a RelationshipClass in a geodatabase or a MemoryRelationshipClass.
getRelationshipClassName in interface IRelQueryTableNamegetRelationshipClassName in interface IRelQueryTableName2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setForwardDirection(boolean forward)
throws IOException,
AutomationException
setForwardDirection in interface IRelQueryTableNamesetForwardDirection in interface IRelQueryTableName2forward - The forward (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isForwardDirection()
throws IOException,
AutomationException
If ForwardDirection is True, the origin table in the RelationshipClassName is the source in the RelQueryTable, otherwise the destination table in the RelationshipClassName becomes the source. If the cardinality is many to one, you can define your relationship as one-to-many and set this parameter to false in order to make the many side the source. It's necessary to do this to get every joined row, since you can't set the cardinality to many-to-one for a RelationshipClass.
isForwardDirection in interface IRelQueryTableNameisForwardDirection in interface IRelQueryTableName2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSrcQueryFilterByRef(IQueryFilter queryFilter)
throws IOException,
AutomationException
setSrcQueryFilterByRef in interface IRelQueryTableNamesetSrcQueryFilterByRef in interface IRelQueryTableName2queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IQueryFilter getSrcQueryFilter()
throws IOException,
AutomationException
You can further define the data that will be returned by a RelQueryTable by applying a QueryFilter. The WhereClause of SrcQueryFilter is added to the WhereClause of the QueryFilter specified when you use the ITable::Search method using the and operator. The SubFields of SrcQueryFilter define which fields will include data when a cursor is opened. The other fields are included but will be empty.
getSrcQueryFilter in interface IRelQueryTableNamegetSrcQueryFilter in interface IRelQueryTableName2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setSrcSelectionSetByRef(ISelectionSet selectionSet)
throws IOException,
AutomationException
setSrcSelectionSetByRef in interface IRelQueryTableNamesetSrcSelectionSetByRef in interface IRelQueryTableName2selectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISelectionSet getSrcSelectionSet()
throws IOException,
AutomationException
This property is not implemented, and should not be set.
getSrcSelectionSet in interface IRelQueryTableNamegetSrcSelectionSet in interface IRelQueryTableName2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTargetColumns(String targetColumns)
throws IOException,
AutomationException
setTargetColumns in interface IRelQueryTableNamesetTargetColumns in interface IRelQueryTableName2targetColumns - The targetColumns (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getTargetColumns()
throws IOException,
AutomationException
This is a comma delimited string that defines the fields returned from the destination table. This is different from the SubFields of SrcQueryFilter since in this case, fields not included in TargetColumns are not included at all in a cursor.
getTargetColumns in interface IRelQueryTableNamegetTargetColumns in interface IRelQueryTableName2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setDoNotPushJoinToDB(boolean doNotPushJoinToDB)
throws IOException,
AutomationException
setDoNotPushJoinToDB in interface IRelQueryTableNamesetDoNotPushJoinToDB in interface IRelQueryTableName2doNotPushJoinToDB - The doNotPushJoinToDB (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDoNotPushJoinToDB()
throws IOException,
AutomationException
If DoNotPushJoinToDB is True, the join is always processed on the client; otherwise, it is processed on the server (if possible). If all tables involved are stored in the same geodatabase, the processing can be performed by the server, which is normally faster. The LeftOuterJoin property must also be set to False in order for processing to occur on the server. In any other case, processing occurs on the client regardless of how this parameter is set.
isDoNotPushJoinToDB in interface IRelQueryTableNameisDoNotPushJoinToDB in interface IRelQueryTableName2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLeftOuterJoin(boolean leftOuterJoin)
throws IOException,
AutomationException
setLeftOuterJoin in interface IRelQueryTableNamesetLeftOuterJoin in interface IRelQueryTableName2leftOuterJoin - The leftOuterJoin (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isLeftOuterJoin()
throws IOException,
AutomationException
A left outer join is performed if LeftOuterJoin is set to True, otherwise a left inner join is performed. See IRelQueryTableInfo::JoinType for more information.
isLeftOuterJoin in interface IRelQueryTableNameisLeftOuterJoin in interface IRelQueryTableName2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isFireRowChangedEvents()
throws IOException,
AutomationException
isFireRowChangedEvents in interface IRelQueryTableName2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setFireRowChangedEvents(boolean fireRowEvents)
throws IOException,
AutomationException
setFireRowChangedEvents in interface IRelQueryTableName2fireRowEvents - The fireRowEvents (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 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 | ||||||||