com.esri.arcgis.carto
Class IAnnotationExpressionParserProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IAnnotationExpressionParserProxy

All Implemented Interfaces:

IAnnotationExpressionParser, Externalizable, Serializable

public class IAnnotationExpressionParserProxy
extends com.esri.arcgis.interop.Dispatch
implements IAnnotationExpressionParser, Serializable

Provides access to members to parse annotation expressions.

Superseded By

IAnnotationExpressionParser2

When To Use

The IAnnotationExpressionParser is a low level interface maintaining information about the labeling expression.

Product Availability

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

See Also:

ILabelEngineLayerProperties, Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IAnnotationExpressionParserProxy()
	IAnnotationExpressionParserProxy(Object obj)
protected	IAnnotationExpressionParserProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	findLabel(IFeature feature) The label for a given feature based on the annotation expression.
String	getAttribute(int index) The attribute fields in the expression.
int	getAttributeCount() The number of attribute fields in the expression.
String	getExpression() The annotation expression.
void	lastError(int[] number, int[] line, String[] description) Reports error that occurred in FindLabel method.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IAnnotationExpressionParserProxy

public IAnnotationExpressionParserProxy()

IAnnotationExpressionParserProxy

public IAnnotationExpressionParserProxy(Object obj)
                                 throws IOException

Throws:

IOException

IAnnotationExpressionParserProxy

protected IAnnotationExpressionParserProxy(Object obj,
                                           String iid)
                                    throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getExpression

public String getExpression()
                     throws IOException,
                            AutomationException

The annotation expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExpression in interface IAnnotationExpressionParser

Returns:

The expression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttributeCount

public int getAttributeCount()
                      throws IOException,
                             AutomationException

The number of attribute fields in the expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAttributeCount in interface IAnnotationExpressionParser

Returns:

The attributes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttribute

public String getAttribute(int index)
                    throws IOException,
                           AutomationException

The attribute fields in the expression.

Product Availability

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

Specified by:

getAttribute in interface IAnnotationExpressionParser

Parameters:

index - The index (in)

Returns:

The attribute

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findLabel

public String findLabel(IFeature feature)
                 throws IOException,
                        AutomationException

The label for a given feature based on the annotation expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findLabel in interface IAnnotationExpressionParser

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

lastError

public void lastError(int[] number,
                      int[] line,
                      String[] description)
               throws IOException,
                      AutomationException

Reports error that occurred in FindLabel method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

lastError in interface IAnnotationExpressionParser

Parameters:

number - The number (in/out: use single element array)

line - The line (in/out: use single element array)

description - The description (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.