A B C D E F G H I J K L M N O P R S T U W X

A

actionPerformed(ActionEvent) - Method in class simkin.examples.applet.SimkinXMLApplet

This method is called when the Run button is pressed

actionPerformed(ActionEvent) - Method in class simkin.examples.applet.ScriptedDialog

this method catches button clicks and calls methods

actionPerformed(ActionEvent) - Method in class simkin.examples.applet.MsgBox

actionPerformed(ActionEvent) - Method in class simkin.examples.dialog.ScriptedDialog

this method catches button clicks and calls methods

actionPerformed(ActionEvent) - Method in class simkin.examples.dialog.MsgBox

add_escapes(String) - Method in class simkin.ParseException

Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.

addChild(TreeNode) - Method in class simkin.TreeNode

Adds a node to the list of this node's children

addElement(String) - Method in class simkin.XMLElementObject

adds a new element with the given tag name to this element

addEscapes(String) - Static method in class simkin.TokenMgrError

Replaces unprintable characters by their espaced (or unicode escaped) equivalents in the given string

addGlobalVariable(String, Object) - Method in class simkin.Interpreter

Adds a global variable to the current list

addNode(String, String) - Method in class simkin.TreeNodeObject

this method adds a new child node with the given name and data

addStrings(String, String) - Static method in class simkin.Utils

Adds two strings together efficiently

addStrings(String, String, String) - Static method in class simkin.Utils

Adds three strings together efficiently

addStrings(String, String, String, String) - Static method in class simkin.Utils

Adds four strings together efficiently

addStrings(String, String, String, String, String) - Static method in class simkin.Utils

Adds five strings together efficiently

addStrings(String, String, String, String, String, String) - Static method in class simkin.Utils

Adds six strings together efficiently

addStrings(String, String, String, String, String, String, String) - Static method in class simkin.Utils

Adds seven strings together efficiently

addStrings(String, String, String, String, String, String, String, String) - Static method in class simkin.Utils

Adds eight strings together efficiently

adjustBeginLineColumn(int, int) - Method in class simkin.JavaCharStream

Method to adjust line and column numbers for the start of a token.

Age - Variable in class simkin.examples.person.Person

This is a public field - giving the person's age

AND - Static variable in interface simkin.ParserConstants

ArrayExample - class simkin.examples.array.ArrayExample.

This class shows how an array can be accessed by a Simkin script, where the array is stored in an XML file, or as a Java array

ArrayExample(String, InputStream) - Constructor for class simkin.examples.array.ArrayExample

constructor just passes the XML input stream to its parent

ASSIGN - Static variable in interface simkin.ParserConstants

B

backup(int) - Method in class simkin.JavaCharStream

beginColumn - Variable in class simkin.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

beginLine - Variable in class simkin.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

BeginToken() - Method in class simkin.JavaCharStream

boolData() - Method in class simkin.TreeNode

Returns this node's data as a boolean

boolValue(Object) - Static method in class simkin.Interpreter

This method converts the given value into a boolean value

BREAK - Static variable in interface simkin.ParserConstants

breakpoint(StackFrame) - Method in interface simkin.StatementStepper

This method is called if the interpreter encounters a breakpoint command.

bufpos - Variable in class simkin.JavaCharStream

C

CASE - Static variable in interface simkin.ParserConstants

CHARACTER - Static variable in interface simkin.ParserConstants

checkThrowException(ExecutableContext, Exception, String) - Method in class simkin.Interpreter

Alerts the current statement stepper (if there is one) that an exception has occurred

clear() - Method in class simkin.TreeNode

this deletes any children of this node

clone() - Method in class simkin.TreeNode

this method returns a cloned version of this node - it performs a deep copy

close() - Method in class simkin.examples.applet.ScriptedDialog

This method closes the dialog - because it is public it can be called from Simkin scripts

close() - Method in class simkin.examples.dialog.ScriptedDialog

This method closes the dialog - because it is public it can be called from Simkin scripts

COLON - Static variable in interface simkin.ParserConstants

COMMA - Static variable in interface simkin.ParserConstants

commandAction(Command, Displayable) - Method in class simkin.examples.helloworld_midp.HelloScreen

compoundStatementExecuted(StackFrame) - Method in interface simkin.StatementStepper

This method is called each time a compound statement is executed by the interpreter, just before the statement is performed

CONCAT - Static variable in interface simkin.ParserConstants

containsElement(String) - Method in class simkin.XMLElementObject

returns true if this element contains an element with the given tag name

containsNode(String) - Method in class simkin.TreeNodeObject

this method returns true if the node contains a child with the given label

copyAttributesInto(Element) - Method in class simkin.XMLElementObject

This method clears the other elements attributes and copies from ours into it

copyItems(TreeNode) - Method in class simkin.TreeNode

this function performs a deep copy from the children of another node into this one

copyItemsInto(Element) - Method in class simkin.XMLElementObject

Clears the other element and does a deep copy of the children of this node into that one

createIterator() - Method in class simkin.TreeNodeObject

This method returns a TreeNodeObjectEnumerator object which is used in a foreach statement.

createIterator() - Method in class simkin.ExecutableRoot

Returns null - by default can't be iterated over

createIterator() - Method in class simkin.XMLElementObject

This method returns an XMLElementObjectEnumerator object which is used in a foreach statement.

createIterator() - Method in interface simkin.Executable

This method returns an ExecutableIterator object which is used in a foreach statement.

createIterator(String) - Method in class simkin.TreeNodeObject

This method returns a TreeNodeObjectEnumerator object which is used in a foreach statement.

createIterator(String) - Method in class simkin.ExecutableRoot

Returns null - by default can't be iterated over

createIterator(String) - Method in class simkin.XMLElementObject

This method returns an XMLElementObjectEnumerator object which is used in a foreach statement.

createIterator(String) - Method in interface simkin.Executable

This method returns an ExecutableIterator object which is used in a foreach statement.

