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, java.io.Externalizable, java.io.Serializable

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

COM Class 'JoinTableSourceDescription'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A coclass that contains settings of a join that the table is participating.' 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IJoinTableSourceDescription

IID, IID5aa7d4d5_8f05_4a61_bcba_cec06afd4118, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IMapServerSourceDescription

IID, IID336da0fe_acca_4471_88f7_e9261bc342e1, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

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

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

JoinTableSourceDescription()
Constructs a JoinTableSourceDescription using ArcGIS Engine.

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

Method Summary

java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getJoinType() Type of join.
IMapServerSourceDescription	getLeftSourceDescription() Data Source for left table.
java.lang.String	getLeftTableKey() Field name from the left table that will be used for join.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IMapServerSourceDescription	getRightSourceDescription() Data Source for right table.
java.lang.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(java.io.ObjectInput in)
void	release() Release a JoinTableSourceDescription.
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(java.lang.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(java.lang.String pRightTableKey) Field name from the right table that will be used for join.
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

JoinTableSourceDescription

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

Constructs a JoinTableSourceDescription using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

JoinTableSourceDescription

public JoinTableSourceDescription(java.lang.Object obj)
                           throws java.io.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:

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

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a JoinTableSourceDescription.

Specified by:

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

getLeftSourceDescription

public IMapServerSourceDescription getLeftSourceDescription()
                                                     throws java.io.IOException,
                                                            AutomationException

Data Source for left table.

Specified by:

getLeftSourceDescription in interface IJoinTableSourceDescription

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeftSourceDescription

public void setLeftSourceDescription(IMapServerSourceDescription ppLeftSourceDescription)
                              throws java.io.IOException,
                                     AutomationException

Data Source for left table.

Specified by:

setLeftSourceDescription in interface IJoinTableSourceDescription

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRightSourceDescription

public IMapServerSourceDescription getRightSourceDescription()
                                                      throws java.io.IOException,
                                                             AutomationException

Data Source for right table.

Specified by:

getRightSourceDescription in interface IJoinTableSourceDescription

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRightSourceDescription

public void setRightSourceDescription(IMapServerSourceDescription ppRightSourceDescription)
                               throws java.io.IOException,
                                      AutomationException

Data Source for right table.

Specified by:

setRightSourceDescription in interface IJoinTableSourceDescription

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLeftTableKey

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

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

Specified by:

getLeftTableKey in interface IJoinTableSourceDescription

Returns:

The pLeftTableKey

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeftTableKey

public void setLeftTableKey(java.lang.String pLeftTableKey)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

setLeftTableKey in interface IJoinTableSourceDescription

Parameters:

pLeftTableKey - The pLeftTableKey (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRightTableKey

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

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

Specified by:

getRightTableKey in interface IJoinTableSourceDescription

Returns:

The pRightTableKey

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRightTableKey

public void setRightTableKey(java.lang.String pRightTableKey)
                      throws java.io.IOException,
                             AutomationException

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

Specified by:

setRightTableKey in interface IJoinTableSourceDescription

Parameters:

pRightTableKey - The pRightTableKey (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJoinType

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

Type of join.

Specified by:

getJoinType in interface IJoinTableSourceDescription

Returns:

A com.esri.arcgis.geodatabase.esriJoinType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJoinType

public void setJoinType(int pJoinType)
                 throws java.io.IOException,
                        AutomationException

Type of join.

Specified by:

setJoinType in interface IJoinTableSourceDescription

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

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.

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.

getMinNamespaceSupported

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

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.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:

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