com.esri.arcgis.arcmapui
Class SpatialJoin

java.lang.Object
  com.esri.arcgis.arcmapui.SpatialJoin

All Implemented Interfaces:

IAggregateOptions, ISpatialJoin, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class SpatialJoin
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISpatialJoin, IAggregateOptions

COM Class 'SpatialJoin'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description 'Spatial Join two feature classes.' 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 inherited from interface com.esri.arcgis.arcmapui.ISpatialJoin

IID, IID12b35c8f_010f_11d4_a692_0008c7d3ae8d, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IAggregateOptions

IID, IID12b35c90_010f_11d4_a692_0008c7d3ae8d, xxDummy

Constructor Summary

SpatialJoin()
Constructs a SpatialJoin using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	hashCode() the hashcode for this object
IFeatureClass	joinAggregate(IName pOutputName, double maxMapDist) Join using aggregate.
IFeatureClass	joinNearest(IName pOutputName, double maxMapDist) Joins with the nearest feature in the join feature class.
IFeatureClass	joinWithin(IName pOutputName) Joins a feature in the source feature class with the feature if it falls within in the join feature class.
void	release() Release a SpatialJoin.
void	setIsAverage(boolean rhs1) Indicates if the average of all numeric fields in the join feature class is appended to the result.
void	setIsCount(boolean rhs1) Indicates if the count of all numeric fields in the join feature class is appended to the result.
void	setIsMax(boolean rhs1) Indicates if the maximum of all numeric fields in the join feature class is appended to the result.
void	setIsMin(boolean rhs1) Indicates if the minimum of all numeric fields in the join feature class is appended to the result.
void	setIsStdDev(boolean rhs1) Indicates if the standard deviation of all numeric fields in the join feature class is appended to the result.
void	setIsSum(boolean rhs1) Indicates if the sum of all numeric fields in the join feature class is appended to the result.
void	setIsVar(boolean rhs1) Indicates if the variance of all numeric fields in the join feature class is appended to the result.
void	setJoinTableByRef(ITable rhs1) The spatial table to append fields from.
void	setLeftOuterJoin(boolean rhs1) Indicates whether a match is required before adding a record from the source feature class to the result.
void	setShowProcess(boolean bShowMessage, int rhs2) Indicates whether to show update messages while processing join.
void	setSourceTableByRef(ITable rhs1) The spatial table to append fields to.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpatialJoin

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

Constructs a SpatialJoin using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SpatialJoin

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

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

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

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 SpatialJoin.

Specified by:

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

setSourceTableByRef

public void setSourceTableByRef(ITable rhs1)
                         throws java.io.IOException,
                                AutomationException

The spatial table to append fields to.

Specified by:

setSourceTableByRef in interface ISpatialJoin

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setJoinTableByRef

public void setJoinTableByRef(ITable rhs1)
                       throws java.io.IOException,
                              AutomationException

The spatial table to append fields from.

Specified by:

setJoinTableByRef in interface ISpatialJoin

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

joinAggregate

public IFeatureClass joinAggregate(IName pOutputName,
                                   double maxMapDist)
                            throws java.io.IOException,
                                   AutomationException

Join using aggregate. Only features within a distance of maxMapDist will be joined. A maxMapDist of -1 means infinity.

Specified by:

joinAggregate in interface ISpatialJoin

Parameters:

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

maxMapDist - The maxMapDist (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

joinNearest

public IFeatureClass joinNearest(IName pOutputName,
                                 double maxMapDist)
                          throws java.io.IOException,
                                 AutomationException

Joins with the nearest feature in the join feature class. Only features within a distance of maxMapDist will be joined. A maxMapDist of -1 means infinity.

Specified by:

joinNearest in interface ISpatialJoin

Parameters:

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

maxMapDist - The maxMapDist (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

joinWithin

public IFeatureClass joinWithin(IName pOutputName)
                         throws java.io.IOException,
                                AutomationException

Joins a feature in the source feature class with the feature if it falls within in the join feature class.

Specified by:

joinWithin in interface ISpatialJoin

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowProcess

public void setShowProcess(boolean bShowMessage,
                           int rhs2)
                    throws java.io.IOException,
                           AutomationException

Indicates whether to show update messages while processing join.

Specified by:

setShowProcess in interface ISpatialJoin

Parameters:

bShowMessage - The bShowMessage (in)

rhs2 - The rhs2 (A COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeftOuterJoin

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

Indicates whether a match is required before adding a record from the source feature class to the result. If TRUE, all records in the source feature class are added regardless of whether there is a match.

Specified by:

setLeftOuterJoin in interface ISpatialJoin

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsSum

public void setIsSum(boolean rhs1)
              throws java.io.IOException,
                     AutomationException

Indicates if the sum of all numeric fields in the join feature class is appended to the result.

Specified by:

setIsSum in interface IAggregateOptions

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsAverage

public void setIsAverage(boolean rhs1)
                  throws java.io.IOException,
                         AutomationException

Indicates if the average of all numeric fields in the join feature class is appended to the result.

Specified by:

setIsAverage in interface IAggregateOptions

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsCount

public void setIsCount(boolean rhs1)
                throws java.io.IOException,
                       AutomationException

Indicates if the count of all numeric fields in the join feature class is appended to the result.

Specified by:

setIsCount in interface IAggregateOptions

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsMax

public void setIsMax(boolean rhs1)
              throws java.io.IOException,
                     AutomationException

Indicates if the maximum of all numeric fields in the join feature class is appended to the result.

Specified by:

setIsMax in interface IAggregateOptions

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsMin

public void setIsMin(boolean rhs1)
              throws java.io.IOException,
                     AutomationException

Indicates if the minimum of all numeric fields in the join feature class is appended to the result.

Specified by:

setIsMin in interface IAggregateOptions

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsStdDev

public void setIsStdDev(boolean rhs1)
                 throws java.io.IOException,
                        AutomationException

Indicates if the standard deviation of all numeric fields in the join feature class is appended to the result.

Specified by:

setIsStdDev in interface IAggregateOptions

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsVar

public void setIsVar(boolean rhs1)
              throws java.io.IOException,
                     AutomationException

Indicates if the variance of all numeric fields in the join feature class is appended to the result.

Specified by:

setIsVar in interface IAggregateOptions

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.