createTreeNodeObject(String, TreeNode) - Method in class simkin.TreeNodeObject

This method creates a new TreeNodeObject object to wrap a treenode.

createXMLElementObject(String, Element) - Method in class simkin.XMLElementObject

This method creates a new XML Element object to wrap an element.

createXMLElementObject(String, Element) - Method in class simkin.examples.inherits.InheritsElement

overrides this method so that sub-elements also understand the inherits tag

curChar - Variable in class simkin.ParserTokenManager

currentToken - Variable in class simkin.ParseException

This is the last token that has been consumed successfully.

D

data() - Method in class simkin.TreeNodeObject

returns the data for the underlying node

data() - Method in class simkin.TreeNode

Returns this node's data

data(String) - Method in class simkin.TreeNode

sets this node's data

debugStream - Variable in class simkin.ParserTokenManager

DEFAULT - Static variable in interface simkin.ParserConstants

DEFAULTCASE - Static variable in interface simkin.ParserConstants

destroyApp(boolean) - Method in class simkin.examples.helloworld_midp.HelloWorld

DIGIT - Static variable in interface simkin.ParserConstants

Done() - Method in class simkin.JavaCharStream

doPost(HttpServletRequest, HttpServletResponse) - Method in class simkin.examples.servlet.SimkinServlet

Handle a post request - loads the Simkin script from the "code" variable, executes it, and returns the output

DOT - Static variable in interface simkin.ParserConstants

dump() - Method in class simkin.XMLElementObject

This method writes the entire XML element out to the tracer

dump(Interpreter) - Method in class simkin.TreeNodeObject

This method writes the entire node tree to stdout

DynamicTreeNode - class simkin.examples.dynamic_treenode.DynamicTreeNode.

This programs shows how to use dynamic treenodes.

DynamicTreeNode() - Constructor for class simkin.examples.dynamic_treenode.DynamicTreeNode

E

EACH - Static variable in interface simkin.ParserConstants

ELSE - Static variable in interface simkin.ParserConstants

endColumn - Variable in class simkin.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

endLine - Variable in class simkin.Token

beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.

enumerate() - Method in class simkin.TreeNodeObject

This method returns an object which can iterate over all the immediate child node of this node

enumerate() - Method in class simkin.XMLElementObject

This method returns an object which can iterate over all the immediate child elements of this element

enumerate() - Method in class simkin.TreeNode

This method returns an object which can iterate over all the immediate child node of this node

enumerate(String) - Method in class simkin.TreeNodeObject

This method returns an object which can iterate over all the immediate child nodes of this node whose label matches the one given

enumerate(String) - Method in class simkin.XMLElementObject

This method returns an object which can iterate over all the immediate child elements of this element whose tagname matches the one given

EOF - Static variable in interface simkin.ParserConstants

eol - Variable in class simkin.ParseException

The end of line string for this machine.

equals(Object) - Method in class simkin.TreeNodeObject

equals(Object) - Method in class simkin.XMLElementObject

tests for equality with another object, using the string value

evaluateExpression(String, Object, String, Hashtable, ExecutableContext) - Method in class simkin.Interpreter

this function parses and evaluates an expression within the given context

exceptionEncountered(StackFrame, Exception, String) - Method in interface simkin.StatementStepper

This method is called if an exception is encountered while executing a script.

Executable - interface simkin.Executable.

This interface is implemented by objects which want to override the method and field access which uses Java introspection by default.

ExecutableContext - class simkin.ExecutableContext.

This class stores info about the current execution context - such the name of the current script and the line number being executed.

ExecutableContext(Interpreter) - Constructor for class simkin.ExecutableContext

ExecutableIterator - interface simkin.ExecutableIterator.

This interface is implemented by objects can iterate over Executable objects.

ExecutableRoot - class simkin.ExecutableRoot.

This class provides an implementation of the Executable interface which can be conveniently extended

ExecutableRoot() - Constructor for class simkin.ExecutableRoot

executeCode(String) - Method in class simkin.examples.applet.SimkinXMLApplet

executeParseTree(String, Object, ParseNode, Object[], ExecutableContext) - Method in class simkin.Interpreter

This method executes a piece of Simkin code from a parse tree.

ExecuteResult - class simkin.ExecuteResult.

This class is used by the Interpreter to return the result of an execute() method.

executeString(String, Object, String, Object[], ExecutableContext) - Method in class simkin.Interpreter

This method executes a piece of Simkin code within a string

executeStringExternalParams(String, Object, Vector, String, Object[], ExecutableContext) - Method in class simkin.Interpreter

This method executes a piece of Simkin code within a string, it assumes that the parameters have been defined outside the statement block.

expectedTokenSequences - Variable in class simkin.ParseException

Each entry in this array is an array of integers.

F

FieldNotSupportedException - exception simkin.FieldNotSupportedException.

This class is thrown to indicate that a field is not supported.

FieldNotSupportedException(String) - Constructor for class simkin.FieldNotSupportedException

findChild(Element, int) - Static method in class simkin.XMLElementObject

returns the nth child element

findChild(Element, String) - Static method in class simkin.XMLElementObject

returns a child element

findChild(Element, String, String, String) - Static method in class simkin.XMLElementObject

returns a child element with the given attribute set to the given value

findChild(String) - Method in class simkin.TreeNodeObject

this method finds a new child node with the given name

findChild(String) - Method in class simkin.TreeNode

finds the first child with the given label - returns null if none found

findChild(String, String) - Method in class simkin.TreeNodeObject

this method finds a new child node with the given name and data

findChild(String, String) - Method in class simkin.TreeNode

finds the first child with the given label and data - returns null if none found

findChildBoolData(String) - Method in class simkin.TreeNode

returns the data of the first child with the given label as a boolean

findChildBoolData(String, boolean) - Method in class simkin.TreeNode

returns the data of the first child with the given label as a boolean

findChildData(String) - Method in class simkin.TreeNode

returns the data of the first child with the given label

findChildData(String, String) - Method in class simkin.TreeNode

returns the data of the first child with the given label

findChildFloatData(String) - Method in class simkin.TreeNode

returns the data of the first child with the given label as a float

findChildIntData(String) - Method in class simkin.TreeNode

returns the data of the first child with the given label as an integer

findChildIntData(String, int) - Method in class simkin.TreeNode

returns the data of the first child with the given label as a boolean

findGlobalVariable(String) - Method in class simkin.Interpreter

looks for the given global variable.

FLOAT - Static variable in interface simkin.ParserConstants

floatData() - Method in class simkin.TreeNode

Returns this node's data as an float

floatData(float) - Method in class simkin.TreeNode

sets this node's float data

floatValue(Object) - Static method in class simkin.Interpreter

This method converts the given value into a double value

FOR - Static variable in interface simkin.ParserConstants

G

g_Break - Static variable in class simkin.Interpreter

special marker object for break

g_false - Static variable in class simkin.TreeNode

g_False - Static variable in class simkin.Interpreter

false object

g_FileMagic - Static variable in class simkin.TreeNode

g_FileVersion - Static variable in class simkin.TreeNode

g_null - Static variable in class simkin.Interpreter

the null object

g_Out - Static variable in class simkin.Tracer

This variable holds the output writer, by default this is System.out

g_Tracing - Static variable in class simkin.Tracer

This variable controls whether the output is printed to stdout or not - by default the value is true

g_true - Static variable in class simkin.TreeNode

g_True - Static variable in class simkin.Interpreter

true object

g_Zero - Static variable in class simkin.Interpreter

zero object

GE - Static variable in interface simkin.ParserConstants

GE_1 - Static variable in interface simkin.ParserConstants

getAddIfNotPresent() - Method in class simkin.TreeNodeObject

this returns the value of the flag controlling whether new elements are created as they are accessed

getAddIfNotPresent() - Method in class simkin.XMLElementObject

this returns the value of the flag controlling whether new elements are created as they are accessed

getAttribute(String) - Method in class simkin.XMLElementObject

This method returns the value of an attribute attached to this element.

getAttributes() - Method in class simkin.ExecutableRoot

This method returns the attributes for this object.

getAttributes() - Method in class simkin.XMLElementObject

This method returns the attributes for this object.

getAttributes() - Method in interface simkin.Executable

This method returns the attributes for this object

getBeginColumn() - Method in class simkin.JavaCharStream

getBeginLine() - Method in class simkin.JavaCharStream

getColumn() - Method in class simkin.JavaCharStream

Deprecated.

getContext() - Method in class simkin.StackFrame

returns the context within which the stack frame is executing

getData(Element) - Static method in class simkin.XMLElementObject

retrieves the text data from an element

getElement() - Method in class simkin.XMLElementObject

This method returns the XML Element being held by the object.

getEndColumn() - Method in class simkin.JavaCharStream

getEndLine() - Method in class simkin.JavaCharStream

getGlobalVariables() - Method in class simkin.Interpreter

This method returns the current global variables for this instance of the Interpreter

GetImage() - Method in class simkin.JavaCharStream

getInstanceVariables() - Method in class simkin.TreeNodeObject

This method returns the instance variables for this object.

getInstanceVariables() - Method in class simkin.ExecutableRoot

This method returns the instance variables for this object.

getInstanceVariables() - Method in class simkin.XMLElementObject

This method returns the instance variables for this object.

getInstanceVariables() - Method in interface simkin.Executable

This method returns the instance variables for this object

getInterpreter() - Method in class simkin.ExecutableContext

Returns the interpreter associated with this context

getItems() - Method in class simkin.TreeNode

this function returns the list of children of this node

getIterator() - Method in class simkin.TreeNode

This method returns an iterator that can be used to iterate over the children of this node

getLine() - Method in class simkin.JavaCharStream

Deprecated.

getLineNum() - Method in class simkin.StackFrame

returns the current line number

getLineNumber() - Method in class simkin.ParseNode

this method returns an integer indicating the line number in the source at which the item starts

getLocation() - Method in class simkin.TreeNodeObject

returns the location of this node

getLocation() - Method in class simkin.StackFrame

returns the location of the code being executed in this stack frame

getLocation() - Method in class simkin.XMLElementObject

returns the location of this element

getMessage() - Method in class simkin.TokenMgrError

You can also modify the body of this method to customize your error messages.

getMessage() - Method in class simkin.ParseException

This method has the standard behavior when this object has been created using the standard constructors.

getNextToken() - Method in class simkin.ParserTokenManager

getNode() - Method in class simkin.TreeNodeObject

getObject() - Method in class simkin.StackFrame

returns the object owning the stack frame

getParentFrame() - Method in class simkin.StackFrame

returns the parent frame of this one

getParseTree() - Method in class simkin.ExecuteResult

Returns the parse tree for the method, which can be cached and passed to a faster execute() method

getReflectionEnabled() - Method in class simkin.Interpreter

Returns the value of the reflection enabled flag.

getResult() - Method in class simkin.ExecuteResult

Returns the method call result

getSource(String) - Method in class simkin.TreeNodeObject

This method returns the source for a scripted method described by the location.

getSource(String) - Method in class simkin.ExecutableRoot

This method returns the source for a scripted method described by the location.

getSource(String) - Method in class simkin.XMLElementObject

This method returns the source for a scripted method described by the location.

getSource(String) - Method in interface simkin.Executable

This method returns the source for a scripted method described by the location

GetSuffix(int) - Method in class simkin.JavaCharStream

getText(String) - Method in class simkin.examples.applet.ScriptedDialog

This method returns the text in a text control - because it is public it can be called from Simkin scripts

getText(String) - Method in class simkin.examples.dialog.ScriptedDialog

This method returns the text in a text control - because it is public it can be called from Simkin scripts

getTopFrame() - Method in class simkin.ExecutableContext

