com.esri.arcgis.carto
Class JoinTableSourceDescription

java.lang.Object
  com.esri.arcgis.carto.JoinTableSourceDescription

All Implemented Interfaces:

IJoinTableSourceDescription, IMapServerSourceDescription, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class JoinTableSourceDescription
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IJoinTableSourceDescription, IMapServerSourceDescription, IXMLSerialize, IPersistStream, IXMLVersionSupport, IDocumentVersionSupportGEN, Externalizable

A coclass that contains settings of a join that the table is participating.

Remarks

Note: for performance reasons, the left and right table shoule be from the same workspace.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

JoinTableSourceDescription()
Constructs a JoinTableSourceDescription using ArcGIS Engine.

JoinTableSourceDescription(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
JoinTableSourceDescription theJoinTableSourceDescription = (JoinTableSourceDescription) obj;

Method Summary

Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getJoinType() Type of join.
IMapServerSourceDescription	getLeftSourceDescription() Data Source for left table.
String	getLeftTableKey() Field name from the left table that will be used for join.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IMapServerSourceDescription	getRightSourceDescription() Data Source for right table.
String	getRightTableKey() Field name from the right table that will be used for join.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
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.
void	setJoinType(int pJoinType) Type of join.
void	setLeftSourceDescription(IMapServerSourceDescription ppLeftSourceDescription) Data Source for left table.
void	setLeftTableKey(String pLeftTableKey) Field name from the left table that will be used for join.
void	setRightSourceDescription(IMapServerSourceDescription ppRightSourceDescription) Data Source for right table.
void	setRightTableKey(String pRightTableKey) Field name from the right table that will be used for join.
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

JoinTableSourceDescription

public JoinTableSourceDescription()
                           throws IOException,
                                  UnknownHostException

Constructs a JoinTableSourceDescription using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

JoinTableSourceDescription

public JoinTableSourceDescription(Object obj)
                           throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getLeftSourceDescription

public IMapServerSourceDescription getLeftSourceDescription()
                                                     throws IOException,
                                                            AutomationException

Data Source for left table.

Product Availability

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

Specified by:

getLeftSourceDescription in interface IJoinTableSourceDescription

Returns:

A reference to a com.esri.arcgis.carto.IMapServerSourceDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeftSourceDescription

public void setLeftSourceDescription(IMapServerSourceDescription ppLeftSourceDescription)
                              throws IOException,
                                     AutomationException

Data Source for left table.

Product Availability

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

Specified by:

setLeftSourceDescription in interface IJoinTableSourceDescription

Parameters:

ppLeftSourceDescription - A reference to a com.esri.arcgis.carto.IMapServerSourceDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRightSourceDescription

public IMapServerSourceDescription getRightSourceDescription()
                                                      throws IOException,
                                                             AutomationException

Data Source for right table.

Product Availability

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

Specified by:

getRightSourceDescription in interface IJoinTableSourceDescription

Returns:

A reference to a com.esri.arcgis.carto.IMapServerSourceDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRightSourceDescription

public void setRightSourceDescription(IMapServerSourceDescription ppRightSourceDescription)
                               throws IOException,
                                      AutomationException

Data Source for right table.

Product Availability

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

Specified by:

setRightSourceDescription in interface IJoinTableSourceDescription

Parameters:

ppRightSourceDescription - A reference to a com.esri.arcgis.carto.IMapServerSourceDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeftTableKey

public String getLeftTableKey()
                       throws IOException,
                              AutomationException

Field name from the left table that will be used for join.

Remarks

Only name of indexed field can be specifiedl

Product Availability

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

Specified by:

getLeftTableKey in interface IJoinTableSourceDescription

Returns:

The pLeftTableKey

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeftTableKey

public void setLeftTableKey(String pLeftTableKey)
                     throws IOException,
                            AutomationException

Field name from the left table that will be used for join.

Product Availability

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

Specified by:

setLeftTableKey in interface IJoinTableSourceDescription

Parameters:

pLeftTableKey - The pLeftTableKey (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRightTableKey

public String getRightTableKey()
                        throws IOException,
                               AutomationException

Field name from the right table that will be used for join.

Remarks

Only name of indexed field can be specifiedl

Product Availability

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

Specified by:

getRightTableKey in interface IJoinTableSourceDescription

Returns:

The pRightTableKey

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRightTableKey

public void setRightTableKey(String pRightTableKey)
                      throws IOException,
                             AutomationException

Field name from the right table that will be used for join.

Product Availability

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

Specified by:

setRightTableKey in interface IJoinTableSourceDescription

Parameters:

pRightTableKey - The pRightTableKey (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJoinType

public int getJoinType()
                throws IOException,
                       AutomationException

Type of join.

Product Availability

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

Specified by:

getJoinType in interface IJoinTableSourceDescription

Returns:

A com.esri.arcgis.geodatabase.esriJoinType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setJoinType

public void setJoinType(int pJoinType)
                 throws IOException,
                        AutomationException

Type of join.

Product Availability

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

Specified by:

setJoinType in interface IJoinTableSourceDescription

Parameters:

pJoinType - A com.esri.arcgis.geodatabase.esriJoinType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException