com.esri.arcgis.system
Class IClassifyProxy

java.lang.Object
  extended bycom.esri.arcgis.interop.Dispatch
      extended bycom.esri.arcgis.system.IClassifyProxy
All Implemented Interfaces:
java.io.Externalizable, IClassify, java.io.Serializable

public class IClassifyProxy
extends Dispatch
implements IClassify, java.io.Serializable

Provides access to members that control the classification methods.

Product Availability

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

See Also:
Serialized Form

Field Summary
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF
 
Constructor Summary
  IClassifyProxy()
          For internal use only
  IClassifyProxy(java.lang.Object obj)
           
protected IClassifyProxy(java.lang.Object obj, java.lang.String iid)
           
  IClassifyProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
           
protected IClassifyProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Adds a Java object to be a listener for a specific kind of event generated by the COM object.
 void classify(int[] numClasses)
          Classifies data into the specified number of classes.
 java.lang.Object getClassBreaks()
          The array of class breaks (double).
 IUID getClassID()
          The CLSID for the classification object.
 java.lang.String getMethodName()
          The name of the classification method (based on choice of classification object).
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Removes a Java object as a listener to events generated by a COM object.
 void setHistogramData(java.lang.Object doubleArrayValues, java.lang.Object longArrayFrequencies)
          Adds data in form of a histogram (array of values (doubles) and a paired array of frequencies (longs)) to the classification.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Constructor Detail

IClassifyProxy

public IClassifyProxy(java.lang.String CLSID,
                      java.lang.String host,
                      AuthInfo authInfo)
               throws java.net.UnknownHostException,
                      java.io.IOException

IClassifyProxy

public IClassifyProxy()
For internal use only


IClassifyProxy

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

IClassifyProxy

protected IClassifyProxy(java.lang.Object obj,
                         java.lang.String iid)
                  throws java.io.IOException

IClassifyProxy

protected IClassifyProxy(java.lang.String CLSID,
                         java.lang.String iid,
                         java.lang.String host,
                         AuthInfo authInfo)
                  throws java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Description copied from class: Dispatch
Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
addListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object to be informed of the events
theSource - the proxy class that represents the COM class that is the source of the events
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Description copied from class: Dispatch
Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
removeListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object that no longer wishes to be informed of the events
Throws:
java.io.IOException

setHistogramData

public void setHistogramData(java.lang.Object doubleArrayValues,
                             java.lang.Object longArrayFrequencies)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IClassify
Adds data in form of a histogram (array of values (doubles) and a paired array of frequencies (longs)) to the classification.

Specified by:
setHistogramData in interface IClassify
Parameters:
doubleArrayValues - A Variant (in)
longArrayFrequencies - A Variant (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

classify

public void classify(int[] numClasses)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IClassify
Classifies data into the specified number of classes.

Supported Platforms

Windows, Solaris, Linux

Description

Classify generates the ClassBreaks given the number of classes specified.  Use Classify only after you have added data to the classification using SetHistogramData.

Remarks

Having obtained the data values and frequencies using the SetHistogramData method, the next step is to compute some class breaks. Do this by calling the Classify method and specifying the number of classes you would like. You must supply the number of desired classes as a variable defined as a Long. Some classification algorithms will return a different number of class breaks to what you specified. The number of classes will be written back to the variable you supplied, so it is always best to recheck the number of class breaks after calling Classify.

Specified by:
classify in interface IClassify
Parameters:
numClasses - The numClasses (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassBreaks

public java.lang.Object getClassBreaks()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IClassify
The array of class breaks (double). ClassBreaks(0) is the minimum value in the dataset, and subsequent breaks represent the upper limit of each class.

Supported Platforms

Windows, Solaris, Linux

Description

ClassBreaks returns an array of class breaks. The number of breaks may be different than what was specified in the Classify method, so it is essential that you check this before setting the BreakCount on IClassBreaksRenderer. The reason this may be different has to do with how a particular classification method handles skewness in the data being classified.

The first ClassBreak returned is the minimum value of the data being classified. The rest of the breaks are the upper bounds for each class.  The last break represents the upper bound of the highest class.

To properly assign ClassBreaks to an IClassBreaksRenderer:

1.  Set IClassBreaksRenderer.MinimumBreak = IClassify.ClassBreaks(0)
2.  Set IClassBreaksRenderer.Breaks(0) = IClassify.ClassBreaks(1)
3.  Set IClassBreaksRenderer.Breaks(1) = IClassify.ClassBreaks(2)
     etc.

Remarks

Note that the Breaks property array on the ClassBreaksRenderer has one less entry than the array returned from Classify. The first break value in the array returned from Classify is put into the ClassBreakRenderers’ MinimumBreak property. Next, copy the break values into the ClassBreaksRenderer object. You can set up the symbol property of the classes at the same time.

Specified by:
getClassBreaks in interface IClassify
Returns:
A Variant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getMethodName

public java.lang.String getMethodName()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IClassify
The name of the classification method (based on choice of classification object).

Supported Platforms

Windows, Solaris, Linux

Description

MethodName returns the classification method name (as it appears in the classification dialog).  Use to determine the CoClass currently implementing IClassify .

Specified by:
getMethodName in interface IClassify
Returns:
The txt
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IClassify
The CLSID for the classification object.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the GUID of the classification object.

Specified by:
getClassID in interface IClassify
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.