This method returns the current StackFrame active in the interpreter

getType() - Method in class simkin.ParseNode

this method returns an integer indicating the type of the node

getValue(String, String, ExecutableContext) - Method in class simkin.TreeNodeObject

this method retrieves a value from the in-memory treenode object.

getValue(String, String, ExecutableContext) - Method in class simkin.ExecutableRoot

This method calls the Interpreter's reflectiveGetValue method

getValue(String, String, ExecutableContext) - Method in class simkin.Interpreter

Returns the value of the "tracing" variable - e.g.

getValue(String, String, ExecutableContext) - Method in class simkin.XMLElementObject

Retrieves a field from the XML.

getValue(String, String, ExecutableContext) - Method in interface simkin.Executable

Called to get the value of a field

getValueAt(Object, String, ExecutableContext) - Method in class simkin.TreeNodeObject

this method retrieves a value from the in-memory treenode object.

getValueAt(Object, String, ExecutableContext) - Method in class simkin.ExecutableRoot

This method does nothing at this level

getValueAt(Object, String, ExecutableContext) - Method in class simkin.Interpreter

Returns null - this is not a collection

getValueAt(Object, String, ExecutableContext) - Method in class simkin.XMLElementObject

Retrieves the nth child element from this element.

getValueAt(Object, String, ExecutableContext) - Method in interface simkin.Executable

Called to get the value of an object in this collection

getVars() - Method in class simkin.StackFrame

returns the local variables for this stack frame

GT - Static variable in interface simkin.ParserConstants

GT_1 - Static variable in interface simkin.ParserConstants

H

hasMoreElements() - Method in class simkin.TreeNodeIterator

This function returns true if the iteration has not yet been finished

HelloScreen - class simkin.examples.helloworld_midp.HelloScreen.

This class shows a screen which catches Trace output from the Simkin interpreter and puts it into a list box

HelloScreen(HelloWorld) - Constructor for class simkin.examples.helloworld_midp.HelloScreen

HelloWorld - class simkin.examples.helloworld.HelloWorld.

This class shows the simplest possible application which just prints "Hello World"

HelloWorld - class simkin.examples.helloworld_midp.HelloWorld.

This class shows the simplest possible application which just prints "Hello World"

HelloWorld() - Constructor for class simkin.examples.helloworld.HelloWorld

HelloWorld() - Constructor for class simkin.examples.helloworld_midp.HelloWorld

I

ID - Static variable in interface simkin.ParserConstants

IF - Static variable in interface simkin.ParserConstants

image - Variable in class simkin.Token

The string image of the token.

IN - Static variable in interface simkin.ParserConstants

Inherits - class simkin.examples.inherits.Inherits.

This Java program loads XML files containing Simkin script.

Inherits() - Constructor for class simkin.examples.inherits.Inherits

InheritsElement - class simkin.examples.inherits.InheritsElement.

this class extends the XMLElementObject class with understanding of the <inherits> tag.

InheritsElement(String, Element) - Constructor for class simkin.examples.inherits.InheritsElement

Constructor - passes element up to its parent

InheritsExecutable - class simkin.examples.inherits.InheritsExecutable.

This class loads an XML file and makes sure any <inherits> tags are resolved.

InheritsExecutable(String, InputStream) - Constructor for class simkin.examples.inherits.InheritsExecutable

Constructor taking an input stream containing an XML document

intData() - Method in class simkin.TreeNode

Returns this node's data as an integer

intData(boolean) - Method in class simkin.TreeNode

sets this node's boolean data

intData(int) - Method in class simkin.TreeNode

sets this node's integer data

INTEGER - Static variable in interface simkin.ParserConstants

Interpreter - class simkin.Interpreter.

This class represents the Simkin interpreter.

Interpreter() - Constructor for class simkin.Interpreter

Default constructor - adds a global variable pointing to this interpreter

intValue(Object) - Static method in class simkin.Interpreter

This method converts the given value into an integer value

J

JavaCharStream - class simkin.JavaCharStream.

An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (with java-like unicode escape processing).

JavaCharStream(InputStream) - Constructor for class simkin.JavaCharStream

JavaCharStream(InputStream, int, int) - Constructor for class simkin.JavaCharStream

JavaCharStream(InputStream, int, int, int) - Constructor for class simkin.JavaCharStream

JavaCharStream(Reader) - Constructor for class simkin.JavaCharStream

JavaCharStream(Reader, int, int) - Constructor for class simkin.JavaCharStream

JavaCharStream(Reader, int, int, int) - Constructor for class simkin.JavaCharStream

jjstrLiteralImages - Static variable in class simkin.ParserTokenManager

K

kind - Variable in class simkin.Token

An integer that describes the kind of this token.

L

label() - Method in class simkin.TreeNodeObject

returns the label for the underlying node

label() - Method in class simkin.TreeNode

Returns this node's label

label(String) - Method in class simkin.TreeNode

Changes this node's label

LBRACE - Static variable in interface simkin.ParserConstants

LBRACKET - Static variable in interface simkin.ParserConstants

LE - Static variable in interface simkin.ParserConstants

LE_1 - Static variable in interface simkin.ParserConstants

LETTER - Static variable in interface simkin.ParserConstants

lexStateNames - Static variable in class simkin.ParserTokenManager

load(InputStream) - Method in class simkin.examples.inherits.InheritsExecutable

This method is overriden to search for the inherits tag

load(String, InputStream) - Method in class simkin.TreeNodeObject

loads the treenode from the given stream

load(String, InputStream) - Method in class simkin.XMLExecutable

This method causes the XML to be reloaded

load(String, Reader) - Method in class simkin.XMLExecutable

This method causes the XML to be reloaded

LPAREN - Static variable in interface simkin.ParserConstants

LT - Static variable in interface simkin.ParserConstants

LT_1 - Static variable in interface simkin.ParserConstants

M

m_FileName - Variable in class simkin.examples.dialog.ScriptedDialog

