com.esri.arcgis.carto
Class ClassBreaksDef

java.lang.Object
  extended by com.esri.arcgis.carto.ClassBreaksDef
All Implemented Interfaces:
IClassBreaksDef, IDataClassificationDef, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class ClassBreaksDef
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataClassificationDef, IClassBreaksDef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'A coclass that describes how to generate class breaks.' 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.IClassBreaksDef
IID, IID84603a2c_01d3_47ca_8457_4f0557ed5582, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDataClassificationDef
IID3d2d6292_0780_450d_bae3_90ba2e016f11
 
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.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport
IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy
 
Constructor Summary
ClassBreaksDef()
          Constructs a ClassBreaksDef using ArcGIS Engine.
ClassBreaksDef(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ClassBreaksDef theClassBreaksDef = (ClassBreaksDef) 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
 ISymbol getBaseSymbol()
          Base symbol used to generate symbols for the Renderer.
 int getBreakCount()
          Number of breaks.
 void getClassID(GUID[] pClassID)
          getClassID
 java.lang.String getClassificationField()
          Names of the classification field.
 int getClassificationMethod()
          Classification Method.
static java.lang.String getClsid()
          getClsid.
 IColorRamp getColorRamp()
          ColorRamp used to generate symbols for the Renderer.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 java.lang.String getNormalizationField()
          Normalization field.
 int getNormalizationType()
          Normalization Type.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 double getStandardDeviationInterval()
          Standard deviation interval.
 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 ClassBreaksDef.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setBaseSymbolByRef(ISymbol pBaseSymbol)
          Base symbol used to generate symbols for the Renderer.
 void setBreakCount(int breakCount)
          Number of breaks.
 void setClassificationField(java.lang.String classificationField)
          Names of the classification field.
 void setClassificationMethod(int classifyMethod)
          Classification Method.
 void setColorRampByRef(IColorRamp pColorRamp)
          ColorRamp used to generate symbols for the Renderer.
 void setNormalizationField(java.lang.String normalizationField)
          Normalization field.
 void setNormalizationType(int normalizationType)
          Normalization Type.
 void setStandardDeviationInterval(double breakCount)
          Standard deviation interval.
 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

ClassBreaksDef

public ClassBreaksDef()
               throws java.io.IOException,
                      java.net.UnknownHostException
Constructs a ClassBreaksDef using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

ClassBreaksDef

public ClassBreaksDef(java.lang.Object obj)
               throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ClassBreaksDef theClassBreaksDef = (ClassBreaksDef) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getBaseSymbol

public ISymbol getBaseSymbol()
                      throws java.io.IOException,
                             AutomationException
Base symbol used to generate symbols for the Renderer.

Specified by:
getBaseSymbol in interface IDataClassificationDef
Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBaseSymbolByRef

public void setBaseSymbolByRef(ISymbol pBaseSymbol)
                        throws java.io.IOException,
                               AutomationException
Base symbol used to generate symbols for the Renderer.

Specified by:
setBaseSymbolByRef in interface IDataClassificationDef
Parameters:
pBaseSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorRamp

public IColorRamp getColorRamp()
                        throws java.io.IOException,
                               AutomationException
ColorRamp used to generate symbols for the Renderer.

Specified by:
getColorRamp in interface IDataClassificationDef
Returns:
A reference to a com.esri.arcgis.display.IColorRamp
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorRampByRef

public void setColorRampByRef(IColorRamp pColorRamp)
                       throws java.io.IOException,
                              AutomationException
ColorRamp used to generate symbols for the Renderer.

Specified by:
setColorRampByRef in interface IDataClassificationDef
Parameters:
pColorRamp - A reference to a com.esri.arcgis.display.IColorRamp (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassificationField

public java.lang.String getClassificationField()
                                        throws java.io.IOException,
                                               AutomationException
Names of the classification field.

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

setClassificationField

public void setClassificationField(java.lang.String classificationField)
                            throws java.io.IOException,
                                   AutomationException
Names of the classification field.

Specified by:
setClassificationField in interface IClassBreaksDef
Parameters:
classificationField - The classificationField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBreakCount

public int getBreakCount()
                  throws java.io.IOException,
                         AutomationException
Number of breaks.

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

setBreakCount

public void setBreakCount(int breakCount)
                   throws java.io.IOException,
                          AutomationException
Number of breaks.

Specified by:
setBreakCount in interface IClassBreaksDef
Parameters:
breakCount - The breakCount (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassificationMethod

public int getClassificationMethod()
                            throws java.io.IOException,
                                   AutomationException
Classification Method.

Specified by:
getClassificationMethod in interface IClassBreaksDef
Returns:
A com.esri.arcgis.carto.esriClassifyMethod constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClassificationMethod

public void setClassificationMethod(int classifyMethod)
                             throws java.io.IOException,
                                    AutomationException
Classification Method.

Specified by:
setClassificationMethod in interface IClassBreaksDef
Parameters:
classifyMethod - A com.esri.arcgis.carto.esriClassifyMethod constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationField

public java.lang.String getNormalizationField()
                                       throws java.io.IOException,
                                              AutomationException
Normalization field.

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

setNormalizationField

public void setNormalizationField(java.lang.String normalizationField)
                           throws java.io.IOException,
                                  AutomationException
Normalization field.

Specified by:
setNormalizationField in interface IClassBreaksDef
Parameters:
normalizationField - The normalizationField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNormalizationType

public int getNormalizationType()
                         throws java.io.IOException,
                                AutomationException
Normalization Type.

Specified by:
getNormalizationType in interface IClassBreaksDef
Returns:
A com.esri.arcgis.carto.esriDataNormalization constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNormalizationType

public void setNormalizationType(int normalizationType)
                          throws java.io.IOException,
                                 AutomationException
Normalization Type.

Specified by:
setNormalizationType in interface IClassBreaksDef
Parameters:
normalizationType - A com.esri.arcgis.carto.esriDataNormalization constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStandardDeviationInterval

public double getStandardDeviationInterval()
                                    throws java.io.IOException,
                                           AutomationException
Standard deviation interval.

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

setStandardDeviationInterval

public void setStandardDeviationInterval(double breakCount)
                                  throws java.io.IOException,
                                         AutomationException
Standard deviation interval.

Specified by:
setStandardDeviationInterval in interface IClassBreaksDef
Parameters:
breakCount - The breakCount (in)
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.

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.

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.

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