com.esri.arcgis.carto
Class LabelClassDescription

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

All Implemented Interfaces:

ILabelClassDescription, ILabelClassDescription2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class LabelClassDescription
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILabelClassDescription, ILabelClassDescription2, IXMLSerialize, IPersistStream, IXMLVersionSupport, IDocumentVersionSupportGEN, Externalizable

Lable Class Description coclass.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

LabelClassDescription()
Constructs a LabelClassDescription using ArcGIS Engine.

LabelClassDescription(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LabelClassDescription theLabelClassDescription = (LabelClassDescription) 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
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getExpressionType() ExpressionType.
String	getLabelExpression() The Label Expression.
ILabelPlacementDescription	getLabelPlacementDescription() LabelPlacementDescription.
double	getMaximumScale() Maximum scale at which the symbol will display.
double	getMinimumScale() Minimum scale at which the symbol will display.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITextSymbol	getSymbol() The text symbol used to draw the label.
String	getWhereClause() The SQL WhereClause for the label.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
boolean	isUseCodedValue() Indicates whether Coded Value Should be used when displaying label expression.
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	setExpressionType(int expressionType) ExpressionType.
void	setLabelExpression(String labelExpression) The Label Expression.
void	setLabelPlacementDescription(ILabelPlacementDescription ppLabelPlacementDescription) LabelPlacementDescription.
void	setMaximumScale(double pMaximumScale) Maximum scale at which the symbol will display.
void	setMinimumScale(double pMinimumScale) Minimum scale at which the symbol will display.
void	setSymbol(ITextSymbol ppSymbol) The text symbol used to draw the label.
void	setUseCodedValue(boolean useCodedValue) Indicates whether Coded Value Should be used when displaying label expression.
void	setWhereClause(String whereClause) The SQL WhereClause for the label.
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

LabelClassDescription

public LabelClassDescription()
                      throws IOException,
                             UnknownHostException

Constructs a LabelClassDescription using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LabelClassDescription

public LabelClassDescription(Object obj)
                      throws IOException

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

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

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

getLabelPlacementDescription

public ILabelPlacementDescription getLabelPlacementDescription()
                                                        throws IOException,
                                                               AutomationException

LabelPlacementDescription.

Remarks

LabelPlacementDescription returns one of three placement description objects depends on the geometry type of the layer – PointLabelPlacementDescription, LineLabelPlacementDescription or PolygonLabelPlacementDescription.

Product Availability

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

Specified by:

getLabelPlacementDescription in interface ILabelClassDescription

Specified by:

getLabelPlacementDescription in interface ILabelClassDescription2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelPlacementDescription

public void setLabelPlacementDescription(ILabelPlacementDescription ppLabelPlacementDescription)
                                  throws IOException,
                                         AutomationException

LabelPlacementDescription.

Product Availability

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

Specified by:

setLabelPlacementDescription in interface ILabelClassDescription

Specified by:

setLabelPlacementDescription in interface ILabelClassDescription2

Parameters:

ppLabelPlacementDescription - A reference to a com.esri.arcgis.carto.ILabelPlacementDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelExpression

public String getLabelExpression()
                          throws IOException,
                                 AutomationException

The Label Expression.

Remarks

Please note that LabelExpression either returns a field name or a simple expression set for a layer. A simple expression could be a concatenation of attribute values from two fields, for example first and last name of a parcel owner. MapServer drops any advanced expression set on the layer in the source map document and returns an empty string.

Product Availability

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

Specified by:

getLabelExpression in interface ILabelClassDescription

Specified by:

getLabelExpression in interface ILabelClassDescription2

Returns:

The labelExpression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelExpression

public void setLabelExpression(String labelExpression)
                        throws IOException,
                               AutomationException

The Label Expression.

Product Availability

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

Specified by:

setLabelExpression in interface ILabelClassDescription

Specified by:

setLabelExpression in interface ILabelClassDescription2

Parameters:

labelExpression - The labelExpression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCodedValue

public boolean isUseCodedValue()
                        throws IOException,
                               AutomationException

Indicates whether Coded Value Should be used when displaying label expression.

Product Availability

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

Specified by:

isUseCodedValue in interface ILabelClassDescription

Specified by:

isUseCodedValue in interface ILabelClassDescription2

Returns:

The useCodedValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCodedValue

public void setUseCodedValue(boolean useCodedValue)
                      throws IOException,
                             AutomationException

Indicates whether Coded Value Should be used when displaying label expression.

Product Availability

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

Specified by:

setUseCodedValue in interface ILabelClassDescription

Specified by:

setUseCodedValue in interface ILabelClassDescription2

Parameters:

useCodedValue - The useCodedValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ITextSymbol getSymbol()
                      throws IOException,
                             AutomationException

The text symbol used to draw the label.

Product Availability

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

Specified by:

getSymbol in interface ILabelClassDescription

Specified by:

getSymbol in interface ILabelClassDescription2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbol

public void setSymbol(ITextSymbol ppSymbol)
               throws IOException,
                      AutomationException

The text symbol used to draw the label.

Product Availability

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

Specified by:

setSymbol in interface ILabelClassDescription

Specified by:

setSymbol in interface ILabelClassDescription2

Parameters:

ppSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws IOException,
                              AutomationException

Maximum scale at which the symbol will display.

Remarks

When the MaximumScale is specified, features will not be labeled when zooming in beyond that scale. For example, if the MaximumScale is 500, labels will not display when zoomed in beyond 1:500.

Product Availability

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

Specified by:

getMaximumScale in interface ILabelClassDescription

Specified by:

getMaximumScale in interface ILabelClassDescription2

Returns:

The pMaximumScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double pMaximumScale)
                     throws IOException,
                            AutomationException

Maximum scale at which the symbol will display.

Product Availability

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

Specified by:

setMaximumScale in interface ILabelClassDescription

Specified by:

setMaximumScale in interface ILabelClassDescription2

Parameters:

pMaximumScale - The pMaximumScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws IOException,
                              AutomationException

Minimum scale at which the symbol will display.

Remarks

When the MinimumScale is specified, features will not be labeled when zooming out beyond that scale. For example, if the MaximumScale is 1000, labels will not display when zoomed out beyond 1:1000.

Product Availability

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

Specified by:

getMinimumScale in interface ILabelClassDescription

Specified by:

getMinimumScale in interface ILabelClassDescription2

Returns:

The pMinimumScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double pMinimumScale)
                     throws IOException,
                            AutomationException

Minimum scale at which the symbol will display.

Product Availability

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

Specified by:

setMinimumScale in interface ILabelClassDescription

Specified by:

setMinimumScale in interface ILabelClassDescription2

Parameters:

pMinimumScale - The pMinimumScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpressionType

public int getExpressionType()
                      throws IOException,
                             AutomationException

ExpressionType.

Product Availability

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

Specified by:

getExpressionType in interface ILabelClassDescription2

Returns:

A com.esri.arcgis.carto.esriLabelExpressionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionType

public void setExpressionType(int expressionType)
                       throws IOException,
                              AutomationException

ExpressionType.

Product Availability

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

Specified by:

setExpressionType in interface ILabelClassDescription2

Parameters:

expressionType - A com.esri.arcgis.carto.esriLabelExpressionType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

public String getWhereClause()
                      throws IOException,
                             AutomationException

The SQL WhereClause for the label.

Product Availability

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

Specified by:

getWhereClause in interface ILabelClassDescription2

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException

The SQL WhereClause for the label.

Product Availability

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

Specified by:

setWhereClause in interface ILabelClassDescription2

Parameters:

whereClause - The whereClause (in)

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.

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.

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.

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