the name of the XML file

main(String[]) - Static method in class simkin.examples.scriptloader.ScriptLoader

Entry point for the ScriptLoader application.

main(String[]) - Static method in class simkin.examples.helloworld.HelloWorld

main(String[]) - Static method in class simkin.examples.person.Person

Entry point - executes the script

main(String[]) - Static method in class simkin.examples.dialog.ScriptedDialog

pick up the name of the dialog file from the command line, and then create an instance of ScriptedDialog from the XML file name

main(String[]) - Static method in class simkin.examples.array.ArrayExample

load up the xml file named in the command line into an ArrayExample object and then run the main method

main(String[]) - Static method in class simkin.examples.inherits.Inherits

Entry point for the Inherits application.

main(String[]) - Static method in class simkin.examples.dynamic_treenode.DynamicTreeNode

Entry point for the DynamicTreeNode application.

method(String, Object[], ExecutableContext) - Method in class simkin.TreeNodeObject

this method attempts to find the named method within the in-memory treenode object.

method(String, Object[], ExecutableContext) - Method in class simkin.ExecutableRoot

The following methods are supported directly by this class:

method(String, Object[], ExecutableContext) - Method in class simkin.Interpreter

The following methods are supported directly by this class:

method(String, Object[], ExecutableContext) - Method in class simkin.XMLElementObject

this method attempts to execute a method stored in the XML.

method(String, Object[], ExecutableContext) - Method in interface simkin.Executable

Called if a Simkin script calls a method on this object.

MethodNotSupportedException - exception simkin.MethodNotSupportedException.

This class is thrown to indicate that a method is not supported.

MethodNotSupportedException(String) - Constructor for class simkin.MethodNotSupportedException

MINUS - Static variable in interface simkin.ParserConstants

MOD - Static variable in interface simkin.ParserConstants

moveItemsFrom(TreeNode) - Method in class simkin.TreeNode

this function moves the children from the given node into this node

MsgBox - class simkin.examples.applet.MsgBox.

This class shows a simple message box

MsgBox - class simkin.examples.dialog.MsgBox.

This class shows a simple message box

msgBox(String) - Method in class simkin.examples.applet.ScriptedDialog

This method shows a message box - because it is public it can be called from Simkin scripts

msgBox(String) - Method in class simkin.examples.dialog.ScriptedDialog

This method shows a message box - because it is public it can be called from Simkin scripts

N

Name - Variable in class simkin.examples.person.Person

This is a public field - giving the person's name

nativeArray - Variable in class simkin.examples.array.ArrayExample

this java array is public, and therefore accessible to the Simkin scripts

newToken(int) - Static method in class simkin.Token

Returns a new Token object, by default.

next - Variable in class simkin.Token

A reference to the next regular (non-special) token from the input stream.

next() - Method in class simkin.XMLElementObjectEnumerator

returns the next object in the enumeration - or null if there are no more

next() - Method in class simkin.TreeNodeObjectEnumerator

returns the next object in the enumeration - or null if there are no more

next() - Method in interface simkin.ExecutableIterator

this method returns the next object in the enumeration, or null if the enumeration is ended

next() - Method in class simkin.TreeNodeEnumerator

returns the next object in the enumeration - or null if there are no more

nextElement() - Method in class simkin.TreeNodeIterator

this function returns the next element in the iteration

NOT - Static variable in interface simkin.ParserConstants

NOTEQUAL - Static variable in interface simkin.ParserConstants

nthChild(int) - Method in class simkin.TreeNodeObject

this method finds the nth child node

nthChild(int) - Method in class simkin.TreeNode

This method returns the nth child at this node

nthChildData(int) - Method in class simkin.TreeNode

this method returns the data of the nth child

nthChildFloatData(int, float) - Method in class simkin.TreeNode

this method returns the data of the nth child as a float

nthChildIntData(int, int) - Method in class simkin.TreeNode

this method returns the data of the nth child as an integer

Null - class simkin.Null.

This class is used to instantiate a single instance of the "null" object within the Interpreter

Null() - Constructor for class simkin.Null

numChildren() - Method in class simkin.TreeNodeObject

numChildren() - Method in class simkin.TreeNode

This method returns the number of children in the list at this node

O

OR - Static variable in interface simkin.ParserConstants

P

parse(String, String, ExecutableContext) - Method in class simkin.Interpreter

This method parses a string full of Simkin code and returns the parse tree.

ParseException - exception simkin.ParseException.

This exception is thrown when parse errors are encountered.

ParseException() - Constructor for class simkin.ParseException

The following constructors are for use by you for whatever purpose you can think of.

ParseException(String) - Constructor for class simkin.ParseException

ParseException(Token, int[][], String[]) - Constructor for class simkin.ParseException

This constructor is used by the method "generateParseException" in the generated parser.

parseExternalParams(String, Vector, String, ExecutableContext) - Method in class simkin.Interpreter

This method parses a string of Simkin statements, excluding parameters and enclosing braces.

ParseNode - class simkin.ParseNode.

ParseNode - this class is the base class for nodes in the parse tree

ParseNode(int) - Constructor for class simkin.ParseNode

ParserConstants - interface simkin.ParserConstants.

ParserTokenManager - class simkin.ParserTokenManager.

ParserTokenManager(JavaCharStream) - Constructor for class simkin.ParserTokenManager

ParserTokenManager(JavaCharStream, int) - Constructor for class simkin.ParserTokenManager

pauseApp() - Method in class simkin.examples.helloworld_midp.HelloWorld

Person - class simkin.examples.person.Person.

This program shows how a Simkin script can access fields and methods within any Java object

Person() - Constructor for class simkin.examples.person.Person

PLUS - Static variable in interface simkin.ParserConstants

popStackFrame() - Method in class simkin.ExecutableContext

takes the top stack frame off the stack

pushStackFrame(StackFrame) - Method in class simkin.ExecutableContext

puts a new stack frame on the stack

R

RBRACE - Static variable in interface simkin.ParserConstants

RBRACKET - Static variable in interface simkin.ParserConstants

read() - Method in class simkin.TreeNodeReader

this function invokes the parser and returns a TreeNode representing the contents of the stream.

read(InputStream) - Static method in class simkin.TreeNode

This function attempts to read a TreeNode from the given stream.

read(Reader) - Static method in class simkin.TreeNode

This function attempts to read a TreeNode from the given reader.

readChar() - Method in class simkin.JavaCharStream

reflectiveGetValue(ExecutableContext, Object, String) - Method in class simkin.Interpreter

This function attempts to retrieve a public Java field using reflection

reflectiveMethodCall(ExecutableContext, Object, String, Object[]) - Method in class simkin.Interpreter

This function attempts to make a public method call on a Java object by using reflection

reflectiveSetValue(ExecutableContext, Object, String, Object) - Method in class simkin.Interpreter

This function attempts to set a public Java field using reflection

ReInit(InputStream) - Method in class simkin.JavaCharStream

ReInit(InputStream, int, int) - Method in class simkin.JavaCharStream

ReInit(InputStream, int, int, int) - Method in class simkin.JavaCharStream

ReInit(JavaCharStream) - Method in class simkin.ParserTokenManager

ReInit(JavaCharStream, int) - Method in class simkin.ParserTokenManager

ReInit(Reader) - Method in class simkin.JavaCharStream

ReInit(Reader, int, int) - Method in class simkin.JavaCharStream

ReInit(Reader, int, int, int) - Method in class simkin.JavaCharStream

reload() - Method in class simkin.examples.dialog.ScriptedDialog

this method makes the dialog reload itself from the XML stream

reload(InputStream) - Method in class simkin.examples.applet.ScriptedDialog

this method makes the dialog reload itself from the XML stream

removeChild(TreeNode) - Method in class simkin.TreeNode

This function removes the given node from the list of children

removeGlobalVariable(String) - Method in class simkin.Interpreter

Removes a global variable from the current list

removeInitialBlankLines(String) - Static method in class simkin.Utils

This method removes any initial blank lines from the given string.

removeNode(String) - Method in class simkin.TreeNodeObject

this method removes the first child node with the given label - it returns true if successfull

replaceInherits(Element) - Static method in class simkin.examples.inherits.InheritsElement

this method replaces any <inherits> tags with the equivalent XML file

reset() - Method in class simkin.XMLElementObjectEnumerator

This method resets the enumeration to the beginning - you can now iterate over the list again

reset() - Method in class simkin.TreeNodeObjectEnumerator

This method resets the enumeration to the beginning - you can now iterate over the list again

reset() - Method in class simkin.TreeNodeEnumerator

This method resets the enumeration to the beginning - you can now iterate over the list again

RETURN - Static variable in interface simkin.ParserConstants

RPAREN - Static variable in interface simkin.ParserConstants

run(String) - Method in class simkin.examples.dialog.ScriptedDialog

This method runs a command - because it is public it can be called from Simkin scripts

runtimeError(ExecutableContext, String) - Static method in class simkin.Interpreter

this method is called when there is a runtime error and throws a RuntimeException

S

save(OutputStream) - Method in class simkin.XMLExecutable

Call this method to save the state of the object back to a stream

save(OutputStream, boolean) - Method in class simkin.TreeNodeObject

saves the treenode into the given stream

save(Writer) - Method in class simkin.XMLExecutable

Call this method to save the state of the object back to a writer

sayHello() - Method in class simkin.examples.person.Person

This is a public method - it can be called from Simkin

ScriptedDialog - class simkin.examples.applet.ScriptedDialog.

This class shows how you can use Simkin to show dialogs described in an XML script

ScriptedDialog - class simkin.examples.dialog.ScriptedDialog.

This class shows how you can use Simkin to show dialogs described in script

ScriptedDialog(InputStream, Interpreter) - Constructor for class simkin.examples.applet.ScriptedDialog

ScriptedDialog(String) - Constructor for class simkin.examples.dialog.ScriptedDialog

ScriptedExecutable - class simkin.ScriptedExecutable.

This class is a base class for objects which store data and Simkin code in an associated TreeNode file

ScriptedExecutable() - Constructor for class simkin.ScriptedExecutable

Blank constructor

ScriptedExecutable(String) - Constructor for class simkin.ScriptedExecutable

this constructor reads in the treenode file named and stores it as an instance variable

ScriptLoader - class simkin.examples.scriptloader.ScriptLoader.

This Java program loads XML files containing Simkin script.

ScriptLoader() - Constructor for class simkin.examples.scriptloader.ScriptLoader

SEMICOLON - Static variable in interface simkin.ParserConstants

setAddIfNotPresent(boolean) - Method in class simkin.TreeNodeObject

sets the flag controlling whether new elements are created as they are accessed

setAddIfNotPresent(boolean) - Method in class simkin.XMLElementObject

sets the flag controlling whether new elements are created as they are accessed

setAttribute(String, String) - Method in class simkin.XMLElementObject

Sets an attribute on this node

setChild(TreeNode) - Method in class simkin.TreeNode

replaces the first child with a matching label with the contents of the given node.

setData(Element, String) - Static method in class simkin.XMLElementObject

sets the text data for a node by looking for the first CDATA and TEXT child node

setDebugStream(PrintStream) - Method in class simkin.ParserTokenManager

setElement(Element) - Method in class simkin.XMLElementObject

This method updates the associated element and clears the parse tree cache

setElement(Element) - Method in class simkin.examples.inherits.InheritsElement

extends this method to check for inherits tags after the element has been set

setFocus(String) - Method in class simkin.examples.applet.ScriptedDialog

This method sets the focus to a particular control - because it is public it can be called from Simkin scripts

setFocus(String) - Method in class simkin.examples.dialog.ScriptedDialog

