com.esri.arcgis.carto
Class HotLinkExpressionParser

java.lang.Object
  extended by com.esri.arcgis.carto.HotLinkExpressionParser
All Implemented Interfaces:
IAnnotationExpressionParser, IAnnotationExpressionParser2, ICodedValueAttributes, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class HotLinkExpressionParser
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnnotationExpressionParser, IAnnotationExpressionParser2, ICodedValueAttributes

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

Description 'The expression parser handed out by the HotLink Expression Engines.' 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
 
Fields inherited from interface com.esri.arcgis.carto.IAnnotationExpressionParser
IID, IIDaa157205_e079_11d2_9f48_00c04f6bc6a5, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IAnnotationExpressionParser2
IID, IID56426ae7_a129_43d7_8eb7_2b41f507f390, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ICodedValueAttributes
IID, IIDadcf5590_4250_4d45_b8ce_436fef905829, xxDummy
 
Constructor Summary
HotLinkExpressionParser(java.lang.Object obj)
          Construct a HotLinkExpressionParser using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String findLabel(IFeature feature)
          The label for a given feature based on the annotation expression.
 java.lang.String findLabel(IFeature feature, ILayerFields pLayerFields)
          The label for a given feature based on the annotation expression.
 java.lang.String getAttribute(int index)
          The attribute fields in the expression.
 int getAttributeCount()
          The number of attribute fields in the expression.
 java.lang.String getExpression()
          The annotation expression.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int hashCode()
          the hashcode for this object
 boolean isUseCodedValue()
          Indicates if coded values are used.
 void lastError(int[] number, int[] line, java.lang.String[] description)
          Reports error that occurred in FindLabel method.
 void release()
          Release a HotLinkExpressionParser.
 void setUseCodedValue(boolean flag)
          Indicates if coded values are used.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HotLinkExpressionParser

public HotLinkExpressionParser(java.lang.Object obj)
                        throws java.io.IOException
Construct a HotLinkExpressionParser using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to HotLinkExpressionParser.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
HotLinkExpressionParser o = (HotLinkExpressionParser)obj; // will not work

HotLinkExpressionParser o = new HotLinkExpressionParser(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems HotLinkExpressionParser theHotLinkExpressionParser = (HotLinkExpressionParser) obj;
Method Detail

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

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

getExpression

public java.lang.String getExpression()
                               throws java.io.IOException,
                                      AutomationException
The annotation expression.

Specified by:
getExpression in interface IAnnotationExpressionParser
Specified by:
getExpression in interface IAnnotationExpressionParser2
Returns:
The expression
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeCount

public int getAttributeCount()
                      throws java.io.IOException,
                             AutomationException
The number of attribute fields in the expression.

Specified by:
getAttributeCount in interface IAnnotationExpressionParser
Specified by:
getAttributeCount in interface IAnnotationExpressionParser2
Returns:
The attributes
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttribute

public java.lang.String getAttribute(int index)
                              throws java.io.IOException,
                                     AutomationException
The attribute fields in the expression.

Specified by:
getAttribute in interface IAnnotationExpressionParser
Specified by:
getAttribute in interface IAnnotationExpressionParser2
Parameters:
index - The index (in)
Returns:
The attribute
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findLabel

public java.lang.String findLabel(IFeature feature)
                           throws java.io.IOException,
                                  AutomationException
The label for a given feature based on the annotation expression.

Specified by:
findLabel in interface IAnnotationExpressionParser
Parameters:
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Returns:
The label
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

lastError

public void lastError(int[] number,
                      int[] line,
                      java.lang.String[] description)
               throws java.io.IOException,
                      AutomationException
Reports error that occurred in FindLabel method.

Specified by:
lastError in interface IAnnotationExpressionParser
Specified by:
lastError in interface IAnnotationExpressionParser2
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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findLabel

public java.lang.String findLabel(IFeature feature,
                                  ILayerFields pLayerFields)
                           throws java.io.IOException,
                                  AutomationException
The label for a given feature based on the annotation expression.

Specified by:
findLabel in interface IAnnotationExpressionParser2
Parameters:
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
pLayerFields - A reference to a com.esri.arcgis.carto.ILayerFields (in)
Returns:
The label
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseCodedValue

public boolean isUseCodedValue()
                        throws java.io.IOException,
                               AutomationException
Indicates if coded values are used.

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

setUseCodedValue

public void setUseCodedValue(boolean flag)
                      throws java.io.IOException,
                             AutomationException
Indicates if coded values are used.

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