com.esri.arcgis.carto
Class HotLinkJScriptEngine

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

All Implemented Interfaces:

IAnnotationExpressionEngine, ICodedValueAttributes, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class HotLinkJScriptEngine
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnnotationExpressionEngine, ICodedValueAttributes, IPersistStream, Externalizable

An object tha parses hotlink expressions using JScript.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

HotLinkJScriptEngine()
Constructs a HotLinkJScriptEngine using ArcGIS Engine.

HotLinkJScriptEngine(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
HotLinkJScriptEngine theHotLinkJScriptEngine = (HotLinkJScriptEngine) obj;

Method Summary

String	createFunction(String name, String parameters, String expression) Creates the specified function.
boolean	equals(Object o) Compare this object with another
String	getAppendCode() The code to append.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getName() The name of the expression engine.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isUseCodedValue() Indicates if coded values are used.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
IAnnotationExpressionParser	setCode(String fullCode, String runFunction) The function to base labels on.
IAnnotationExpressionParser	setExpression(String preCode, String expression) The expression to base labels on.
void	setUseCodedValue(boolean flag) Indicates if coded values are used.
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

HotLinkJScriptEngine

public HotLinkJScriptEngine()
                     throws IOException,
                            UnknownHostException

Constructs a HotLinkJScriptEngine using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

HotLinkJScriptEngine

public HotLinkJScriptEngine(Object obj)
                     throws IOException

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

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

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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the expression engine.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IAnnotationExpressionEngine

Returns:

The expression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAppendCode

public String getAppendCode()
                     throws IOException,
                            AutomationException

The code to append.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAppendCode in interface IAnnotationExpressionEngine

Returns:

The appendCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFunction

public String createFunction(String name,
                             String parameters,
                             String expression)
                      throws IOException,
                             AutomationException

Creates the specified function.

Remarks

The CreateFunction methods is used to convert a simple expression into an Advanced Expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createFunction in interface IAnnotationExpressionEngine

Parameters:

name - The name (in)

parameters - The parameters (in)

expression - The expression (in)

Returns:

The function

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpression

public IAnnotationExpressionParser setExpression(String preCode,
                                                 String expression)
                                          throws IOException,
                                                 AutomationException

The expression to base labels on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExpression in interface IAnnotationExpressionEngine

Parameters:

preCode - The preCode (in)

expression - The expression (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCode

public IAnnotationExpressionParser setCode(String fullCode,
                                           String runFunction)
                                    throws IOException,
                                           AutomationException

The function to base labels on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCode in interface IAnnotationExpressionEngine

Parameters:

fullCode - The fullCode (in)

runFunction - The runFunction (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCodedValue

public boolean isUseCodedValue()
                        throws IOException,
                               AutomationException

Indicates if coded values are used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseCodedValue in interface ICodedValueAttributes

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCodedValue

public void setUseCodedValue(boolean flag)
                      throws IOException,
                             AutomationException

Indicates if coded values are used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUseCodedValue in interface ICodedValueAttributes

Parameters:

flag - The flag (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.

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