This method sets the focus to a particular control - because it is public it can be called from Simkin scripts

setLineNum(int) - Method in class simkin.StackFrame

updates the line number for the frame

setLocation(String) - Method in class simkin.TreeNodeObject

This method changes the location associated with this object

setNode(TreeNode) - Method in class simkin.TreeNodeObject

sets the node and clears the method cache

setParentFrame(StackFrame) - Method in class simkin.StackFrame

sets the parent frame of this frame

setReflectionEnabled(boolean) - Method in class simkin.Interpreter

Sets the value of the reflection enabled flag.

setStatementStepper(StatementStepper) - Method in class simkin.Interpreter

this method sets an object to be called each time a statement is executed.

setTraceCallback(TraceCallback) - Method in class simkin.Interpreter

this method sets an object to receive trace messages.

setValue(String, String, Object, ExecutableContext) - Method in class simkin.TreeNodeObject

this method stores a value in the in-memory treenode object.

setValue(String, String, Object, ExecutableContext) - Method in class simkin.ExecutableRoot

This method calls the Interpreter's reflectiveSetValue method

setValue(String, String, Object, ExecutableContext) - Method in class simkin.Interpreter

Used to set the "tracing" variable - for example in Simkin:

setValue(String, String, Object, ExecutableContext) - Method in class simkin.XMLElementObject

sets the value of an item in the element.

setValue(String, String, Object, ExecutableContext) - Method in interface simkin.Executable

Called to set the value of a field.

setValueAt(Object, String, Object, ExecutableContext) - Method in class simkin.TreeNodeObject

this method stores a value in the in-memory treenode object.

setValueAt(Object, String, Object, ExecutableContext) - Method in class simkin.ExecutableRoot

This method does nothing at this level

setValueAt(Object, String, Object, ExecutableContext) - Method in class simkin.Interpreter

Does nothing - this is not a collection

setValueAt(Object, String, Object, ExecutableContext) - Method in class simkin.XMLElementObject

sets the value of an item in the element.

setValueAt(Object, String, Object, ExecutableContext) - Method in interface simkin.Executable

Called to set an object into this collection.

simkin - package simkin

This package contains the Simkin interpreter and base classes.

simkin.examples.applet - package simkin.examples.applet

This package contains an example of Simkin running within an applet, and providing a means of creating a dialog box.

simkin.examples.array - package simkin.examples.array

This package contains an example of a Simkin script using array index operators.

simkin.examples.dialog - package simkin.examples.dialog

This package contains an example of using a Simkin script to show a dialog box.

simkin.examples.dynamic_treenode - package simkin.examples.dynamic_treenode

This package contains a simple Java application which shows how to create a global TreeNode which scripts can add arbitrary data to.

simkin.examples.helloworld - package simkin.examples.helloworld

This package contains a "Hello World" example in Simkin.

simkin.examples.helloworld_midp - package simkin.examples.helloworld_midp

This package contains an example of MIDlet using Simkin

simkin.examples.inherits - package simkin.examples.inherits

This package shows how you can support inheritance of methods and member variables using Simkin.

simkin.examples.person - package simkin.examples.person

This package contains an example of a Simkin script calling into a Java class

simkin.examples.scriptloader - package simkin.examples.scriptloader

This package contains a simple Java application which loads and runs an XML file.

simkin.examples.servlet - package simkin.examples.servlet

This package contains an example of using Simkin within a servlet

SimkinServlet - class simkin.examples.servlet.SimkinServlet.

This example shows how Simkin can be used within a Java servlet The servlet executes Simkin script contained within a POST request, and returns the output of the script to the calling browser

SimkinServlet() - Constructor for class simkin.examples.servlet.SimkinServlet

SimkinXMLApplet - class simkin.examples.applet.SimkinXMLApplet.

SimkinXMLApplet() - Constructor for class simkin.examples.applet.SimkinXMLApplet

SimkinXMLElement - class simkin.SimkinXMLElement.

This class is used to create additional XML elements that are added to an XML document

SimkinXMLElement(String) - Constructor for class simkin.SimkinXMLElement

SLASH - Static variable in interface simkin.ParserConstants

specialConstructor - Variable in class simkin.ParseException

This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).

specialToken - Variable in class simkin.Token

This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.

StackFrame - class simkin.StackFrame.

This class stores information about the where the current script is executing.

StackFrame(String, Object, Hashtable, ExecutableContext) - Constructor for class simkin.StackFrame

Constructor

STAR - Static variable in interface simkin.ParserConstants

start() - Method in class simkin.examples.applet.SimkinXMLApplet

Called when the applet starts

startApp() - Method in class simkin.examples.helloworld_midp.HelloWorld

statementExecuted(StackFrame, int) - Method in interface simkin.StatementStepper

This method is called each time a statement is executed by the interpreter, just before the statement is performed

StatementStepper - interface simkin.StatementStepper.

This interface is implemented by objects which are called by the Interpreter when statements are executed

staticFlag - Static variable in class simkin.JavaCharStream

STEP - Static variable in interface simkin.ParserConstants

stop() - Method in class simkin.examples.applet.SimkinXMLApplet

Called when the applet is closed

STRING - Static variable in interface simkin.ParserConstants

SWITCH - Static variable in interface simkin.ParserConstants

SwitchTo(int) - Method in class simkin.ParserTokenManager

T

tagName() - Method in class simkin.XMLElementObject

this method returns the tag name of this object (taken from the code element)

TO - Static variable in interface simkin.ParserConstants

Token - class simkin.Token.

Describes the input token stream.

Token() - Constructor for class simkin.Token

tokenImage - Static variable in interface simkin.ParserConstants

tokenImage - Variable in class simkin.ParseException

This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.

TokenMgrError - error simkin.TokenMgrError.

TokenMgrError() - Constructor for class simkin.TokenMgrError

TokenMgrError(boolean, int, int, int, String, char, int) - Constructor for class simkin.TokenMgrError

TokenMgrError(String, int) - Constructor for class simkin.TokenMgrError

toString() - Method in class simkin.TreeNodeObject

toString() - Method in class simkin.Token

Returns the image.

toString() - Method in class simkin.Null

returns the string "null"

toString() - Method in class simkin.XMLElementObject

trace(Exception) - Method in class simkin.Interpreter

Sends the text of an exception to the tracer

trace(Exception) - Static method in class simkin.Tracer

This method dumps the given exception to stdout (if g_Tracing is true)

trace(Exception) - Method in interface simkin.TraceCallback

this method is called an exception is shown in the trace

trace(Exception) - Method in class simkin.examples.applet.SimkinXMLApplet

This is called to show an exception in the console

trace(Exception) - Method in class simkin.examples.helloworld_midp.HelloScreen

trace(String) - Method in class simkin.Interpreter

this method outputs a message to the trace - either the global class Tracer, or the current Trace callback

trace(String) - Static method in class simkin.Tracer

This method causes the given message to be printed to g_Out (if g_Tracing is true)

trace(String) - Method in interface simkin.TraceCallback

this method is called when a trace message is generated.

trace(String) - Method in class simkin.examples.applet.SimkinXMLApplet

This is called to show a trace message in the listbox

trace(String) - Method in class simkin.examples.helloworld_midp.HelloScreen

TraceCallback - interface simkin.TraceCallback.

This interface is implemented by objects which provide a tracing facility.

Tracer - class simkin.Tracer.

This class provides an interface to System.out.println

Tracer() - Constructor for class simkin.Tracer

TreeNode - class simkin.TreeNode.

This class encapsulates a single node in a tree

TreeNode() - Constructor for class simkin.TreeNode

default constructor - blank label, data and an empty list of children

TreeNode(String) - Constructor for class simkin.TreeNode

Constructor - passing a label

TreeNode(String, boolean) - Constructor for class simkin.TreeNode

Constructor - passing a label and data, which is converted to String

TreeNode(String, float) - Constructor for class simkin.TreeNode

Constructor - passing a label and data, which is converted to String

TreeNode(String, int) - Constructor for class simkin.TreeNode

Constructor - passing a label and data, which is converted to String

TreeNode(String, String) - Constructor for class simkin.TreeNode

Constructor - passing a label and data

TreeNodeEnumerator - class simkin.TreeNodeEnumerator.

This class enumerates the elements in a TreeNode

TreeNodeEnumerator(TreeNode) - Constructor for class simkin.TreeNodeEnumerator

Constructor - enumerates over every child node of this object

TreeNodeEnumerator(TreeNode, String) - Constructor for class simkin.TreeNodeEnumerator

Constructor - enumerates over children of this object with the matching tag

TreeNodeIterator - class simkin.TreeNodeIterator.

This class provides a means of iterating over the children of a TreeNode

TreeNodeIterator(TreeNode) - Constructor for class simkin.TreeNodeIterator

Constructor - is passed a TreeNode whose children will be iterated

TreeNodeObject - class simkin.TreeNodeObject.

This class provides and Executable interface to a TreeNode

TreeNodeObject() - Constructor for class simkin.TreeNodeObject

Default Constructor

TreeNodeObject(String, InputStream) - Constructor for class simkin.TreeNodeObject

Constructor

TreeNodeObject(String, TreeNode) - Constructor for class simkin.TreeNodeObject

Constructor

TreeNodeObjectEnumerator - class simkin.TreeNodeObjectEnumerator.

This class enumerates the elements in an TreeNodeObject

TreeNodeObjectEnumerator(TreeNodeObject) - Constructor for class simkin.TreeNodeObjectEnumerator

Constructor - enumerates over every child node of this object

TreeNodeObjectEnumerator(TreeNodeObject, String) - Constructor for class simkin.TreeNodeObjectEnumerator

Constructor - enumerates over children of this object with the matching tag

TreeNodeReader - class simkin.TreeNodeReader.

This class is a parser for TreeNode text and binary files

TreeNodeReader(InputStream) - Constructor for class simkin.TreeNodeReader

Constructor - is passed an input stream

TreeNodeReader(Reader) - Constructor for class simkin.TreeNodeReader

Constructor - is passed a reader

U

Utils - class simkin.Utils.

This class provides useful functions to the Simkin library

Utils() - Constructor for class simkin.Utils

W

WHILE - Static variable in interface simkin.ParserConstants

write(OutputStream, boolean, boolean) - Method in class simkin.TreeNode

This method writes the current node out to an output stream.

write(Writer, boolean) - Method in class simkin.TreeNode

This method writes the current node out to a writer

X

XMLElementObject - class simkin.XMLElementObject.

This object is a container for an XML element, and exposes an interface to it to Simkin The class implements methods from the Executable interface.

XMLElementObject() - Constructor for class simkin.XMLElementObject

Default Constructor

XMLElementObject(String, Element) - Constructor for class simkin.XMLElementObject

Constructor which takes an Element

XMLElementObjectEnumerator - class simkin.XMLElementObjectEnumerator.

This class enumerates the elements in an XMLElementObject

XMLElementObjectEnumerator(XMLElementObject) - Constructor for class simkin.XMLElementObjectEnumerator

Constructor - enumerates over every child node of this object

XMLElementObjectEnumerator(XMLElementObject, String) - Constructor for class simkin.XMLElementObjectEnumerator

Constructor - enumerates over children of this object with the matching tag

XMLExecutable - class simkin.XMLExecutable.

This class is a base class for objects which store their data and methods in an XML document

XMLExecutable() - Constructor for class simkin.XMLExecutable

Default Constructor.

XMLExecutable(String, InputStream) - Constructor for class simkin.XMLExecutable

Constructor taking an input stream containing an XML document

XMLExecutable(String, Reader) - Constructor for class simkin.XMLExecutable

Constructor taking a reader containing an XML document

A B C D E F G H I J K L M N O P R S T U W X