com.esri.arcgis.carto
Class ClassBreaksDef

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

All Implemented Interfaces:

IClassBreaksDef, IDataClassificationDef, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

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

A coclass that describes how to generate class breaks.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ClassBreaksDef()
Constructs a ClassBreaksDef using ArcGIS Engine.

ClassBreaksDef(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ClassBreaksDef theClassBreaksDef = (ClassBreaksDef) 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
ISymbol	getBaseSymbol() Base symbol used to generate symbols for the Renderer.
int	getBreakCount() Number of breaks.
void	getClassID(GUID[] pClassID) getClassID
String	getClassificationField() Names of the classification field.
int	getClassificationMethod() Classification Method.
static String	getClsid() getClsid.
IColorRamp	getColorRamp() ColorRamp used to generate symbols for the Renderer.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
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(ObjectInput in)
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(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(String normalizationField) Normalization field.
void	setNormalizationType(int normalizationType) Normalization Type.
void	setStandardDeviationInterval(double breakCount) Standard deviation interval.
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

ClassBreaksDef

public ClassBreaksDef()
               throws IOException,
                      UnknownHostException

Constructs a ClassBreaksDef using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ClassBreaksDef

public ClassBreaksDef(Object obj)
               throws 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:

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

getBaseSymbol

public ISymbol getBaseSymbol()
                      throws IOException,
                             AutomationException

Base symbol used to generate symbols for the Renderer.

Product Availability

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

Specified by:

getBaseSymbol in interface IDataClassificationDef

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaseSymbolByRef

public void setBaseSymbolByRef(ISymbol pBaseSymbol)
                        throws IOException,
                               AutomationException

Base symbol used to generate symbols for the Renderer.

Product Availability

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

Specified by:

setBaseSymbolByRef in interface IDataClassificationDef

Parameters:

pBaseSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorRamp

public IColorRamp getColorRamp()
                        throws IOException,
                               AutomationException

ColorRamp used to generate symbols for the Renderer.

Product Availability

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

Specified by:

getColorRamp in interface IDataClassificationDef

Returns:

A reference to a com.esri.arcgis.display.IColorRamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorRampByRef

public void setColorRampByRef(IColorRamp pColorRamp)
                       throws IOException,
                              AutomationException

ColorRamp used to generate symbols for the Renderer.

Product Availability

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

Specified by:

setColorRampByRef in interface IDataClassificationDef

Parameters:

pColorRamp - A reference to a com.esri.arcgis.display.IColorRamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassificationField

public String getClassificationField()
                              throws IOException,
                                     AutomationException

Names of the classification field.

Product Availability

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

Specified by:

getClassificationField in interface IClassBreaksDef

Returns:

The classificationField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassificationField

public void setClassificationField(String classificationField)
                            throws IOException,
                                   AutomationException

Names of the classification field.

Product Availability

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

Specified by:

setClassificationField in interface IClassBreaksDef

Parameters:

classificationField - The classificationField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreakCount

public int getBreakCount()
                  throws IOException,
                         AutomationException

Number of breaks.

Product Availability

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

Specified by:

getBreakCount in interface IClassBreaksDef

Returns:

The breakCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakCount

public void setBreakCount(int breakCount)
                   throws IOException,
                          AutomationException

Number of breaks.

Product Availability

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

Specified by:

setBreakCount in interface IClassBreaksDef

Parameters:

breakCount - The breakCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassificationMethod

public int getClassificationMethod()
                            throws IOException,
                                   AutomationException

Classification Method.

Product Availability

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

Specified by:

getClassificationMethod in interface IClassBreaksDef

Returns:

A com.esri.arcgis.carto.esriClassifyMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassificationMethod

public void setClassificationMethod(int classifyMethod)
                             throws IOException,
                                    AutomationException

Classification Method.

Product Availability

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

Specified by:

setClassificationMethod in interface IClassBreaksDef

Parameters:

classifyMethod - A com.esri.arcgis.carto.esriClassifyMethod constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNormalizationField

public String getNormalizationField()
                             throws IOException,
                                    AutomationException

Normalization field.

Product Availability

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

Specified by:

getNormalizationField in interface IClassBreaksDef

Returns:

The normalizationField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNormalizationField

public void setNormalizationField(String normalizationField)
                           throws IOException,
                                  AutomationException

Normalization field.

Product Availability

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

Specified by:

setNormalizationField in interface IClassBreaksDef

Parameters:

normalizationField - The normalizationField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNormalizationType

public int getNormalizationType()
                         throws IOException,
                                AutomationException

Normalization Type.

Product Availability

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

Specified by:

getNormalizationType in interface IClassBreaksDef

Returns:

A com.esri.arcgis.carto.esriDataNormalization constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNormalizationType

public void setNormalizationType(int normalizationType)
                          throws IOException,
                                 AutomationException

Normalization Type.

Product Availability

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

Specified by:

setNormalizationType in interface IClassBreaksDef

Parameters:

normalizationType - A com.esri.arcgis.carto.esriDataNormalization constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardDeviationInterval

public double getStandardDeviationInterval()
                                    throws IOException,
                                           AutomationException

Standard deviation interval.

Remarks

Valid values for StandardDeviationInterval are as follows:

Value	Description
1	1 Std Dev
0.5	1/2 Std Dev
0.33	1/3 Std Dev
0.25	1/4 Std Dev

Product Availability

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

Specified by:

getStandardDeviationInterval in interface IClassBreaksDef

Returns:

The breakCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStandardDeviationInterval

public void setStandardDeviationInterval(double breakCount)
                                  throws IOException,
                                         AutomationException

Standard deviation interval.

Product Availability

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

Specified by:

setStandardDeviationInterval in interface IClassBreaksDef

Parameters:

breakCount - The breakCount (in)

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.

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.

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.

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