com.esri.arcgis.carto
Class AnnotationVBScriptEngine

java.lang.Object
  extended by com.esri.arcgis.carto.AnnotationVBScriptEngine
All Implemented Interfaces:
IAnnotationExpressionEngine, ICodedValueAttributes, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class AnnotationVBScriptEngine
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnnotationExpressionEngine, ICodedValueAttributes, IPersistStream, java.io.Externalizable

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

Description 'An object that parses annotation expressions using VBScript.' 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.carto.IAnnotationExpressionEngine
IID, IIDaa157206_e079_11d2_9f48_00c04f6bc6a5, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ICodedValueAttributes
IID, IIDadcf5590_4250_4d45_b8ce_436fef905829, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
AnnotationVBScriptEngine()
          Constructs a AnnotationVBScriptEngine using ArcGIS Engine.
AnnotationVBScriptEngine(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnnotationVBScriptEngine theAnnotationVBScriptEngine = (AnnotationVBScriptEngine) obj;
 
Method Summary
 java.lang.String createFunction(java.lang.String name, java.lang.String parameters, java.lang.String expression)
          Creates the specified function.
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String getAppendCode()
          The code to append.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.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(java.io.ObjectInput in)
           
 void release()
          Release a AnnotationVBScriptEngine.
 void save(IStream pstm, int fClearDirty)
          save
 IAnnotationExpressionParser setCode(java.lang.String fullCode, java.lang.String runFunction)
          The function to base labels on.
 IAnnotationExpressionParser setExpression(java.lang.String preCode, java.lang.String expression)
          The expression to base labels on.
 void setUseCodedValue(boolean flag)
          Indicates if coded values are used.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

AnnotationVBScriptEngine

public AnnotationVBScriptEngine()
                         throws java.io.IOException,
                                java.net.UnknownHostException
Constructs a AnnotationVBScriptEngine using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

AnnotationVBScriptEngine

public AnnotationVBScriptEngine(java.lang.Object obj)
                         throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnnotationVBScriptEngine theAnnotationVBScriptEngine = (AnnotationVBScriptEngine) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


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

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the expression engine.

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

getAppendCode

public java.lang.String getAppendCode()
                               throws java.io.IOException,
                                      AutomationException
The code to append.

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

createFunction

public java.lang.String createFunction(java.lang.String name,
                                       java.lang.String parameters,
                                       java.lang.String expression)
                                throws java.io.IOException,
                                       AutomationException
Creates the specified function.

Specified by:
createFunction in interface IAnnotationExpressionEngine
Parameters:
name - The name (in)
parameters - The parameters (in)
expression - The expression (in)
Returns:
The function
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpression

public IAnnotationExpressionParser setExpression(java.lang.String preCode,
                                                 java.lang.String expression)
                                          throws java.io.IOException,
                                                 AutomationException
The expression to base labels on.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCode

public IAnnotationExpressionParser setCode(java.lang.String fullCode,
                                           java.lang.String runFunction)
                                    throws java.io.IOException,
                                           AutomationException
The function to base labels on.

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

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException