CommonAstSupport.Library (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.pattern.CommonAstSupport.Library

Enclosing class:

CommonAstSupport
```
public class CommonAstSupport.Library
extends java.lang.Object
```
Implementation of basic symbol resolution and comparison-type user function services specific to AST processing. By convention, these functions are typically used in the conditional expression of a rule, though they are not limited to this use.
Implementation of common, AST related actions, such as persistence, AST node addition and removal, string and basic output services, adding nodes to the results view, etc.
Implementation of services to put, get, and remove annotations to/from ASTs.

Constructor Summary

Constructors
Constructor and Description

Library()

Constructors
Constructor and Description
`Library()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`absolutePath(java.lang.String path)` Compares the current source AST's path from the root with the specified path.
`boolean`	`addAllToView(java.util.List<Aast> list)` Add the current copy AST to the filtered view of ASTs which can be pipelined to the next ruleset.
`boolean`	`addAncestorToView(long level)` Add a specified ancestor of the current copy AST to the filtered view of ASTs which can be pipelined to the next ruleset, if the all nodes in the ancestry chain (up to and including the specified level) are not `null`.
`void`	`addNewProgramFile(Aast root)` Add the given AST as a new program file, by registering its filename.
`boolean`	`addParentToView()` Add the parent of the current copy AST to the filtered view of ASTs which can be pipelined to the next ruleset, if the parent node is not `null`.
`boolean`	`addPathToViewFrom(long type)` Add to the filtered view of ASTs all of the nodes which form the path from an ancestor node of type `type` to the current copy AST.
`boolean`	`addToView()` Add the current copy AST to the filtered view of ASTs which can be pipelined to the next ruleset.
`boolean`	`addToView(java.lang.Long id)` Add the AST specified by the passed ID to the filtered view of ASTs which can be pipelined to the next ruleset.
`boolean`	`addTreeToView(long maxLevels)` Add the current copy AST, and all of its descendants through `maxLevels` generations, to the filtered view of ASTs which can be pipelined to the next ruleset.
`boolean`	`ancestor(long type, long maxLevels)` Implementation of the `ancestor` user function.
`boolean`	`breakpoint(java.lang.String location, boolean suspend, java.lang.Object... args)` Logs a list of `Object`s in `ERR` console with a (usually short) description.
`java.lang.String`	`charAt(java.lang.String text, int index)` Get the character at the specified index, as a string.
`boolean`	`childAt(long type, long index)` Compares the current source AST's immediate descendant (direct child) at a specific 0-based index for a match with a specific token type.
`java.lang.Class`	`classForName(java.lang.String name)` Get the class with the given name.
`java.lang.Class`	`classForName(java.lang.String name, boolean noThrow)` Get the class with the given name.
`void`	`clearNewProgramFiles()` Clear the list of newly, generated, `program file names`.
`boolean`	`closeStream(java.lang.Long id)` Closes a stream that was previously opened and which was associated with a specific ID.
`boolean`	`compareNodes(Aast node1, Aast node2)` Check if two nodes are equivalent (if they represent the same expression so they will probably generate the same code.
`void`	`compileError(int id, java.lang.String message)` Throws a `CompileException` with a user-defined message.
`void`	`compileError(int id, java.lang.String message, Aast ast)` Throws a `CompileException` with a user-defined message.
`java.lang.String`	`copies(java.lang.String text, int num)` Returns a string that is comprised of the input string concatenated `num` times without intervening spaces.
`java.lang.Object`	`create(java.lang.Class<?> target, java.lang.Object[] args)` Create a new instance of the specified class, passing the provided arguments to its constructor.
`java.lang.Object`	`create(java.lang.String className, java.lang.Object[] args)` Create a new instance of the specified class, passing the provided arguments to its constructor.
`java.util.List<?>`	`createList(java.lang.Object[] elements)` Create a new `List` which contains the specified elements as its members.
`java.util.List<?>`	`createListFromObject(java.lang.Object array)` Generate a list from an array of objects.
`<K,V> java.util.LinkedHashMap<K,V>`	`createMap(java.util.Set<K> keys, java.util.List<V> values)` Create a linked hash map whose keys are defined by `keys` and whose values are defined by `values`.
`java.util.Map<?,?>`	`createMapAstKeyToAst(java.lang.String name)` Create a db-backed map, with a `AstKey` key and `Aast` values.
`java.util.Map<?,?>`	`createMapAstKeyToInt(java.lang.String name)` Create a db-backed map, with a `AstKey` key and `Integer` values.
`java.util.Map<?,?>`	`createMapAstKeyToString(java.lang.String name)` Create a db-backed map, with a `AstKey` key and `String` values.
`java.util.Map<?,?>`	`createMapFrameAstKeyToString(java.lang.String name)` Create a db-backed map, with a `FrameAstKey` key and `String` values.
`java.util.LinkedHashSet<?>`	`createSet(java.lang.Object[] elements)` Create a linked hash set containing the specified elements.
`java.util.Map<?,?>`	`createString2IntMap(java.lang.String name)` Create a db-backed map, with a `String` key and an `Integer` value.
`java.util.Map<?,?>`	`createString2LongMap(java.lang.String name)` Create a db-backed map, with a `String` key and a `Long` value.
`java.util.Map<?,?>`	`createString2StringMap(java.lang.String name)` Create a db-backed map, with a `String` key and a `String` value.
`java.util.Map<?,?>`	`createStringMapToLongSet(java.lang.String name)` Create a db-backed map, with a `String` key and as values another set, having `Long` for key.
`java.util.Map<?,?>`	`createStringMapToStringMap(java.lang.String name)` Create a db-backed map, with a `String` key and as values another map, having `String` for both key and value.
`java.util.Map<?,?>`	`createStringMapToStringSet(java.lang.String name)` Create a db-backed map, with a `String` key and as values another set, having `String` for key.
`java.util.Set<?>`	`createStringSet(java.lang.String name)` Create a db-backed set, with a `String` key.
`java.util.UUID`	`createUUID(long high, long low)` Creates new UUID instance from the supplied data.
`boolean`	`declaresMember(java.lang.Class cls, java.lang.String name)` Tests whether the specified class declares member of the supplied name.
`boolean`	`descendant(long type, long maxLevels)` Implementation of the `descendant` user function.
`boolean`	`downPath(java.lang.String path)` Determines if the current source AST's path downward matches the specified path, on a case-insensitive basis.
`boolean`	`dumpStack()` Debug method to print a stack trace dump to `stderr`.
`void`	`endCurrentWalk()` End the current AST walk.
`java.lang.Boolean`	`eval(java.lang.String expr)` Implementation of the `eval` user function.
`java.lang.Boolean`	`evalLib(java.lang.String name, java.lang.Object[] args)` Implementation of the `evalLib` user function.
`java.lang.Object`	`exec(java.lang.String expr)` Implementation of the `exec` user function.
`java.lang.Object`	`execLib(java.lang.String name, java.lang.Object[] args)` Implementation of the `execLib` user function.
`java.lang.String`	`fixupFileName(java.lang.String text)` Fixing the file name for special Windows requirement.
`java.lang.String`	`fixupRegex(java.lang.String text)` Fixing the regular expression string for special Windows requirement.
`void`	`forceMapValue(java.util.Map<?,?> map, java.lang.Object key, java.lang.Object value)` For the given db-backed map (if not in runtime conversion mode), force a logged change with the given key and value, for the currently processed AST.
`boolean`	`fprintf(java.lang.Long id, java.lang.String format, java.lang.Object[] args)` Given a format string using C-like `printf` syntax, and an array of runtime replacement arguments, perform formatted variable substitution and APPEND the resulting string to previously opened stream identified by a numeric ID.
`boolean`	`fprintf(java.lang.String filename, java.lang.String format, java.lang.Object[] args)` Given a format string using C-like `printf` syntax, and an array of runtime replacement arguments, perform formatted variable substitution and APPEND the resulting string to a named file.
`java.util.Set<java.lang.String>`	`getAllClassesInPackage(java.lang.String pkg)` Get the simple java class names for all classes in this package (builtin or converted code).
`Aast`	`getAnalog()` Get the AST node which is located in the copy tree at the analogous index position as the current source AST, with respect to their respective parents.
`Aast`	`getAncestor(java.lang.Integer index, java.lang.String key, java.lang.Object value, java.lang.Object[] types)` Return the first ancestor node with the specified annotation, optionally refining the match by annotation value and/or token type.
`Aast`	`getAncestor(java.lang.String key, java.lang.Object value, java.lang.Object[] types)` Return the first ancestor node with the specified annotation, optionally refining the match by annotation value and/or token type.
`java.lang.Boolean`	`getAncestorNoteBoolean(long level, java.lang.String key)` Gets a `Boolean` annotation from the specified ancestor in the copy AST.
`java.lang.Boolean`	`getAncestorNoteBoolean(long level, java.lang.String key, java.lang.Boolean defaultValue)` Gets a `Boolean` annotation from the specified ancestor in the copy AST.
`java.lang.Boolean`	`getAncestorNoteBoolean(long level, java.lang.String key, long index)` Gets a `Boolean` annotation at a specific index from an array annotation in the specified ancestor of the current copy AST.
`java.lang.Double`	`getAncestorNoteDouble(long level, java.lang.String key)` Gets a `Double` annotation from the specified ancestor in the copy AST.
`java.lang.Double`	`getAncestorNoteDouble(long level, java.lang.String key, long index)` Gets a `Double` annotation at a specific index from an array annotation in the specified ancestor of the current copy AST.
`java.lang.Long`	`getAncestorNoteLong(long level, java.lang.String key)` Gets a `Long` annotation from the specified ancestor in the copy AST.
`java.lang.Long`	`getAncestorNoteLong(long level, java.lang.String key, long index)` Gets a `Long` annotation at a specific index from an array annotation in the specified ancestor of the current copy AST.
`java.lang.String`	`getAncestorNoteString(long level, java.lang.String key)` Gets a `String` annotation from the specified ancestor in the copy AST.
`java.lang.String`	`getAncestorNoteString(long level, java.lang.String key, long index)` Gets a `String` annotation at a specific index from an array annotation in the specified ancestor of the current copy AST.
`Aast`	`getAncestorOfType(java.lang.Object[] types)` Return the first ancestor node which matches one of the specified token types.
`java.lang.String`	`getAncestorTreeDump(long level)` Accesses the text representation (human readable 'parser output') of the tree rooted at the specified ancestor AST node, if such a node exists.
`Aast`	`getAst(java.lang.Long id)` Returns an AST instance referenced by its ID if it is loaded (and registered) in the current resolver.
`Aast`	`getAst(java.lang.Long id, boolean loadTree)` Returns an AST instance referenced by its ID.
`long`	`getChildIndex()` Returns the 0-based child index of the current AST.
`java.lang.String`	`getClassSimpleName(java.lang.String className)` Returns the simple class name of the supplied (fully qualified) class name.
`long`	`getColumn()` Get the column number in the source code file at which the current source AST was found.
`java.lang.String`	`getConfigParameter(java.lang.String id)` Retrieve value of specified configuration variable.
`java.lang.Boolean`	`getConfigParameter(java.lang.String id, boolean def)` Retrieve value of specified configuration variable.
`java.lang.String`	`getConfigParameter(java.lang.String id, java.lang.String def)` Retrieve value of specified configuration variable.
`java.lang.String`	`getConvertedSimpleClassName(java.lang.String qname)` Get the converted simple class name for the specified fully-qualified 4GL class name.
`Aast`	`getCopy()` Get the instance of the copy AST currently set in the resolver.
`long`	`getDepth()` Get the number of generations away from the root AST node this AST is located (in the source AST).
`java.lang.String`	`getFile()` Get the name of the source code file associated with the current source AST.
`int`	`getGapMarking(java.lang.String classname)` Get the gap marking for the specified Java class, implementing a legacy OE class.
`int`	`getGapMarking(java.lang.String classname, java.lang.String method, java.lang.String signature)` Get the gap marking for the specified method in the given Java class, implementing a legacy OE method.
`java.lang.Long`	`getId()` Get the project-unique AST node ID of the current, source AST.
`long`	`getLeftSiblings()` Returns the number of siblings to the current AST's left.
`java.lang.String`	`getLegacyName(java.lang.Class<?> cls, java.lang.String methodName)` Returns the legacy name of the supplied method on the supplied class.
`long`	`getLine()` Get the line number in the source code file at which the current source AST was found.
`java.lang.reflect.Method`	`getMethod(java.lang.Class cls, java.lang.String name, java.lang.Object[] paramTypes)` Resolve a reflective method, given a class, method name, and parameter signature.
`java.lang.String`	`getMethodNoCase(java.lang.Class cls, java.lang.String insensitiveName)` Tests whether the specified class has tge method of the supplied name.
`java.lang.Class`	`getMethodParamType(java.lang.Class cls, java.lang.String methodName, int requiredParamNum, int paramIdx, java.lang.Class expectedParamType)` Returns method parameter type on the specified index.
`java.lang.String`	`getName()` Get the token name of the current, source AST.
`int`	`getNextChildIndex()` Implementation of the `nextChildIndex` user variable which denotes which child is about to be processed when processing a 'next-child' rule.
`java.lang.Boolean`	`getNoteBoolean(java.lang.String key)` Gets a `Boolean` annotation from the current, copy AST.
`java.lang.Boolean`	`getNoteBoolean(java.lang.String key, long index)` Gets a `Boolean` annotation at a specific index from an array annotation in the current copy AST.
`java.lang.Double`	`getNoteDouble(java.lang.String key)` Gets a `Double` annotation from the current, copy AST.
`java.lang.Double`	`getNoteDouble(java.lang.String key, long index)` Gets a `Double` annotation at a specific index from an array annotation in the current copy AST.
`java.lang.Long`	`getNoteLong(java.lang.String key)` Gets a `Long` annotation from the current, copy AST.
`java.lang.Long`	`getNoteLong(java.lang.String key, long index)` Gets a `Long` annotation at a specific index from an array annotation in the current copy AST.
`long`	`getNoteSize(java.lang.String key)` Returns the size of an array annotation as indexed by an arbitrary key.
`java.lang.String`	`getNoteString(java.lang.String key)` Gets a `String` annotation from the current, copy AST.
`java.lang.String`	`getNoteString(java.lang.String key, long index)` Gets a `String` annotation at a specific index from an array annotation in the current copy AST.
`java.lang.String`	`getNoteType(java.lang.String key)` Determines the type of an annotation (if it exists) as indexed by an arbitrary key.
`long`	`getNow()` Get the current system time in milliseconds since the epoch.
`long`	`getNumBytesWritten(java.lang.Long id)` Returns the number of bytes written to this stream since it was opened.
`long`	`getNumImmediateChildren()` Implementation of the `numImmediateChildren` user variable.
`Aast`	`getParent()` Get the current, source AST's parent, if any.
`java.lang.String`	`getPath()` Accesses the full path from the current source AST to the root.
`java.lang.String`	`getPersistenceFilename()` Returns the project relative filename of the copy AST persistence file, using the default persistence naming convention.
`java.lang.Boolean`	`getReferenceNoteBoolean(long id, java.lang.String key)` Gets a `Boolean` annotation from the referenced node in the copy AST.
`java.lang.Boolean`	`getReferenceNoteBoolean(long id, java.lang.String key, long index)` Gets a `Boolean` annotation at a specific index from an array annotation in the referenced node of the current copy AST.
`java.lang.Double`	`getReferenceNoteDouble(long id, java.lang.String key)` Gets a `Double` annotation from the referenced node in the copy AST.
`java.lang.Double`	`getReferenceNoteDouble(long id, java.lang.String key, long index)` Gets a `Double` annotation at a specific index from an array annotation in the referenced node of the current copy AST.
`java.lang.Long`	`getReferenceNoteLong(long id, java.lang.String key)` Gets a `Long` annotation from the referenced node in the copy AST.
`java.lang.Long`	`getReferenceNoteLong(long id, java.lang.String key, long index)` Gets a `Long` annotation at a specific index from an array annotation in the referenced node of the current copy AST.
`java.lang.String`	`getReferenceNoteString(long id, java.lang.String key)` Gets a `String` annotation from the referenced node in the copy AST.
`java.lang.String`	`getReferenceNoteString(long id, java.lang.String key, long index)` Gets a `String` annotation at a specific index from an array annotation in the referenced node of the current copy AST.
`java.lang.Class`	`getResourceType(java.lang.Class clazz, java.lang.String method)` Returns the resource type declared by the supplied method.
`long`	`getRightSiblings()` Returns the number of siblings to the current AST's right.
`java.lang.Object`	`getStoredObject(java.lang.String id)` Get the object stored by the pattern engine under the given id.
`java.lang.Object`	`getStoredObject(java.lang.String category, java.lang.String id)` Get the object stored by the pattern engine under the given category and id.
`java.lang.String`	`getText()` Get the token text of the current source AST.
`Aast`	`getThis()` Get the instance of the source AST currently set in the resolver.
`java.lang.String`	`getTreeDump()` Accesses the text representation (human readable 'parser output') of the tree rooted at the current AST node.
`int`	`getType()` Get the token type of the current, source AST.
`boolean`	`imaginary()` Implementation of the `imaginary` user function.
`long`	`indexOf(java.lang.String text, java.lang.String find)` Returns the 0-based index of the first character that matches the find string in the input string or -1 if no match was found.
`long`	`indexOf(java.lang.String text, java.lang.String find, long start)` Returns the 0-based index of the first character that matches the find string after the starting point in the input string or -1 if no match was found.
`java.lang.Object`	`invoke(java.lang.reflect.Method method, java.lang.Object target, java.lang.Object[] args)` Helper function to invoke an arbitrary method through reflection.
`boolean`	`isAst(java.lang.String filename)` Determines if the given file is a valid AST.
`boolean`	`isConditionalRuleSets()` Check if conditional rule-sets is activated.
`boolean`	`isDenormalizeDynamicTempTables()` Check whether the extent properties in dynamic temp-tables should be denormalized.
`boolean`	`isFlagActivated(java.lang.String flag)` If conditional rule-set is enabled, check if the given flag is activated.
`boolean`	`isNote(java.lang.String key)` Determines if an annotation exists of any `String`, `Double`, `Long`, or `Boolean` value, indexed by an arbitrary key.
`boolean`	`isRuntimeConfig()` Determines whether the `Configuration` is in conversion mode (configuration is read from the configuration directory) or server run time mode.
`boolean`	`isRuntimeQueryMode()` Check if the current mode is for runtime-conversion of query/tables.
`long`	`lastIndexOf(java.lang.String text, java.lang.String find)` Returns the 0-based index of the first character of the last match to the find string in the input string or -1 if no match was found.
`long`	`lastIndexOf(java.lang.String text, java.lang.String find, long start)` Returns the 0-based index of the first character of the last match of the find string before the starting point in the input string or -1 if no match was found.
`boolean`	`leaf()` Implementation of the `leaf` user function.
`ClassDefinition`	`loadClassDefinition(java.lang.String clsName)` Get the parser's `ClassDefinition` for a given qualified class name, in legacy form.
`ConvertedClassName`	`loadConvertedClass(java.lang.String filename, boolean isNew, Aast ast)` Load the specified converted class.
`ConvertedClassName`	`loadConvertedClassByQname(java.lang.String qname)` Load the specified converted class.
`Aast`	`loadTree(java.lang.String filename)` Load the AST stored in the given file.
`java.lang.String`	`lower(java.lang.String text)` Lowercase and return the given string.
`boolean`	`matches(java.lang.String text, java.lang.String regex)` Determine whether `text` matches the specified regular expression.
`boolean`	`matches(java.lang.String text, java.lang.String regex, boolean sensitive)` Determine whether `text` matches the specified regular expression, taking the caller's case-sensitivity into account.
`private boolean`	`matchTokenType(Aast node, java.lang.Object[] types)` Determine whether the token type of the specified node matches any of the given types.
`int`	`nextSequenceValue(java.lang.String name)` Get the next value for the given sequence.
`datetimetz`	`now()` Get the NOW value.
`java.lang.Long`	`openStoredStream(java.lang.String name)` Opens a new in-memory stream for writing, associates an unique ID with that stream and stores it (can be retrieved later using `PatternEngine.getStoredObject(String)`).
`java.lang.Long`	`openStream(java.lang.String filename, boolean projectRelative)` Opens a new stream for writing and associates a unique ID with that stream.
`java.math.BigDecimal`	`parseBigDecimal(java.lang.String text)` Parse a `BigDecimal` from `text` and return it.
`datetime`	`parseDatetimeLiteral(java.lang.String text)` Parse the ISO8601 text as a datetime literal.
`datetimetz`	`parseDatetimetzLiteral(java.lang.String text)` Parse the ISO8601 text as a datetimetz literal.
`java.lang.Double`	`parseDouble(java.lang.String text)` Parse a `Double` from `text` and return it.
`java.lang.Double`	`parseDoubleQuiet(java.lang.String text)` Parse a `Double` from `text` and return it.
`java.lang.Long`	`parseLong(java.lang.String text)` Parse a `Long` from `text` and return it.
`java.lang.Long`	`parseLong(java.lang.String text, int radix)` Parse a `Long` from `text` using the given radix, and return it.
`java.lang.Long`	`parseLongQuiet(java.lang.String text)` Parse a `Long` from `text` and return it.
`java.lang.Long`	`parseLongQuiet(java.lang.String text, int radix)` Parse a `Long` from `text` using the given radix, and return it.
`Aast`	`parseTree(java.lang.String filename)` Load the AST stored in the given file and return it.
`boolean`	`persist()` Persist the copy AST to file, using the default persistence naming convention.
`boolean`	`persist(Aast root, java.lang.String filename, boolean projectRelative, boolean terse)` Persist the specified AST to file, using the default persistence naming convention.
`boolean`	`persist(java.lang.String filename, boolean projectRelative)` Persist the copy AST to file, using the default persistence naming convention.
`boolean`	`persist(java.lang.String filename, boolean projectRelative, boolean terse)` Persist the copy AST to file, using the default persistence naming convention.
`boolean`	`print(java.lang.String text)` Debug user function implementation to print text to stdout.
`boolean`	`printAst()` Prints a string representation of the current source AST to stdout, indented appropriately to indicate its depth in the AST structure.
`boolean`	`printf(java.lang.String format, java.lang.Object[] args)` Prints a string formatted by `sprintf(java.lang.String, java.lang.Object[])` to `stdout` with no trailing line break.
`boolean`	`printfln(java.lang.String format, java.lang.Object[] args)` Prints a string formatted by `sprintf(java.lang.String, java.lang.Object[])` to `stdout` with a trailing line break.
`boolean`	`println(java.lang.String text)` Debug user function implementation to print text to stdout, followed by a line break.
`boolean`	`putAncestorNote(long level, java.lang.String key, java.lang.Boolean value)` Store an annotation of type `Boolean` in the specified ancestor in the copy AST.
`boolean`	`putAncestorNote(long level, java.lang.String key, java.lang.Boolean value, long index)` Store an element in an array annotation of type `Boolean` at the specified index in the specified ancestor in the copy AST.
`boolean`	`putAncestorNote(long level, java.lang.String key, java.lang.Double value)` Store an annotation of type `Double` in the specified ancestor in the copy AST.
`boolean`	`putAncestorNote(long level, java.lang.String key, java.lang.Double value, long index)` Store an element in an array annotation of type `Double` at the specified index in the specified ancestor in the copy AST.
`boolean`	`putAncestorNote(long level, java.lang.String key, java.lang.Long value)` Store an annotation of type `Long` in the specified ancestor in the copy AST.
`boolean`	`putAncestorNote(long level, java.lang.String key, java.lang.Long value, long index)` Store an element in an array annotation of type `Long` at the specified index in the specified ancestor in the copy AST.
`boolean`	`putAncestorNote(long level, java.lang.String key, java.lang.String value)` Store an annotation of type `String` in the specified ancestor in the copy AST.
`boolean`	`putAncestorNote(long level, java.lang.String key, java.lang.String value, long index)` Store an element in an array annotation of type `String` at the specified index in the specified ancestor in the copy AST.
`boolean`	`putNote(java.lang.String key, java.lang.Boolean value)` Store an annotation of type `Boolean` in the current copy AST.
`boolean`	`putNote(java.lang.String key, java.lang.Boolean value, long index)` Store an annotation of type `Boolean` at the specified index in an array annotation in the current copy AST.
`boolean`	`putNote(java.lang.String key, java.lang.Double value)` Store an annotation of type `Double` in the current copy AST.
`boolean`	`putNote(java.lang.String key, java.lang.Double value, long index)` Store an annotation of type `Double` at the specified index in an array annotation in the current copy AST.
`boolean`	`putNote(java.lang.String key, java.lang.Long value)` Store an annotation of type `Long` in the current copy AST.
`boolean`	`putNote(java.lang.String key, java.lang.Long value, long index)` Store an annotation of type `Long` at the specified index in an array annotation in the current copy AST.
`boolean`	`putNote(java.lang.String key, java.lang.String value)` Store an annotation of type `String` in the current copy AST.
`boolean`	`putNote(java.lang.String key, java.lang.String value, long index)` Store an annotation of type `String` at the specified index in an array annotation in the current copy AST.
`boolean`	`putReferenceNote(long id, java.lang.String key, java.lang.Boolean value)` Store an annotation of type `Boolean` in the referenced node in the copy AST.
`boolean`	`putReferenceNote(long id, java.lang.String key, java.lang.Boolean value, long index)` Store an element in an array annotation of type `Boolean` at the specified index in the referenced node in the copy AST.
`boolean`	`putReferenceNote(long id, java.lang.String key, java.lang.Double value)` Store an annotation of type `Double` in the referenced node in the copy AST.
`boolean`	`putReferenceNote(long id, java.lang.String key, java.lang.Double value, long index)` Store an element in an array annotation of type `Double` at the specified index in the referenced node in the copy AST.
`boolean`	`putReferenceNote(long id, java.lang.String key, java.lang.Long value)` Store an annotation of type `Long` in the referenced node in the copy AST.
`boolean`	`putReferenceNote(long id, java.lang.String key, java.lang.Long value, long index)` Store an element in an array annotation of type `Long` at the specified index in the referenced node in the copy AST.
`boolean`	`putReferenceNote(long id, java.lang.String key, java.lang.String value)` Store an annotation of type `String` in the referenced node in the copy AST.
`boolean`	`putReferenceNote(long id, java.lang.String key, java.lang.String value, long index)` Store an element in an array annotation of type `String` at the specified index in the referenced node in the copy AST.
`java.lang.String`	`quoteReplacement(java.lang.String text)` Calling the java.util.regex.Matcher.quoteReplacement().
`void`	`registerTree(Aast ast)` Register the given AST and all its descendants with the AST resolver.
`boolean`	`relativePath(java.lang.String path)` Determines if the current source AST's path from the root ends with the specified path, on a case-insensitive basis.
`boolean`	`remove()` Removes the current AST node from the copy AST.
`boolean`	`removeAncestorNote(long level, java.lang.String key)` Remove an annotation from the specified ancestor in the copy AST.
`boolean`	`removeAncestorNote(long level, java.lang.String key, long index)` Remove an element (at the specified index) of an array annotation from an annotation specified by the key in the specified ancestor of the current copy AST.
`void`	`removeAst(java.lang.Long id)` Remove the entire tree enclosing the specified AST from the resolver.
`boolean`	`removeNote(java.lang.String key)` Remove an annotation from the current copy AST.
`boolean`	`removeNote(java.lang.String key, long index)` Remove an element (at the specified index) of an array annotation from an annotation specified by the key in the current copy AST.
`java.lang.String`	`removeQuotes(java.lang.String text)` Strip enclosing double or single quotes, if any, plus any options, from the given string.
`boolean`	`removeReferenceNote(long id, java.lang.String key)` Remove an annotation from the referenced node in the copy AST.
`boolean`	`removeReferenceNote(long id, java.lang.String key, long index)` Remove an element (at the specified index) of an array annotation from an annotation referenced by the key in the referenced node of the current copy AST.
`boolean`	`returnsHandle(java.lang.Class clazz, java.lang.String method)` Returns `true` if the supplied method declares `handle` as its return type.
`boolean`	`root()` Implementation of the `root` user function.
`void`	`saveClasses()` Save all the 4GL classes (builtin or business logic), .NET or Java classes encountered during parsing.
`void`	`setConvertedClassName(java.lang.String filename, java.lang.String legacyName, java.lang.String pkgname, java.lang.String classname)` For a given legacy class, set its converted Java name and package.
`boolean`	`setText(java.lang.String text)` Set the token text of the current copy AST.
`boolean`	`setType(long type)` Set the token type of the current, copy AST.
`boolean`	`sibling(long type)` Test whether any of the current AST's siblings matches the given token type.
`java.util.List<?>`	`splitToList(java.lang.String val, java.lang.String delim)` Split the given value into a list of `String`'s, using the given delimiter.
`java.lang.String`	`sprintf(java.lang.String format, java.lang.Object[] args)` Given a format string using C-like `printf` syntax, and an array of runtime replacement arguments, perform formatted variable substitution and return the resulting string.
`void`	`storeObject(java.lang.String id, java.lang.Object object)` Store the given object under the given id.
`void`	`storeObject(java.lang.String category, java.lang.String id, java.lang.Object object)` Store the given object under the given category and id.
`java.lang.String`	`string(boolean value)` Convert a boolean value to its default string representation.
`java.lang.String`	`string(double value)` Convert a numeric value to its default string representation.
`java.lang.String`	`string(long value)` Convert a numeric value to its default string representation.
`long`	`stringLength(java.lang.String text)` Returns the length in characters of the given string.
`java.lang.String`	`substring(java.lang.String text, long index)` Returns the portion of the input string from the 0-based index to the end.
`java.lang.String`	`substring(java.lang.String text, long begin, long end)` Returns the portion of the input string from the 0-based index to the end.
`java.lang.String`	`switchQuotes(java.lang.String text, java.lang.String prevQuoteChar, java.lang.String newQuoteChar)` Prepare the given text so that its quotes can be switched from the previous quote to the new quotes.
`void`	`throwException(java.lang.String message)` Throws a `CommonAstSupport.UserGeneratedException` with a user-defined message.
`void`	`throwException(java.lang.String message, Aast ast)` Throws a `CommonAstSupport.UserGeneratedException` with a user-defined message.
`java.math.BigDecimal`	`toBigDecimal(java.lang.Double num)` Convert a `double` value to a `BigDecimal`.
`date`	`today()` Get the TODAY value.
`java.lang.String`	`trimLeading(java.lang.String text)` Trim leading whitespace from `text`, without triggering a `NullPointerException` if `text` is `null`.
`java.lang.String`	`trimTrailing(java.lang.String text)` Trim trailing whitespace (space, tab, CR and LF) from `text`, without triggering a `NullPointerException` if `text` is `null`.
`java.lang.String`	`trimTrailingSpaces(java.lang.String text)` Trim only trailing spaces from `text`, without triggering a `NullPointerException` if `text` is `null`.
`boolean`	`upPath(java.lang.String path)` Determines if the current source AST's path upward matches the specified path, on a case-insensitive basis.
`java.lang.String`	`upper(java.lang.String text)` Uppercase and return the given string.
`void`	`withServicesFile(java.lang.String filename)` Mark this file 'with_services'.
`java.util.List`	`wrapText(java.lang.String text, int width)` Wrap a text string to fit into one or more lines of the specified width.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Library
```
public Library()
```
- Method Detail
  - getGapMarking
```
public int getGapMarking(java.lang.String classname)
```
    Get the gap marking for the specified Java class, implementing a legacy OE class.
    The gap is read from the LegacyResourceSupport annotation.
    
    Parameters:
    
    classname - The fully-qualified Java class name.
    
    Returns:
    
    The conversion and runtime support.
  - getGapMarking
```
public int getGapMarking(java.lang.String classname,
                         java.lang.String method,
                         java.lang.String signature)
```
    Get the gap marking for the specified method in the given Java class, implementing a legacy OE method.
    The gap is read from the LegacyResourceSupport annotation.
    
    Parameters:
    
    classname - The fully-qualified Java class name.
    
    method - The Java method name.
    
    signature - The legacy signature for the OE method. This must match with the Java method's LegacySignature.
    
    Returns:
    
    The conversion and runtime support.
  - loadConvertedClass
```
public ConvertedClassName loadConvertedClass(java.lang.String filename,
                                             boolean isNew,
                                             Aast ast)
                                      throws java.lang.ClassNotFoundException
```
    Load the specified converted class. This will either create a ClassDefinition structure for a new class (to be later populated with members by the parser), or will restore an instance from an already-converted class.
    
    Parameters:
    
    filename - The file name for the legacy OO class.
    
    isNew - Flag indicating that this is a new class (now being parsed), or a previously converted class.
    
    ast - The abstract syntax tree node.
    
    Returns:
    
    See above.
    
    Throws:
    
    java.lang.ClassNotFoundException - If the class can't be resolved or loaded.
  - loadConvertedClassByQname
```
public ConvertedClassName loadConvertedClassByQname(java.lang.String qname)
                                             throws java.lang.ClassNotFoundException
```
    Load the specified converted class. This lookup an instance from an already-converted class.
    
    Parameters:
    
    qname - The legacy OO class qualified name.
    
    Returns:
    
    The found converted class.
    
    Throws:
    
    java.lang.ClassNotFoundException - If the class can't be resolved or loaded.
  - loadClassDefinition
```
public ClassDefinition loadClassDefinition(java.lang.String clsName)
```
    Get the parser's ClassDefinition for a given qualified class name, in legacy form.
    
    Parameters:
    
    clsName - The qualified legacy class name.
    
    Returns:
    
    The ClassDefinition instance, or null if it does not exist.
  - endCurrentWalk
```
public void endCurrentWalk()
```
    End the current AST walk. This can be called at any time within any rules section. No further nodes in the current AST will be visited; however, any remaining rules and/or actions for the current node will still be processed. The pattern engine will continue processing with the next AST root node in its list, or complete its run if no further AST roots exist.
    
    See Also:
    
    AstSymbolResolver.setEndWalk(boolean)
  - classForName
```
public java.lang.Class classForName(java.lang.String name)
                             throws java.lang.ClassNotFoundException
```
    Get the class with the given name. For primitives, return the class which represents that type via the wrapper's TYPE member.
    
    Parameters:
    
    name - Name of a class, or the type name of a primitive.
    
    Returns:
    
    Class associated with the given name.
    
    Throws:
    
    java.lang.ClassNotFoundException - if no class is found for name.
  - classForName
```
public java.lang.Class classForName(java.lang.String name,
                                    boolean noThrow)
                             throws java.lang.ClassNotFoundException
```
    Get the class with the given name. For primitives, return the class which represents that type via the wrapper's TYPE member.
    
    Parameters:
    
    name - Name of a class, or the type name of a primitive.
    
    noThrow - Set to true to never throw any exception.
    
    Returns:
    
    Class associated with the given name or null.
    
    Throws:
    
    java.lang.ClassNotFoundException - if no class is found for name and noThrow is false.
  - getMethod
```
public java.lang.reflect.Method getMethod(java.lang.Class cls,
                                          java.lang.String name,
                                          java.lang.Object[] paramTypes)
                                   throws java.lang.NoSuchMethodException
```
    Resolve a reflective method, given a class, method name, and parameter signature.
    
    Parameters:
    
    cls - Method's class.
    
    name - Name of the method.
    
    paramTypes - Array of classes representing the types of the parameters expected by the method.
    
    Returns:
    
    The method if it is found.
    
    Throws:
    
    java.lang.NoSuchMethodException - if the method as described does not exist.
  - invoke
```
public java.lang.Object invoke(java.lang.reflect.Method method,
                               java.lang.Object target,
                               java.lang.Object[] args)
                        throws java.lang.IllegalAccessException,
                               java.lang.reflect.InvocationTargetException
```
    Helper function to invoke an arbitrary method through reflection.
    
    Parameters:
    
    method - Method to invoke.
    
    target - Object upon which the method will be invoked.
    
    args - Parameters passed to the method.
    
    Throws:
    
    java.lang.IllegalAccessException - if method object enforces Java language access control and the underlying method is inaccessible.
    
    java.lang.reflect.InvocationTargetException - if the underlying method throws an exception.
  - declaresMember
```
public boolean declaresMember(java.lang.Class cls,
                              java.lang.String name)
```
    Tests whether the specified class declares member of the supplied name.
    
    Parameters:
    
    cls - Class to test.
    
    name - Target member name.
    
    Returns:
    
    true if the class declares the supplied member, false otherwise.
  - getMethodNoCase
```
public java.lang.String getMethodNoCase(java.lang.Class cls,
                                        java.lang.String insensitiveName)
```
    Tests whether the specified class has tge method of the supplied name. The comparison is performed case-insensitively and the method returns the java method name as declared.
    
    Parameters:
    
    cls - Class to test.
    
    insensitiveName - Case insensitive target method name.
    
    Returns:
    
    Returns the matched method name or null if not found.
  - getMethodParamType
```
public java.lang.Class getMethodParamType(java.lang.Class cls,
                                          java.lang.String methodName,
                                          int requiredParamNum,
                                          int paramIdx,
                                          java.lang.Class expectedParamType)
```
    Returns method parameter type on the specified index.
    
    Parameters:
    
    cls - The target class.
    
    methodName - The target case sensitive method name.
    
    requiredParamNum - Only match methods with the specified number of parameters.
    
    paramIdx - The index of the parameter type to return.
    
    expectedParamType - Expected paramater type. This helps in finding the correct method overload.
    
    Returns:
    
    Java class or null if the target method is not found or the target method doesn't declare the requested parameter.
  - getResourceType
```
public java.lang.Class getResourceType(java.lang.Class clazz,
                                       java.lang.String method)
```
    Returns the resource type declared by the supplied method. Method may declare a resource type (the type of the value held by the returned handle) when its return type is handle by declaring the annotation ResourceType with the resource type defined.
    
    Parameters:
    
    clazz - The class to check.
    
    method - The method to check.
    
    Returns:
    
    See above.
  - getClassSimpleName
```
public java.lang.String getClassSimpleName(java.lang.String className)
```
    Returns the simple class name of the supplied (fully qualified) class name.
    
    Parameters:
    
    className - Simple or fully qualified class name.
    
    Returns:
    
    Returns the simple class name.
  - returnsHandle
```
public boolean returnsHandle(java.lang.Class clazz,
                             java.lang.String method)
```
    Returns true if the supplied method declares handle as its return type.
    
    Parameters:
    
    clazz - The class to check.
    
    method - The method to check.
    
    Returns:
    
    See above.
  - getLegacyName
```
public java.lang.String getLegacyName(java.lang.Class<?> cls,
                                      java.lang.String methodName)
```
    Returns the legacy name of the supplied method on the supplied class. The method searches the supplied class for a method of the specified name (case insensitively) and returns the name as defined in LegacyMethod or LegacyAttribute annotations.
    
    Parameters:
    
    cls - Class where to search for the supplied method.
    
    methodName - The class method name.
    
    Returns:
    
    legacy name or null if no match is found.
  - create
```
public java.lang.Object create(java.lang.String className,
                               java.lang.Object[] args)
                        throws java.lang.ClassNotFoundException,
                               java.lang.IllegalAccessException,
                               java.lang.InstantiationException,
                               java.lang.reflect.InvocationTargetException
```
    Create a new instance of the specified class, passing the provided arguments to its constructor.
    
    Parameters:
    
    className - Fully qualified name of the class to be instantiated.
    
    args - Constructor arguments. Currently, null arguments within this array are not supported.
    
    Returns:
    
    Instance of the specified class.
    
    Throws:
    
    java.lang.ClassNotFoundException - if a class named className cannot be found.
    
    java.lang.NullPointerException - if any argument in args is null.
    
    java.lang.NoSuchMethodException - if the signature defined by args matches no constructor in the specified class.
    
    java.lang.IllegalAccessException - if the Constructor used enforces Java language access control and the underlying constructor is inaccessible.
    
    java.lang.IllegalArgumentException - if the number of actual and formal parameters required by the underlying constructor differ; if an unwrapping conversion for primitive arguments fails; or if, after possible unwrapping, a parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion; if more than one suitable matching constructor was detected (indicating ambiguity).
    
    java.lang.InstantiationException - if the class that declares the underlying constructor represents an abstract class.
    
    java.lang.reflect.InvocationTargetException - if the underlying constructor throws an exception.
  - create
```
public java.lang.Object create(java.lang.Class<?> target,
                               java.lang.Object[] args)
                        throws java.lang.IllegalAccessException,
                               java.lang.InstantiationException,
                               java.lang.reflect.InvocationTargetException
```
    Create a new instance of the specified class, passing the provided arguments to its constructor.
    
    Parameters:
    
    target - Class to be instantiated.
    
    args - Constructor arguments. Currently, null arguments within this array are not supported.
    
    Returns:
    
    Instance of the specified class.
    
    Throws:
    
    java.lang.NullPointerException - if any argument in args is null.
    
    java.lang.NoSuchMethodException - if the signature defined by args matches no constructor in the specified class.
    
    java.lang.IllegalAccessException - if the Constructor used enforces Java language access control and the underlying constructor is inaccessible.
    
    java.lang.IllegalArgumentException - if the number of actual and formal parameters required by the underlying constructor differ; if an unwrapping conversion for primitive arguments fails; or if, after possible unwrapping, a parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion; if more than one suitable matching constructor was detected (indicating ambiguity).
    
    java.lang.InstantiationException - if the class that declares the underlying constructor represents an abstract class.
    
    java.lang.reflect.InvocationTargetException - if the underlying constructor throws an exception.
  - createList
```
public java.util.List<?> createList(java.lang.Object[] elements)
```
    Create a new List which contains the specified elements as its members.
    
    Parameters:
    
    elements - Elements of the newly created list object.
    
    Returns:
    
    List object which contains elements.
  - splitToList
```
public java.util.List<?> splitToList(java.lang.String val,
                                     java.lang.String delim)
```
    Split the given value into a list of String's, using the given delimiter.
    
    Parameters:
    
    val - The value to split.
    
    delim - The delimiter.
  - createListFromObject
```
public java.util.List<?> createListFromObject(java.lang.Object array)
```
    Generate a list from an array of objects. This variant is used when an array of objects as returned from a method invocation to a user expression must be converted into a list. The object array is not declared as such, to prevent the expression engine's symbol resolver from treating this as a user function which expects a variable argument list.
    
    Parameters:
    
    array - An object that represents an array of objects.
    
    Returns:
    
    List object which contains all elements within array.
  - createSet
```
public java.util.LinkedHashSet<?> createSet(java.lang.Object[] elements)
```
    Create a linked hash set containing the specified elements. Because it is a set, duplicates (as determined by the equals method of the elements) are discarded. Iteration over the resulting set is guaranteed to be in the same order as unique elements were found in the elements array.
    
    Parameters:
    
    elements - Array whose unique elements define the contents of the newly created set.
    
    Returns:
    
    Linked hash set based upon elements.
  - createMap
```
public <K,V> java.util.LinkedHashMap<K,V> createMap(java.util.Set<K> keys,
                                                    java.util.List<V> values)
                                             throws java.lang.IllegalArgumentException
```
    Create a linked hash map whose keys are defined by keys and whose values are defined by values. The map is populated by iterating over keys and associating the value at the corresponding position in the values list. Thus, it is important that the iteration order of keys is well-defined, and corresponds identically with that of values.
    
    Parameters:
    
    keys - Set which defines the keys of the new map.
    
    values - List which defines the values of the new map.
    
    Returns:
    
    New instance of map.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the sizes of the specified data structures are not equal.
  - createUUID
```
public java.util.UUID createUUID(long high,
                                 long low)
```
    Creates new UUID instance from the supplied data.
    
    Parameters:
    
    high - The most significant bits of the UUID
    
    low - The least significant bits of the UUID
    
    Returns:
    
    New UUID instance.
  - getNow
```
public long getNow()
```
    Get the current system time in milliseconds since the epoch.
    
    Returns:
    
    System.currentTimeMillis()
  - getThis
```
public Aast getThis()
```
    Get the instance of the source AST currently set in the resolver.
    
    Returns:
    
    Current source AST.
  - getCopy
```
public Aast getCopy()
```
    Get the instance of the copy AST currently set in the resolver.
    
    Returns:
    
    Current copy AST.
  - getAnalog
```
public Aast getAnalog()
```
    Get the AST node which is located in the copy tree at the analogous index position as the current source AST, with respect to their respective parents. Only one level of ancestor is considered.
    This is meant to enable ascent rules which change the copy tree at the current level, such that the copy map is no longer a reliable mechanism to retrieve the proper analog to the current source node.
    
    Returns:
    
    AST from the copy tree, or null if no such AST exists.
  - parseTree
```
public Aast parseTree(java.lang.String filename)
```
    Load the AST stored in the given file and return it. Do not register it with the AST resolver
    
    Parameters:
    
    filename - Name of file in which AST is stored.
    
    Returns:
    
    Aast read from the file.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is any error loading filename.
  - loadTree
```
public Aast loadTree(java.lang.String filename)
```
    Load the AST stored in the given file. This will register the AST and all of its descendants with the current AST resolver.
    
    Parameters:
    
    filename - Name of file in which AST is stored.
    
    Returns:
    
    Aast read from the file.
    
    Throws:
    
    java.lang.IllegalArgumentException - if there is any error loading filename.
  - registerTree
```
public void registerTree(Aast ast)
```
    Register the given AST and all its descendants with the AST resolver.
    
    Parameters:
    
    ast - Tree to register.
  - getAst
```
public Aast getAst(java.lang.Long id)
```
    Returns an AST instance referenced by its ID if it is loaded (and registered) in the current resolver.
    
    Parameters:
    
    id - The project-unique ID that specifies the AST.
    
    Returns:
    
    The AST or null if the associated AST either doesn't exist or is not loaded (and registered in the resolver).
  - getAst
```
public Aast getAst(java.lang.Long id,
                   boolean loadTree)
```
    Returns an AST instance referenced by its ID. If it is not loaded and registered with the current resolver, optionally load and register its enclosing tree.
    
    Parameters:
    
    id - The project-unique ID that specifies the AST.
    
    loadTree - if true, the tree enclosing the AST with the given ID will be loaded and registered with the current resolver. Use this option with caution. ASTs can be large and this can consume a lot of memory.
    
    Returns:
    
    The AST or null if the associated AST doesn't exist.
  - removeAst
```
public void removeAst(java.lang.Long id)
```
    Remove the entire tree enclosing the specified AST from the resolver.
    
    Parameters:
    
    id - The project-unique ID that specifies the AST.
  - isAst
```
public boolean isAst(java.lang.String filename)
```
    Determines if the given file is a valid AST.
    
    Parameters:
    
    filename - The filename to check. It does not need to have the AST extension.
    
    Returns:
    
    true if there is an AST for the given file.
  - getType
```
public int getType()
```
    Get the token type of the current, source AST.
    Corresponds with runtime variable type.
    
    Returns:
    
    Token type.
  - setType
```
public boolean setType(long type)
```
    Set the token type of the current, copy AST.
    
    Returns:
    
    Always true.
  - getName
```
public java.lang.String getName()
```
    Get the token name of the current, source AST. The token name is the symbolic text representation of the integer token type.
    Corresponds with runtime variable name.
    
    Returns:
    
    Token name.
  - getParent
```
public Aast getParent()
```
    Get the current, source AST's parent, if any.
    Corresponds with runtime variable parent.
    
    Returns:
    
    Parent AST, or null if no source or parent.
  - getText
```
public java.lang.String getText()
```
    Get the token text of the current source AST.
    Corresponds with runtime variable text.
    
    Returns:
    
    Token text.
  - setText
```
public boolean setText(java.lang.String text)
```
    Set the token text of the current copy AST.
    
    Returns:
    
    Always true.
  - getId
```
public java.lang.Long getId()
```
    Get the project-unique AST node ID of the current, source AST.
    Corresponds with runtime variable id.
    
    Returns:
    
    The project-unique node ID.
  - getFile
```
public java.lang.String getFile()
```
    Get the name of the source code file associated with the current source AST. The filename will be relative to P2J_HOME.
    Corresponds with runtime variable file.
    
    Returns:
    
    Source code filename.
  - getPersistenceFilename
```
public java.lang.String getPersistenceFilename()
```
    Returns the project relative filename of the copy AST persistence file, using the default persistence naming convention.
    Corresponds with runtime variable persistenceFilename.
    
    Returns:
    
    The filename or null if the filename cannot be obtained.
  - getLine
```
public long getLine()
```
    Get the line number in the source code file at which the current source AST was found.
    Corresponds with runtime variable line.
    
    Returns:
    
    Source code line number.
  - getColumn
```
public long getColumn()
```
    Get the column number in the source code file at which the current source AST was found.
    Corresponds with runtime variable column.
    
    Returns:
    
    Source code column number.
  - getDepth
```
public long getDepth()
```
    Get the number of generations away from the root AST node this AST is located (in the source AST). A depth of 0 corresponds with the root node itself; 1 with the root's immediate children; and so on.
    Corresponds with runtime variable depth.
    
    Returns:
    
    AST depth from root.
  - getPath
```
public java.lang.String getPath()
```
    Accesses the full path from the current source AST to the root.
    
    Returns:
    
    Full path from the current AST to the root node, formatted as in Aast.getPath().
  - getTreeDump
```
public java.lang.String getTreeDump()
```
    Accesses the text representation (human readable 'parser output') of the tree rooted at the current AST node.
    
    Returns:
    
    Text dump of the tree structure and contents.
  - getAncestorTreeDump
```
public java.lang.String getAncestorTreeDump(long level)
```
    Accesses the text representation (human readable 'parser output') of the tree rooted at the specified ancestor AST node, if such a node exists.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    Returns:
    
    Text dump of the tree structure and contents or null if no such node exists (if the level specified is greater than depth of the tree).
  - matches
```
public boolean matches(java.lang.String text,
                       java.lang.String regex)
```
    Determine whether text matches the specified regular expression.
    
    Parameters:
    
    text - String to test.
    
    regex - Regular expression to apply against text.
    
    Returns:
    
    true for a match, else false.
  - matches
```
public boolean matches(java.lang.String text,
                       java.lang.String regex,
                       boolean sensitive)
```
    Determine whether text matches the specified regular expression, taking the caller's case-sensitivity into account. If the case-insensitive mode is chosen, both the input text and the regular expression will be lowercased before match processing occurs.
    
    Parameters:
    
    text - String to test.
    
    regex - Regular expression to apply against text.
    
    sensitive - true if normal case-sensitivity should be used, false for case-insensitive matching.
    
    Returns:
    
    true for a match, else false.
  - evalLib
```
public java.lang.Boolean evalLib(java.lang.String name,
                                 java.lang.Object[] args)
```
    Implementation of the evalLib user function. Accepts the name of a named expression and executes that expression. The expression to which this function refers is assumed to return a Boolean result. This is a convenience form of execLib which eliminates the cast when used as a condition.
    
    Parameters:
    
    name - Name of an expression to execute.
    
    args - The array of Object instances of the correct data type and in the correct order to match our parameter list. Each element of the array will be assigned into the matching parameter in our parameter list before the expression is executed.
    
    Returns:
    
    Boolean result of executing the named expression.
    
    Throws:
    
    ExpressionException - if any error occurs compiling the named expression before its first use.
  - execLib
```
public java.lang.Object execLib(java.lang.String name,
                                java.lang.Object[] args)
```
    Implementation of the execLib user function. Accepts the name of a named expression and executes that expression.
    
    Parameters:
    
    name - Name of an expression to execute.
    
    args - The array of Object instances of the correct data type and in the correct order to match our parameter list. Each element of the array will be assigned into the matching parameter in our parameter list before the expression is executed.
    
    Returns:
    
    Boolean result of executing the named expression.
    
    Throws:
    
    ExpressionException - if any error occurs compiling the named expression before its first use.
  - eval
```
public java.lang.Boolean eval(java.lang.String expr)
```
    Implementation of the eval user function. Accepts the an expression, then compiles (if necessary) and executes that expression returning a Boolean result. This is a convenience form of exec which eliminates the cast when used as a condition.
    
    Parameters:
    
    expr - An expression to execute.
    
    Returns:
    
    Result of executing the passed expression.
    
    Throws:
    
    ExpressionException - if any error occurs compiling the expression before it's first use.
  - exec
```
public java.lang.Object exec(java.lang.String expr)
```
    Implementation of the exec user function. Accepts the an expression, then compiles (if necessary) and executes that expression.
    
    Parameters:
    
    expr - An expression to execute.
    
    Returns:
    
    Result of executing the passed expression.
    
    Throws:
    
    ExpressionException - if any error occurs compiling the expression before it's first use.
  - root
```
public boolean root()
```
    Implementation of the root user function. Determines whether the current AST is the root of the source tree.
    
    Returns:
    
    true if AST has no parent, else false.
  - leaf
```
public boolean leaf()
```
    Implementation of the leaf user function. Determines whether the current AST is a leaf node of the source tree.
    
    Returns:
    
    true if AST has no children, else false.
  - getNumImmediateChildren
```
public long getNumImmediateChildren()
```
    Implementation of the numImmediateChildren user variable.
    
    Returns:
    
    The number of immediate children for the current AST node.
  - getNextChildIndex
```
public int getNextChildIndex()
```
    Implementation of the nextChildIndex user variable which denotes which child is about to be processed when processing a 'next-child' rule. Since child indices are 0-based, the next child index will always be greater than 0 during the processing of a 'next-child' rule, since the first time a 'next-child' rule is called, the previous child is 0 and the next child is 1 (so the return from this function will be 1).
    
    Returns:
    
    The next child to be processed or -1 if a 'next-child' rule is not in progress.
  - imaginary
```
public boolean imaginary()
```
    Implementation of the imaginary user function. Determines whether the token underlying the current AST was created artificially, or is based upon a source code element.
    
    Returns:
    
    true if AST has a line:column position of 0:0, else false.
  - absolutePath
```
public boolean absolutePath(java.lang.String path)
```
    Compares the current source AST's path from the root with the specified path.
    
    Parameters:
    
    path - Root-to-current path, formatted as described in Aast.getPath().
    
    Returns:
    
    true if specified path matches current source AST's path exactly, else false.
  - relativePath
```
public boolean relativePath(java.lang.String path)
```
    Determines if the current source AST's path from the root ends with the specified path, on a case-insensitive basis.
    The current source AST's type IS included in this path, which is different from the upPath(java.lang.String) which compares paths upward from the parent node.
    
    Parameters:
    
    path - Partial path from the current AST up to an arbitrary number of parent nodes, formatted as described in Aast.getPath().
    
    Returns:
    
    true if specified path matches the end of the current source AST's path exactly, else false.
  - upPath
```
public boolean upPath(java.lang.String path)
```
    Determines if the current source AST's path upward matches the specified path, on a case-insensitive basis. The format of the 'segments' of the up path starts with the parent's type and each subsequent segment must be the type of the next parent up in the hierarchy.
    The type of the current node is NOT included in the up path. This is the only difference with relativePath(java.lang.String).
    
    Parameters:
    
    path - Partial path from the current AST's parent upward to an arbitrary number of ancestor nodes, formatted as described in Aast.getPath().
    
    Returns:
    
    true if specified path exactly matches the upward path from the current source AST's parent, else false.
  - downPath
```
public boolean downPath(java.lang.String path)
```
    Determines if the current source AST's path downward matches the specified path, on a case-insensitive basis. More than 1 down path may match this specification, if any such match exists then this function will return true. The format of the 'segments' of the down path starts with the immediate child's type and each subsequent segment must be the type of the next child down in the hierarchy. The type of the current node is NOT included in the down path.
    
    Parameters:
    
    path - Partial path from the current AST down to an arbitrary number of descendant nodes, formatted as described in Aast.getPath().
    
    Returns:
    
    true if specified path exactly matches the downward path from the current source AST, else false.
  - ancestor
```
public boolean ancestor(long type,
                        long maxLevels)
```
    Implementation of the ancestor user function. Indicates whether a token type exists within the ancestry of the current source AST.
    
    Parameters:
    
    type - Token type to be matched.
    
    maxLevels - Maximum number of generations up the tree to search for an ancestor. Set to -1 to search up to the tree root, 0 for the current node, 1 for the parent, 2 for the 'grandparent' and so forth.
    
    Returns:
    
    true if token was found as an ancestor's token type within maxLevels generations, else false.
  - descendant
```
public boolean descendant(long type,
                          long maxLevels)
```
    Implementation of the descendant user function. Searches the current source AST's descendants for a token type match.
    
    Parameters:
    
    type - Token type to be matched.
    
    maxLevels - Number of generations to search before abandoning the test. Set to 0 to search exhaustively.
    
    Returns:
    
    true if token was found as an descendant's token type within maxLevels generations, else false.
  - childAt
```
public boolean childAt(long type,
                       long index)
```
    Compares the current source AST's immediate descendant (direct child) at a specific 0-based index for a match with a specific token type.
    
    Parameters:
    
    type - Token type to be matched.
    
    index - 0-based index of the child to test.
    
    Returns:
    
    true if token was found in a specific child's token type, else false if no child exists at that index or if the child does not match the token type.
  - sibling
```
public boolean sibling(long type)
```
    Test whether any of the current AST's siblings matches the given token type.
    
    Parameters:
    
    type - Token type to match.
    
    Returns:
    
    true if any of the current AST's siblings match, else false.
  - getLeftSiblings
```
public long getLeftSiblings()
```
    Returns the number of siblings to the current AST's left.
    Corresponds with runtime variable leftSiblings.
    
    Returns:
    
    The number of left siblings or 0 if this AST is the first child or has no parent (i.e. it is the tree root).
  - getRightSiblings
```
public long getRightSiblings()
```
    Returns the number of siblings to the current AST's right.
    Corresponds with runtime variable rightSiblings.
    
    Returns:
    
    The number of right siblings or 0 if this AST is the last child or has no parent (i.e. it is the tree root).
  - getChildIndex
```
public long getChildIndex()
```
    Returns the 0-based child index of the current AST.
    Corresponds with runtime variable childIndex.
    
    Returns:
    
    The number of left siblings or 0 if this AST is the first child or has no parent (i.e. it is the tree root).
  - addToView
```
public boolean addToView()
```
    Add the current copy AST to the filtered view of ASTs which can be pipelined to the next ruleset.
    
    Returns:
    
    true
  - addAllToView
```
public boolean addAllToView(java.util.List<Aast> list)
```
    Add the current copy AST to the filtered view of ASTs which can be pipelined to the next ruleset.
    
    Parameters:
    
    list - The nodes to add to the view.
    
    Returns:
    
    true
  - addToView
```
public boolean addToView(java.lang.Long id)
```
    Add the AST specified by the passed ID to the filtered view of ASTs which can be pipelined to the next ruleset. The AST will only be added if it exists in the current copy of the source tree.
    
    Returns:
    
    true if the AST is valid (and thus was added), false otherwise.
  - addParentToView
```
public boolean addParentToView()
```
    Add the parent of the current copy AST to the filtered view of ASTs which can be pipelined to the next ruleset, if the parent node is not null.
    
    Returns:
    
    true
  - addAncestorToView
```
public boolean addAncestorToView(long level)
```
    Add a specified ancestor of the current copy AST to the filtered view of ASTs which can be pipelined to the next ruleset, if the all nodes in the ancestry chain (up to and including the specified level) are not null.
    
    Parameters:
    
    level - Identifies the ancestor by the number of generations 'up' the tree from the current node. 0 specifies the current node, 1 specifies the parent node, 2 specifies the 'grandparent' node and so forth.
    
    Returns:
    
    true
  - addTreeToView
```
public boolean addTreeToView(long maxLevels)
```
    Add the current copy AST, and all of its descendants through maxLevels generations, to the filtered view of ASTs which can be pipelined to the next ruleset.
    
    Parameters:
    
    maxLevels - Number of descendant generations to add. To add only the current AST, specify 1 (or better yet, use addToView()).
    
    Returns:
    
    true
  - addPathToViewFrom
```
public boolean addPathToViewFrom(long type)
```
    Add to the filtered view of ASTs all of the nodes which form the path from an ancestor node of type type to the current copy AST. The nodes are added in root to leaf order. If an ancestor node of type type does not exist, no nodes are added (not even the current one).
    
    Parameters:
    
    type - Ancestor token type which marks the beginning of the path.
    
    Returns:
    
    true if an ancestor of type type was found and the path of nodes was successfully added to the filtered view, else false.
  - printAst
```
public boolean printAst()
```
    Prints a string representation of the current source AST to stdout, indented appropriately to indicate its depth in the AST structure.
    
    Returns:
    
    true
  - remove
```
public boolean remove()
```
    Removes the current AST node from the copy AST.
    
    Returns:
    
    true
  - charAt
```
public java.lang.String charAt(java.lang.String text,
                               int index)
```
    Get the character at the specified index, as a string.
    
    Parameters:
    
    text - The source text.
    
    index - The character's index.
    
    Returns:
    
    See above.
  - upper
```
public java.lang.String upper(java.lang.String text)
```
    Uppercase and return the given string.
    
    Parameters:
    
    text - The string to uppercase.
    
    Returns:
    
    text string in all upper case.
  - lower
```
public java.lang.String lower(java.lang.String text)
```
    Lowercase and return the given string.
    
    Parameters:
    
    text - The string to lowercase.
    
    Returns:
    
    text string in all lower case.
  - string
```
public java.lang.String string(long value)
```
    Convert a numeric value to its default string representation.
    
    Parameters:
    
    value - Number to convert.
    
    Returns:
    
    Default string representation.
  - string
```
public java.lang.String string(double value)
```
    Convert a numeric value to its default string representation.
    
    Parameters:
    
    value - Number to convert.
    
    Returns:
    
    Default string representation.
  - string
```
public java.lang.String string(boolean value)
```
    Convert a boolean value to its default string representation.
    
    Parameters:
    
    value - Number to convert.
    
    Returns:
    
    Default string representation.
  - substring
```
public java.lang.String substring(java.lang.String text,
                                  long index)
```
    Returns the portion of the input string from the 0-based index to the end.
    
    Parameters:
    
    text - The input string.
    
    index - The character at which to start the substring.
    
    Returns:
    
    The portion of the string specified.
  - substring
```
public java.lang.String substring(java.lang.String text,
                                  long begin,
                                  long end)
```
    Returns the portion of the input string from the 0-based index to the end.
    
    Parameters:
    
    text - The input string.
    
    begin - The character at which to start the substring.
    
    end - The character before which to end the substring.
    
    Returns:
    
    The portion of the string specified.
  - indexOf
```
public long indexOf(java.lang.String text,
                    java.lang.String find)
```
    Returns the 0-based index of the first character that matches the find string in the input string or -1 if no match was found.
    
    Parameters:
    
    text - The input string.
    
    find - The string to search for.
    
    Returns:
    
    The index of the beginning of the match.
  - indexOf
```
public long indexOf(java.lang.String text,
                    java.lang.String find,
                    long start)
```
    Returns the 0-based index of the first character that matches the find string after the starting point in the input string or -1 if no match was found.
    
    Parameters:
    
    text - The input string.
    
    find - The string to search for.
    
    start - The starting index from which to search.
    
    Returns:
    
    The index of the beginning of the match.
  - lastIndexOf
```
public long lastIndexOf(java.lang.String text,
                        java.lang.String find)
```
    Returns the 0-based index of the first character of the last match to the find string in the input string or -1 if no match was found. This match algorithm works backward.
    
    Parameters:
    
    text - The input string.
    
    find - The string to search for.
    
    Returns:
    
    The index of the beginning of the match.
  - lastIndexOf
```
public long lastIndexOf(java.lang.String text,
                        java.lang.String find,
                        long start)
```
    Returns the 0-based index of the first character of the last match of the find string before the starting point in the input string or -1 if no match was found. This match algorithm works backward.
    
    Parameters:
    
    text - The input string.
    
    find - The string to search for.
    
    start - The starting index from which to search backward.
    
    Returns:
    
    The index of the beginning of the match.
  - stringLength
```
public long stringLength(java.lang.String text)
```
    Returns the length in characters of the given string.
    
    Parameters:
    
    text - The input string.
    
    Returns:
    
    The length of the string in characters.
  - copies
```
public java.lang.String copies(java.lang.String text,
                               int num)
```
    Returns a string that is comprised of the input string concatenated num times without intervening spaces.
    
    Parameters:
    
    text - The input string.
    
    num - The number of times to repeat the input string in the output string.
    
    Returns:
    
    The concatenated string.
  - wrapText
```
public java.util.List wrapText(java.lang.String text,
                               int width)
```
    Wrap a text string to fit into one or more lines of the specified width. Expects the space character to delimit the words in the input string. Returns a list of as many strings as are necessary to meet the per-line width requirement. Single words that are wider than width are not split, but will appear in their own line. All lines are left-aligned within the alloted width.
    
    Parameters:
    
    text - Text to be split.
    
    width - Per-line width in characters.
    
    Returns:
    
    List of strings representing text split into lines of the specified width.
  - removeQuotes
```
public java.lang.String removeQuotes(java.lang.String text)
```
    Strip enclosing double or single quotes, if any, plus any options, from the given string.
    
    Parameters:
    
    text - String optionally enclosed in quotes.
    
    Returns:
    
    A string based on text, but with quotes removed.
  - switchQuotes
```
public java.lang.String switchQuotes(java.lang.String text,
                                     java.lang.String prevQuoteChar,
                                     java.lang.String newQuoteChar)
```
    Prepare the given text so that its quotes can be switched from the previous quote to the new quotes.
    This includes un-escaping and un-doubling the previous quote char and escaping the new quote char.
    
    Parameters:
    
    text - The text to have its quotes switched.
    
    prevQuoteChar - The previous quote.
    
    newQuoteChar - The new quote.
    
    Returns:
    
    The prepared string.
  - trimLeading
```
public java.lang.String trimLeading(java.lang.String text)
```
    Trim leading whitespace from text, without triggering a NullPointerException if text is null.
    
    Parameters:
    
    text - Text string to be trimmed.
    
    Returns:
    
    text with leading whitespace removed, or null if text is null.
  - trimTrailing
```
public java.lang.String trimTrailing(java.lang.String text)
```
    Trim trailing whitespace (space, tab, CR and LF) from text, without triggering a NullPointerException if text is null.
    
    Parameters:
    
    text - Text string to be trimmed.
    
    Returns:
    
    text with trailing whitespace removed, or null if text is null.
  - trimTrailingSpaces
```
public java.lang.String trimTrailingSpaces(java.lang.String text)
```
    Trim only trailing spaces from text, without triggering a NullPointerException if text is null.
    
    Parameters:
    
    text - Text string to be trimmed.
    
    Returns:
    
    text with trailing whitespace removed, or null if text is null.
  - parseLong
```
public java.lang.Long parseLong(java.lang.String text)
                         throws java.lang.NumberFormatException
```
    Parse a Long from text and return it.
    
    Parameters:
    
    text - String representing a base-10 long value.
    
    Returns:
    
    text as a Long.
    
    Throws:
    
    java.lang.NumberFormatException - if text cannot be parsed into a long.
  - parseLong
```
public java.lang.Long parseLong(java.lang.String text,
                                int radix)
                         throws java.lang.NumberFormatException
```
    Parse a Long from text using the given radix, and return it.
    
    Parameters:
    
    text - String representing a long value with the specified radix.
    
    radix - Radix to be used interpreting text.
    
    Returns:
    
    text as a Long.
    
    Throws:
    
    java.lang.NumberFormatException - if text cannot be parsed into a long.
  - parseLongQuiet
```
public java.lang.Long parseLongQuiet(java.lang.String text)
```
    Parse a Long from text and return it. Do not raise an exception if text cannot be parsed.
    
    Parameters:
    
    text - String representing a base-10 long value.
    
    Returns:
    
    text as a Long, or null if text cannot be parsed into a Long.
  - parseLongQuiet
```
public java.lang.Long parseLongQuiet(java.lang.String text,
                                     int radix)
```
    Parse a Long from text using the given radix, and return it. Do not raise an exception if text cannot be parsed.
    
    Parameters:
    
    text - String representing a long value with the specified radix.
    
    radix - Radix to be used interpreting text.
    
    Returns:
    
    text as a Long, or null if text cannot be parsed into a Long.
  - parseDouble
```
public java.lang.Double parseDouble(java.lang.String text)
                             throws java.lang.NumberFormatException
```
    Parse a Double from text and return it.
    
    Parameters:
    
    text - String representing a double value.
    
    Returns:
    
    text as a Double.
    
    Throws:
    
    java.lang.NumberFormatException - if text cannot be parsed into a double.
  - parseDoubleQuiet
```
public java.lang.Double parseDoubleQuiet(java.lang.String text)
```
    Parse a Double from text and return it. Do not raise an exception if text cannot be parsed.
    
    Parameters:
    
    text - String representing a double value.
    
    Returns:
    
    text as a Double or null if text cannot be parsed.
  - parseBigDecimal
```
public java.math.BigDecimal parseBigDecimal(java.lang.String text)
```
    Parse a BigDecimal from text and return it.
    
    Parameters:
    
    text - String representing a decimal value.
    
    Returns:
    
    text as a BigDecimal.
    
    Throws:
    
    java.lang.NumberFormatException - if text cannot be parsed into a decimal.
  - now
```
public datetimetz now()
```
    Get the NOW value. Used by import to resolve the NOW function at the field's inital value.
    
    Returns:
    
    See above.
  - today
```
public date today()
```
    Get the TODAY value. Used by import to resolve the TODAY function at the field's inital value.
    
    Returns:
    
    See above.
  - parseDatetimetzLiteral
```
public datetimetz parseDatetimetzLiteral(java.lang.String text)
```
    Parse the ISO8601 text as a datetimetz literal. Used by import for the field's initial value.
    
    Parameters:
    
    text - The datetimetz literal in ISO8601 format.
    
    Returns:
    
    See above.
  - parseDatetimeLiteral
```
public datetime parseDatetimeLiteral(java.lang.String text)
```
    Parse the ISO8601 text as a datetime literal. Used by import for the field's initial value.
    
    Parameters:
    
    text - The datetime literal in ISO8601 format.
    
    Returns:
    
    See above.
  - toBigDecimal
```
public java.math.BigDecimal toBigDecimal(java.lang.Double num)
```
    Convert a double value to a BigDecimal.
    
    Parameters:
    
    num - A Double instance to be converted.
    
    Returns:
    
    An exact representation of the input value.
  - print
```
public boolean print(java.lang.String text)
```
    Debug user function implementation to print text to stdout.
    
    Parameters:
    
    text - Text to be printed.
  - println
```
public boolean println(java.lang.String text)
```
    Debug user function implementation to print text to stdout, followed by a line break.
    
    Parameters:
    
    text - Text to be printed.
  - persist
```
public boolean persist()
                throws ConfigurationException,
                       AstException
```
    Persist the copy AST to file, using the default persistence naming convention. This will overwrite any existing file of the same name without complaint or warning.
    
    Returns:
    
    true.
    
    Throws:
    
    ConfigurationException - if P2J_HOME has not been defined for this process.
    
    AstException - if any error occurs persisting the AST.
  - persist
```
public boolean persist(java.lang.String filename,
                       boolean projectRelative)
                throws ConfigurationException,
                       AstException
```
    Persist the copy AST to file, using the default persistence naming convention. This will overwrite any existing file of the same name without complaint or warning.
    
    Parameters:
    
    filename - The file to persist.
    
    projectRelative - true if the filename is relative to the project home directory, false if the filename is absolute or relative to the current directory.
    
    Returns:
    
    true.
    
    Throws:
    
    ConfigurationException - if P2J_HOME has not been defined for this process.
    
    AstException - if any error occurs persisting the AST.
  - persist
```
public boolean persist(java.lang.String filename,
                       boolean projectRelative,
                       boolean terse)
                throws ConfigurationException,
                       AstException
```
    Persist the copy AST to file, using the default persistence naming convention. This will overwrite any existing file of the same name without complaint or warning.
    
    Parameters:
    
    filename - The file to persist.
    
    projectRelative - true if the filename is relative to the project home directory, false if the filename is absolute or relative to the current directory.
    
    terse - true to persist the AST in terse mode, otherwise false.
    
    Returns:
    
    true.
    
    Throws:
    
    ConfigurationException - if P2J_HOME has not been defined for this process.
    
    AstException - if any error occurs persisting the AST.
  - persist
```
public boolean persist(Aast root,
                       java.lang.String filename,
                       boolean projectRelative,
                       boolean terse)
                throws ConfigurationException,
                       AstException
```
    Persist the specified AST to file, using the default persistence naming convention. This will overwrite any existing file of the same name without complaint or warning.
    
    Parameters:
    
    root - The root AST.
    
    filename - The file to persist.
    
    projectRelative - true if the filename is relative to the project home directory, false if the filename is absolute or relative to the current directory.
    
    terse - true to persist the AST in terse mode, otherwise false.
    
    Returns:
    
    true.
    
    Throws:
    
    ConfigurationException - if P2J_HOME has not been defined for this process.
    
    AstException - if any error occurs persisting the AST.
  - addNewProgramFile
```
public void addNewProgramFile(Aast root)
```
    Add the given AST as a new program file, by registering its filename.
    
    Parameters:
    
    root - The AST root.
  - clearNewProgramFiles
```
public void clearNewProgramFiles()
```
    Clear the list of newly, generated, program file names.
  - dumpStack
```
public boolean dumpStack()
```
    Debug method to print a stack trace dump to stderr.
    
    Returns:
    
    true.
  - compileError
```
public void compileError(int id,
                         java.lang.String message,
                         Aast ast)
                  throws CompileException
```
    Throws a CompileException with a user-defined message. This will halt pattern engine processing.
    Data associated with the currently processing AST node will NOT be included in the formatted message.
    Both id and message should match one of the Progress' set of compile errors, so it would be properly recognized by the dynamic conversion module.
    
    Parameters:
    
    id - The identifier of the error message.
    
    message - Error message to include in the exception's text.
    
    ast - The AST that caused the error.
    
    Throws:
    
    CompileException - Always, with the provided information.
  - compileError
```
public void compileError(int id,
                         java.lang.String message)
                  throws CompileException
```
    Throws a CompileException with a user-defined message. This will halt pattern engine processing.
    Data associated with the currently processing AST node will NOT be included in the formatted message.
    Both id and message should match one of the Progress' set of compile errors, so it would be properly recognized by the dynamic conversion module.
    
    Parameters:
    
    id - The identifier of the error message.
    
    message - Error message to include in the exception's text.
    
    Throws:
    
    CompileException - Always, with the provided information.
  - throwException
```
public void throwException(java.lang.String message)
                    throws CommonAstSupport.UserGeneratedException
```
    Throws a CommonAstSupport.UserGeneratedException with a user-defined message. This will halt pattern engine processing.
    Data associated with the currently processing AST node will be included in the formatted message.
    Use this method if the error you encounter is a P2J specific issue. If it is an error detected in code, use the compileError(int, String) instead, with the parameters compatible to P4GL compiler error set.
    
    Parameters:
    
    message - Error message to include in the exception's text.
    
    Throws:
    
    CommonAstSupport.UserGeneratedException
  - throwException
```
public void throwException(java.lang.String message,
                           Aast ast)
                    throws CommonAstSupport.UserGeneratedException
```
    Throws a CommonAstSupport.UserGeneratedException with a user-defined message. This will halt pattern engine processing.
    
    Parameters:
    
    message - Error message.
    
    ast - AST at which failure occurred.
    
    Throws:
    
    CommonAstSupport.UserGeneratedException
  - sprintf
```
public java.lang.String sprintf(java.lang.String format,
                                java.lang.Object[] args)
```
    Given a format string using C-like printf syntax, and an array of runtime replacement arguments, perform formatted variable substitution and return the resulting string.
    Parameters:
    
    format - A format string using C-like sprintf syntax for its substitution placeholders.
    args - An array of objects which must contain only the following types:
    
    java.lang.String
    java.lang.Long
    java.lang.Double
    These are the values to be substituted into the format string at placeholders of the appropriate, matching type.
    Returns:
    
    A string which is based upon the format string, with values from args substituted in for the appropriate, respective placeholder variables.
  - fprintf
```
public boolean fprintf(java.lang.String filename,
                       java.lang.String format,
                       java.lang.Object[] args)
                throws ConfigurationException,
                       java.lang.IllegalArgumentException,
                       java.io.IOException
```
    Given a format string using C-like printf syntax, and an array of runtime replacement arguments, perform formatted variable substitution and APPEND the resulting string to a named file. The file will be opened and closed in this method, such that no state is maintained between calls.
    Parameters:
    
    filename - The file to which the resulting string will be appended. If the file doesn't exist it will be created. The filename MUST be specified in a format that is relative to the project root.
    
    format - A format string using C-like sprintf syntax for its substitution placeholders.
    args - An array of objects which must contain only the following types:
    
    java.lang.String
    java.lang.Long
    java.lang.Double
    These are the values to be substituted into the format string at placeholders of the appropriate, matching type.
    Returns:
    
    true.
    
    Throws:
    
    ConfigurationException - if P2J_HOME has not been defined for this process.
    
    java.lang.IllegalArgumentException - if a stream for the specified filename cannot be created.
    
    java.io.IOException
  - openStream
```
public java.lang.Long openStream(java.lang.String filename,
                                 boolean projectRelative)
                          throws ConfigurationException,
                                 java.lang.IllegalArgumentException,
                                 java.io.IOException
```
    Opens a new stream for writing and associates a unique ID with that stream. Any path to the target file is created if needed before the stream for that file is opened.
    
    Parameters:
    
    filename - The name of the file to be opened.
    
    projectRelative - true if the filename is relative to the project home directory, false if the filename is absolute or relative to the current directory.
    
    Returns:
    
    The unique ID associated with this stream.
    
    Throws:
    
    ConfigurationException - if P2J_HOME has not been defined for this process.
    
    java.lang.IllegalArgumentException - if a stream for the specified filename cannot be created.
    
    java.io.IOException
  - closeStream
```
public boolean closeStream(java.lang.Long id)
                    throws java.io.IOException
```
    Closes a stream that was previously opened and which was associated with a specific ID.
    
    Parameters:
    
    id - The ID of a stream which muct have previously been opened.
    
    Returns:
    
    Always true.
    
    Throws:
    
    java.io.IOException
  - getNumBytesWritten
```
public long getNumBytesWritten(java.lang.Long id)
```
    Returns the number of bytes written to this stream since it was opened.
    
    Parameters:
    
    id - The ID of a stream which muct have previously been opened.
    
    Returns:
    
    The number of bytes written since opening the stream or -1 if the stream doesn't exist.
  - fprintf
```
public boolean fprintf(java.lang.Long id,
                       java.lang.String format,
                       java.lang.Object[] args)
                throws java.lang.IllegalArgumentException,
                       java.io.IOException
```
    Given a format string using C-like printf syntax, and an array of runtime replacement arguments, perform formatted variable substitution and APPEND the resulting string to previously opened stream identified by a numeric ID. This is a stateful version of the fprintf(String,String,Object[]). Use the methods openStream(java.lang.String, boolean) and closeStream(java.lang.Long) to open and close the stream.
    The output from this method will be UTF-8 encoded.
    Parameters:
    
    id - The ID of a stream which muct have previously been opened.
    
    format - A format string using C-like sprintf syntax for its substitution placeholders.
    args - An array of objects which must contain only the following types:
    
    java.lang.String
    java.lang.Long
    java.lang.Double
    These are the values to be substituted into the format string at placeholders of the appropriate, matching type.
    Returns:
    
    Always true.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the specified stream does not exist.
    
    java.io.IOException
  - printf
```
public boolean printf(java.lang.String format,
                      java.lang.Object[] args)
```
    Prints a string formatted by sprintf(java.lang.String, java.lang.Object[]) to stdout with no trailing line break.
    Parameters:
    
    format - A format string using C-like sprintf syntax for its substitution placeholders.
    args - An array of objects which must contain only the following types:
    
    java.lang.String
    java.lang.Long
    java.lang.Double
    These are the values to be substituted into the format string at placeholders of the appropriate, matching type.
    Returns:
    
    true.
  - breakpoint
```
public boolean breakpoint(java.lang.String location,
                          boolean suspend,
                          java.lang.Object... args)
```
    Logs a list of Objects in ERR console with a (usually short) description. Optionally, the processing can be suspended if a debugger is attached to process and inspect the logged entities. The advantage of this method is the direct access to objects passed in as parameters, instead of looking them up in the TRPL runtime structures and over the printf(java.lang.String, java.lang.Object[]) is the lack of formatting parameter (the Object.toString()) used here is powerful enough to display lists, integer and boolean values usually encountered in TRPL code. It also can display any datatypes instead of only 3 supported by printf.
    Notes:
    - this method is only used for debugging. It is NOT recommended to use it in production code;
    - the method uses the stderr console so the output may not be synchronized with normal stdout console.
    Parameters:
    
    location - A short message that will displayed in front of the list of other objects.
    
    suspend - Activate a special breakpoint location after the values were logged. If this is false or no breakpoint was set in debugger, this method behaves like printfln to err console that displays the values in a column.
    
    args - The list of entities to be displayed. Depending on their type, the output for each one is different, the emphasis being put on Aast objects. The items in this list will be TAB-indented.
    
    Returns:
    
    always true.
  - printfln
```
public boolean printfln(java.lang.String format,
                        java.lang.Object[] args)
```
    Prints a string formatted by sprintf(java.lang.String, java.lang.Object[]) to stdout with a trailing line break.
    Parameters:
    
    format - A format string using C-like sprintf syntax for its substitution placeholders.
    args - An array of objects which must contain only the following types:
    
    java.lang.String
    java.lang.Long
    java.lang.Double
    These are the values to be substituted into the format string at placeholders of the appropriate, matching type.
    Returns:
    
    true.
  - getAncestorOfType
```
public Aast getAncestorOfType(java.lang.Object[] types)
```
    Return the first ancestor node which matches one of the specified token types.
    
    Parameters:
    
    types - Token types to match. May not be null or empty.
    
    Returns:
    
    First ancestor to match one of the given types, or null if no such node was found.
  - getAncestor
```
public Aast getAncestor(java.lang.String key,
                        java.lang.Object value,
                        java.lang.Object[] types)
```
    Return the first ancestor node with the specified annotation, optionally refining the match by annotation value and/or token type.
    
    Parameters:
    
    key - Annotation key for which to search; may not be null.
    
    value - Optional annotation value to match. If null, a match on the annotation key (and optionally on token type) is sufficient to constitute success.
    
    types - Optional array of Integer values representing valid token types. If empty, token type is not considered as a match criterion.
    
    Returns:
    
    First ancestor node to match the given criteria, or null if no match was found.
    
    Throws:
    
    java.lang.ClassCastException - if types contains any object type other than Integer.
  - getAncestor
```
public Aast getAncestor(java.lang.Integer index,
                        java.lang.String key,
                        java.lang.Object value,
                        java.lang.Object[] types)
```
    Return the first ancestor node with the specified annotation, optionally refining the match by annotation value and/or token type.
    
    Parameters:
    
    index - Index of annotation to compare when a node is found with the specfied annotation key. Only valid for list type annotations; must be null for simple annotations.
    
    key - Annotation key for which to search; may not be null.
    
    value - Optional annotation value to match. If null, a match on the annotation key (and optionally on token type) is sufficient to constitute success.
    
    types - Optional array of Integer values representing valid token types. If empty, token type is not considered as a match criterion.
    
    Returns:
    
    First ancestor node to match the given criteria, or null if no match was found.
    
    Throws:
    
    java.lang.ClassCastException - if types contains any object type other than Integer.
  - isNote
```
public boolean isNote(java.lang.String key)
```
    Determines if an annotation exists of any String, Double, Long, or Boolean value, indexed by an arbitrary key.
    
    Parameters:
    
    key - Key under which the annotation is stored.
    
    Returns:
    
    true if an annotation exists mapped by that key.
  - getNoteType
```
public java.lang.String getNoteType(java.lang.String key)
```
    Determines the type of an annotation (if it exists) as indexed by an arbitrary key. The full class name will be returned, e.g. java.lang.String.
    
    Parameters:
    
    key - Key under which the annotation is stored.
    
    Returns:
    
    Class name of the annotation or null if the annotation doesn't exist.
  - getNoteSize
```
public long getNoteSize(java.lang.String key)
```
    Returns the size of an array annotation as indexed by an arbitrary key.
    
    Parameters:
    
    key - Key under which the annotation is stored.
    
    Returns:
    
    The number of elements in an array annotation that exists mapped by that key or 0 if no such named array annotation exists. A scalar annotation using that same name will also result in a return of 0.
  - getNoteString
```
public java.lang.String getNoteString(java.lang.String key)
```
    Gets a String annotation from the current, copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if it does not exist in the current, copy AST.
  - getNoteString
```
public java.lang.String getNoteString(java.lang.String key,
                                      long index)
```
    Gets a String annotation at a specific index from an array annotation in the current copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array or if no element exists at the given index.
  - getNoteLong
```
public java.lang.Long getNoteLong(java.lang.String key)
```
    Gets a Long annotation from the current, copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if it does not exist in the current, copy AST.
  - getNoteLong
```
public java.lang.Long getNoteLong(java.lang.String key,
                                  long index)
```
    Gets a Long annotation at a specific index from an array annotation in the current copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array or if no element exists at the given index.
  - getNoteDouble
```
public java.lang.Double getNoteDouble(java.lang.String key)
```
    Gets a Double annotation from the current, copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if it does not exist in the current, copy AST.
  - getNoteDouble
```
public java.lang.Double getNoteDouble(java.lang.String key,
                                      long index)
```
    Gets a Double annotation at a specific index from an array annotation in the current copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array or if no element exists at the given index.
  - getNoteBoolean
```
public java.lang.Boolean getNoteBoolean(java.lang.String key)
```
    Gets a Boolean annotation from the current, copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if it does not exist in the current, copy AST.
  - getNoteBoolean
```
public java.lang.Boolean getNoteBoolean(java.lang.String key,
                                        long index)
```
    Gets a Boolean annotation at a specific index from an array annotation in the current copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array or if no element exists at the given index.
  - getAncestorNoteString
```
public java.lang.String getAncestorNoteString(long level,
                                              java.lang.String key)
```
    Gets a String annotation from the specified ancestor in the copy AST.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if either the annotation or the specified ancestor does not exist.
  - getAncestorNoteString
```
public java.lang.String getAncestorNoteString(long level,
                                              java.lang.String key,
                                              long index)
```
    Gets a String annotation at a specific index from an array annotation in the specified ancestor of the current copy AST.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array or if no element exists at the given index.
  - getAncestorNoteLong
```
public java.lang.Long getAncestorNoteLong(long level,
                                          java.lang.String key)
```
    Gets a Long annotation from the specified ancestor in the copy AST.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if either the annotation or the specified ancestor does not exist.
  - getAncestorNoteLong
```
public java.lang.Long getAncestorNoteLong(long level,
                                          java.lang.String key,
                                          long index)
```
    Gets a Long annotation at a specific index from an array annotation in the specified ancestor of the current copy AST.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array or if no element exists at the given index.
  - getAncestorNoteDouble
```
public java.lang.Double getAncestorNoteDouble(long level,
                                              java.lang.String key)
```
    Gets a Double annotation from the specified ancestor in the copy AST.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if either the annotation or the specified ancestor does not exist.
  - getAncestorNoteDouble
```
public java.lang.Double getAncestorNoteDouble(long level,
                                              java.lang.String key,
                                              long index)
```
    Gets a Double annotation at a specific index from an array annotation in the specified ancestor of the current copy AST.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array or if no element exists at the given index.
  - getAncestorNoteBoolean
```
public java.lang.Boolean getAncestorNoteBoolean(long level,
                                                java.lang.String key)
```
    Gets a Boolean annotation from the specified ancestor in the copy AST.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if either the annotation or the specified ancestor does not exist.
  - getAncestorNoteBoolean
```
public java.lang.Boolean getAncestorNoteBoolean(long level,
                                                java.lang.String key,
                                                java.lang.Boolean defaultValue)
```
    Gets a Boolean annotation from the specified ancestor in the copy AST.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    defaultValue - When the annotation is not found, this is the value returned from the method.
    
    Returns:
    
    The desired annotation value, or null if either the annotation or the specified ancestor does not exist.
  - getAncestorNoteBoolean
```
public java.lang.Boolean getAncestorNoteBoolean(long level,
                                                java.lang.String key,
                                                long index)
```
    Gets a Boolean annotation at a specific index from an array annotation in the specified ancestor of the current copy AST.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array or if no element exists at the given index.
  - getReferenceNoteString
```
public java.lang.String getReferenceNoteString(long id,
                                               java.lang.String key)
```
    Gets a String annotation from the referenced node in the copy AST.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if either the annotation or the referenced node does not exist.
  - getReferenceNoteString
```
public java.lang.String getReferenceNoteString(long id,
                                               java.lang.String key,
                                               long index)
```
    Gets a String annotation at a specific index from an array annotation in the referenced node of the current copy AST.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array, if no element exists at the given index or the referenced node does not exist.
  - getReferenceNoteLong
```
public java.lang.Long getReferenceNoteLong(long id,
                                           java.lang.String key)
```
    Gets a Long annotation from the referenced node in the copy AST.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if either the annotation or the referenced node does not exist.
  - getReferenceNoteLong
```
public java.lang.Long getReferenceNoteLong(long id,
                                           java.lang.String key,
                                           long index)
```
    Gets a Long annotation at a specific index from an array annotation in the referenced node of the current copy AST.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array, if no element exists at the given index or the referenced node does not exist.
  - getReferenceNoteDouble
```
public java.lang.Double getReferenceNoteDouble(long id,
                                               java.lang.String key)
```
    Gets a Double annotation from the referenced node in the copy AST.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if either the annotation or the referenced node does not exist.
  - getReferenceNoteDouble
```
public java.lang.Double getReferenceNoteDouble(long id,
                                               java.lang.String key,
                                               long index)
```
    Gets a Double annotation at a specific index from an array annotation in the referenced node of the current copy AST.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array, if no element exists at the given index or the referenced node does not exist.
  - getReferenceNoteBoolean
```
public java.lang.Boolean getReferenceNoteBoolean(long id,
                                                 java.lang.String key)
```
    Gets a Boolean annotation from the referenced node in the copy AST.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    The desired annotation value, or null if either the annotation or the referenced node does not exist.
  - getReferenceNoteBoolean
```
public java.lang.Boolean getReferenceNoteBoolean(long id,
                                                 java.lang.String key,
                                                 long index)
```
    Gets a Boolean annotation at a specific index from an array annotation in the referenced node of the current copy AST.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to find the annotation.
    
    Returns:
    
    The annotation object stored under the specified key and at the specified index, or null if the annotation doesn't exist, if the annotation is not an array, if no element exists at the given index or the referenced node does not exist.
  - putNote
```
public boolean putNote(java.lang.String key,
                       java.lang.String value)
```
    Store an annotation of type String in the current copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
  - putNote
```
public boolean putNote(java.lang.String key,
                       java.lang.String value,
                       long index)
```
    Store an annotation of type String at the specified index in an array annotation in the current copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to place the annotation.
  - putNote
```
public boolean putNote(java.lang.String key,
                       java.lang.Long value)
```
    Store an annotation of type Long in the current copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
  - putNote
```
public boolean putNote(java.lang.String key,
                       java.lang.Long value,
                       long index)
```
    Store an annotation of type Long at the specified index in an array annotation in the current copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to place the annotation.
  - putNote
```
public boolean putNote(java.lang.String key,
                       java.lang.Double value)
```
    Store an annotation of type Double in the current copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
  - putNote
```
public boolean putNote(java.lang.String key,
                       java.lang.Double value,
                       long index)
```
    Store an annotation of type Double at the specified index in an array annotation in the current copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to place the annotation.
  - putNote
```
public boolean putNote(java.lang.String key,
                       java.lang.Boolean value)
```
    Store an annotation of type Boolean in the current copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
  - putNote
```
public boolean putNote(java.lang.String key,
                       java.lang.Boolean value,
                       long index)
```
    Store an annotation of type Boolean at the specified index in an array annotation in the current copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to place the annotation.
  - removeNote
```
public boolean removeNote(java.lang.String key)
```
    Remove an annotation from the current copy AST.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    true if an entry for key was found and removed; false if none was found.
  - removeNote
```
public boolean removeNote(java.lang.String key,
                          long index)
```
    Remove an element (at the specified index) of an array annotation from an annotation specified by the key in the current copy AST. The special index of -1 indicates the removal of the last element of the array.
    
    Parameters:
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to remove the annotation.
    
    Returns:
    
    true if an entry for key was found and removed; false if none was found, if the annotation is not an array or if no element exists at the given index.
  - putAncestorNote
```
public boolean putAncestorNote(long level,
                               java.lang.String key,
                               java.lang.String value)
```
    Store an annotation of type String in the specified ancestor in the copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    Returns:
    
    true if the annotation was added, false if no such ancestor was found.
  - putAncestorNote
```
public boolean putAncestorNote(long level,
                               java.lang.String key,
                               java.lang.String value,
                               long index)
```
    Store an element in an array annotation of type String at the specified index in the specified ancestor in the copy AST. The special index of -1 indicates the add as the last element of the array.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to insert the annotation.
    
    Returns:
    
    true if the annotation was added, false if no such ancestor was found.
  - putAncestorNote
```
public boolean putAncestorNote(long level,
                               java.lang.String key,
                               java.lang.Long value)
```
    Store an annotation of type Long in the specified ancestor in the copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    Returns:
    
    true if the annotation was added, false if no such ancestor was found.
  - putAncestorNote
```
public boolean putAncestorNote(long level,
                               java.lang.String key,
                               java.lang.Long value,
                               long index)
```
    Store an element in an array annotation of type Long at the specified index in the specified ancestor in the copy AST. The special index of -1 indicates the add as the last element of the array.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to insert the annotation.
    
    Returns:
    
    true if the annotation was added, false if no such ancestor was found.
  - putAncestorNote
```
public boolean putAncestorNote(long level,
                               java.lang.String key,
                               java.lang.Double value)
```
    Store an annotation of type Double in the specified ancestor in the copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    Returns:
    
    true if the annotation was added, false if no such ancestor was found.
  - putAncestorNote
```
public boolean putAncestorNote(long level,
                               java.lang.String key,
                               java.lang.Double value,
                               long index)
```
    Store an element in an array annotation of type Double at the specified index in the specified ancestor in the copy AST. The special index of -1 indicates the add as the last element of the array.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to insert the annotation.
    
    Returns:
    
    true if the annotation was added, false if no such ancestor was found.
  - putAncestorNote
```
public boolean putAncestorNote(long level,
                               java.lang.String key,
                               java.lang.Boolean value)
```
    Store an annotation of type Boolean in the specified ancestor in the copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    Returns:
    
    true if the annotation was added, false if no such ancestor was found.
  - putAncestorNote
```
public boolean putAncestorNote(long level,
                               java.lang.String key,
                               java.lang.Boolean value,
                               long index)
```
    Store an element in an array annotation of type Boolean at the specified index in the specified ancestor in the copy AST. The special index of -1 indicates the add as the last element of the array.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to insert the annotation.
    
    Returns:
    
    true if the annotation was added, false if no such ancestor was found.
  - removeAncestorNote
```
public boolean removeAncestorNote(long level,
                                  java.lang.String key)
```
    Remove an annotation from the specified ancestor in the copy AST.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    true if an entry for key was found and removed; false if no such annotation or no such ancestor was found.
  - removeAncestorNote
```
public boolean removeAncestorNote(long level,
                                  java.lang.String key,
                                  long index)
```
    Remove an element (at the specified index) of an array annotation from an annotation specified by the key in the specified ancestor of the current copy AST. The special index of -1 indicates the removal of the last element of the array.
    
    Parameters:
    
    level - Number of generations up the tree to walk to obtain the ancestor. Set to -1 to obtain the tree root, 0 is the current node, 1 is the parent, 2 is the 'grandparent' and so forth.
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to remove the annotation.
    
    Returns:
    
    true if an entry for key was found and removed; false if none was found, if the annotation is not an array or if no element exists at the given index or if the specified ancestor does not exist.
  - putReferenceNote
```
public boolean putReferenceNote(long id,
                                java.lang.String key,
                                java.lang.String value)
```
    Store an annotation of type String in the referenced node in the copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    Returns:
    
    true if the annotation was added, false if no such node was found.
  - putReferenceNote
```
public boolean putReferenceNote(long id,
                                java.lang.String key,
                                java.lang.String value,
                                long index)
```
    Store an element in an array annotation of type String at the specified index in the referenced node in the copy AST. The special index of -1 indicates the add as the last element of the array.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to insert the annotation.
    
    Returns:
    
    true if the annotation was added, false if no such node was found.
  - putReferenceNote
```
public boolean putReferenceNote(long id,
                                java.lang.String key,
                                java.lang.Long value)
```
    Store an annotation of type Long in the referenced node in the copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    Returns:
    
    true if the annotation was added, false if no such node was found.
  - putReferenceNote
```
public boolean putReferenceNote(long id,
                                java.lang.String key,
                                java.lang.Long value,
                                long index)
```
    Store an element in an array annotation of type Long at the specified index in the referenced node in the copy AST. The special index of -1 indicates the add as the last element of the array.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to insert the annotation.
    
    Returns:
    
    true if the annotation was added, false if no such node was found.
  - putReferenceNote
```
public boolean putReferenceNote(long id,
                                java.lang.String key,
                                java.lang.Double value)
```
    Store an annotation of type Double in the referenced node in the copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    Returns:
    
    true if the annotation was added, false if no such node was found.
  - putReferenceNote
```
public boolean putReferenceNote(long id,
                                java.lang.String key,
                                java.lang.Double value,
                                long index)
```
    Store an element in an array annotation of type Double at the specified index in the referenced node in the copy AST. The special index of -1 indicates the add as the last element of the array.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to insert the annotation.
    
    Returns:
    
    true if the annotation was added, false if no such node was found.
  - putReferenceNote
```
public boolean putReferenceNote(long id,
                                java.lang.String key,
                                java.lang.Boolean value)
```
    Store an annotation of type Boolean in the referenced node in the copy AST. If an annotation exists with the identical key, it is replaced.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    Returns:
    
    true if the annotation was added, false if no such node was found.
  - putReferenceNote
```
public boolean putReferenceNote(long id,
                                java.lang.String key,
                                java.lang.Boolean value,
                                long index)
```
    Store an element in an array annotation of type Boolean at the specified index in the referenced node in the copy AST. The special index of -1 indicates the add as the last element of the array.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    value - Annotation data.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to insert the annotation.
    
    Returns:
    
    true if the annotation was added, false if no such node was found.
  - removeReferenceNote
```
public boolean removeReferenceNote(long id,
                                   java.lang.String key)
```
    Remove an annotation from the referenced node in the copy AST.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    Returns:
    
    true if an entry for key was found and removed; false if no such annotation or no such node was found.
  - removeReferenceNote
```
public boolean removeReferenceNote(long id,
                                   java.lang.String key,
                                   long index)
```
    Remove an element (at the specified index) of an array annotation from an annotation referenced by the key in the referenced node of the current copy AST. The special index of -1 indicates the removal of the last element of the array.
    
    Parameters:
    
    id - The unique ID that references a specific node in the tree.
    
    key - Case-insensitive annotation key.
    
    index - The index of -1 indicates the last element of the array. Otherwise this is the explicit zero-based index at which to remove the annotation.
    
    Returns:
    
    true if an entry for key was found and removed; false if none was found, if the annotation is not an array or if no element exists at the given index or if the referenced node does not exist.
  - getConfigParameter
```
public java.lang.String getConfigParameter(java.lang.String id)
```
    Retrieve value of specified configuration variable.
    
    Parameters:
    
    id - Configuration variable ID.
    
    Returns:
    
    configuration parameter value.
  - saveClasses
```
public void saveClasses()
```
    Save all the 4GL classes (builtin or business logic), .NET or Java classes encountered during parsing.
  - getConfigParameter
```
public java.lang.String getConfigParameter(java.lang.String id,
                                           java.lang.String def)
```
    Retrieve value of specified configuration variable.
    
    Parameters:
    
    id - Configuration variable ID.
    
    def - Default value for the variable.
    
    Returns:
    
    configuration parameter value.
  - getConfigParameter
```
public java.lang.Boolean getConfigParameter(java.lang.String id,
                                            boolean def)
```
    Retrieve value of specified configuration variable.
    
    Parameters:
    
    id - Configuration variable ID.
    
    def - Default value for the variable.
    
    Returns:
    
    configuration parameter value.
  - isRuntimeConfig
```
public boolean isRuntimeConfig()
```
    Determines whether the Configuration is in conversion mode (configuration is read from the configuration directory) or server run time mode.
    
    Returns:
    
    true if it is a server run time mode (when configuration is NOT read from the configuration directory).
  - isDenormalizeDynamicTempTables
```
public boolean isDenormalizeDynamicTempTables()
```
    Check whether the extent properties in dynamic temp-tables should be denormalized. When this is enabled , the extent fields will NOT use secondary tables for SQL storage.
    
    Returns:
    
    true if the extent properties in dynamic temp-tables should be denormalized.
  - isFlagActivated
```
public boolean isFlagActivated(java.lang.String flag)
```
    If conditional rule-set is enabled, check if the given flag is activated.
    
    Parameters:
    
    flag - The flag to check.
    
    Returns:
    
    See above.
    
    See Also:
    
    PatternEngine.isFlagActivated(String)
  - isConditionalRuleSets
```
public boolean isConditionalRuleSets()
```
    Check if conditional rule-sets is activated.
    
    Returns:
    
    See above.
    
    See Also:
    
    PatternEngine.isConditionalRuleSets()
  - isRuntimeQueryMode
```
public boolean isRuntimeQueryMode()
```
    Check if the current mode is for runtime-conversion of query/tables.
    
    Returns:
    
    See above.
  - matchTokenType
```
private boolean matchTokenType(Aast node,
                               java.lang.Object[] types)
```
    Determine whether the token type of the specified node matches any of the given types.
    
    Parameters:
    
    node - An AST.
    
    types - Array of Integers representing valid token types. May be empty, must not be null.
    
    Returns:
    
    true if a match is detected, else false.
    
    Throws:
    
    java.lang.ClassCastException - if types contains any object type other than Integer.
  - fixupRegex
```
public java.lang.String fixupRegex(java.lang.String text)
```
    Fixing the regular expression string for special Windows requirement. Now it solves the backslash issue in Windows Java API call involving regular expression string. Does nothing if OS other than Windows.
    
    Parameters:
    
    text - Regular expression string to be adjusted acccording to OS special requirements.
    
    Returns:
    
    Specially modified regular expression string. Now doubles the backslash character containing in the input string.
  - fixupFileName
```
public java.lang.String fixupFileName(java.lang.String text)
```
    Fixing the file name for special Windows requirement. Now it substitutes the possible '/' character with backslash '\' to accept to Windows filename requirements. Does nothing if OS other than Windows.
    
    Parameters:
    
    text - The string representing the filename with path separator.
    
    Returns:
    
    Specially modified file name string. The Linux hardcoded '/' character replaced with '\' if current OS is Windows.
  - quoteReplacement
```
public java.lang.String quoteReplacement(java.lang.String text)
```
    Calling the java.util.regex.Matcher.quoteReplacement().
    
    Parameters:
    
    text - String to replace special characters. An examples: \ or $.
    
    Returns:
    
    The new string with added characters according to respecive Java API call documentation.
  - storeObject
```
public void storeObject(java.lang.String id,
                        java.lang.Object object)
```
    Store the given object under the given id. Can be retrieved later using PatternEngine.getStoredObject(String).
    
    Parameters:
    
    id - Arbitrary object id.
    
    object - Object to store.
  - storeObject
```
public void storeObject(java.lang.String category,
                        java.lang.String id,
                        java.lang.Object object)
```
    Store the given object under the given category and id. Can be retrieved later using PatternEngine.getStoredObject(String, String).
    
    Parameters:
    
    category - Arbitrary object category.
    
    id - Arbitrary object id.
    
    object - Object to store.
  - getStoredObject
```
public java.lang.Object getStoredObject(java.lang.String id)
```
    Get the object stored by the pattern engine under the given id.
    
    Parameters:
    
    id - Object's identifier.
    
    Returns:
    
    Stored object, or null if none.
  - getStoredObject
```
public java.lang.Object getStoredObject(java.lang.String category,
                                        java.lang.String id)
```
    Get the object stored by the pattern engine under the given category and id.
    
    Parameters:
    
    id - Object's identifier.
    
    Returns:
    
    Stored object, or null if none.
  - openStoredStream
```
public java.lang.Long openStoredStream(java.lang.String name)
```
    Opens a new in-memory stream for writing, associates an unique ID with that stream and stores it (can be retrieved later using PatternEngine.getStoredObject(String)). Note that ByteArrayOutputStream is stored under the given name, then this stream is wrapped with ByteCountOutputStream and the ID of ByteCountOutputStream is returned for using in rules pipeline.
    
    Parameters:
    
    name - Unique name of this stream under which it will be stored. Doesn't match returned ID.
    
    Returns:
    
    the unique ID associated with this stream.
  - compareNodes
```
public boolean compareNodes(Aast node1,
                            Aast node2)
```
    Check if two nodes are equivalent (if they represent the same expression so they will probably generate the same code. The nodes and their subnodes are walked recursively DFS and stop at first difference, if any.
    This feature was introduced because of the lack of support for recursive call in TRPL. At this moment only the type/text of the nodes and their subnodes are checked. Depending on necessities, the compare operation may be extended to annotations, too.
    
    Parameters:
    
    node1 - An Aast node to be check.
    
    node2 - Another Aast node to be check.
    
    Returns:
    
    true if the nodes are equivalent
  - withServicesFile
```
public void withServicesFile(java.lang.String filename)
```
    Mark this file 'with_services'.
    
    Parameters:
    
    filename - The file name.
  - createString2IntMap
```
public java.util.Map<?,?> createString2IntMap(java.lang.String name)
```
    Create a db-backed map, with a String key and an Integer value.
    For runtime conversion, a simple HashMap will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createMap(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)
  - createString2LongMap
```
public java.util.Map<?,?> createString2LongMap(java.lang.String name)
```
    Create a db-backed map, with a String key and a Long value.
    For runtime conversion, a simple HashMap will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createMap(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)
  - createString2StringMap
```
public java.util.Map<?,?> createString2StringMap(java.lang.String name)
```
    Create a db-backed map, with a String key and a String value.
    For runtime conversion, a simple HashMap will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createMap(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)
  - createStringSet
```
public java.util.Set<?> createStringSet(java.lang.String name)
```
    Create a db-backed set, with a String key.
    For runtime conversion, a simple TreeSet will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createSet(java.lang.Class<?>, java.lang.String)
  - createStringMapToStringMap
```
public java.util.Map<?,?> createStringMapToStringMap(java.lang.String name)
```
    Create a db-backed map, with a String key and as values another map, having String for both key and value.
    For runtime conversion, a simple HashMap will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createMapToMap(java.lang.Class<?>, java.lang.Class<?>, java.lang.Class<?>, java.lang.String)
  - createStringMapToStringSet
```
public java.util.Map<?,?> createStringMapToStringSet(java.lang.String name)
```
    Create a db-backed map, with a String key and as values another set, having String for key.
    For runtime conversion, a simple HashMap will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createMapToSet(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)
  - createStringMapToLongSet
```
public java.util.Map<?,?> createStringMapToLongSet(java.lang.String name)
```
    Create a db-backed map, with a String key and as values another set, having Long for key.
    For runtime conversion, a simple HashMap will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createMapToSet(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)
  - createMapAstKeyToString
```
public java.util.Map<?,?> createMapAstKeyToString(java.lang.String name)
```
    Create a db-backed map, with a AstKey key and String values.
    For runtime conversion, a simple HashMap will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createMap(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)
  - createMapAstKeyToInt
```
public java.util.Map<?,?> createMapAstKeyToInt(java.lang.String name)
```
    Create a db-backed map, with a AstKey key and Integer values.
    For runtime conversion, a simple HashMap will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createMap(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)
  - createMapFrameAstKeyToString
```
public java.util.Map<?,?> createMapFrameAstKeyToString(java.lang.String name)
```
    Create a db-backed map, with a FrameAstKey key and String values.
    For runtime conversion, a simple HashMap will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createMap(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)
  - createMapAstKeyToAst
```
public java.util.Map<?,?> createMapAstKeyToAst(java.lang.String name)
```
    Create a db-backed map, with a AstKey key and Aast values.
    For runtime conversion, a simple HashMap will be returned.
    
    Returns:
    
    See above.
    
    See Also:
    
    ConversionData.createMap(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)
  - setConvertedClassName
```
public void setConvertedClassName(java.lang.String filename,
                                  java.lang.String legacyName,
                                  java.lang.String pkgname,
                                  java.lang.String classname)
```
    For a given legacy class, set its converted Java name and package. .
    
    Parameters:
    
    filename - The associated file name.
    
    legacyName - The legacy fully qualified name.
    
    pkgname - The converted package name.
    
    classname - The simple Java class name.
  - forceMapValue
```
public void forceMapValue(java.util.Map<?,?> map,
                          java.lang.Object key,
                          java.lang.Object value)
```
    For the given db-backed map (if not in runtime conversion mode), force a logged change with the given key and value, for the currently processed AST. This is required to keep a history of changes, when (for a certain key) the value is semantically the same, but not the same object (for example, a temp-table AST node is saved in p2o.xml for each authoritative definition, but we need to keep track of all temp-table ASTs, in case the authoritative program gets re-converted).
    
    Parameters:
    
    map - The db-backed map.
    
    key - The key for which the value needs to be logged.
    
    value - The value which needs to be logged.
  - nextSequenceValue
```
public int nextSequenceValue(java.lang.String name)
```
    Get the next value for the given sequence.
    For runtime, it will use the sequences map to store them.
    
    Parameters:
    
    name - The sequence name.
    
    Returns:
    
    The next sequence value.
  - getAllClassesInPackage
```
public java.util.Set<java.lang.String> getAllClassesInPackage(java.lang.String pkg)
```
    Get the simple java class names for all classes in this package (builtin or converted code).
    
    Parameters:
    
    pkg - The package name.
    
    Returns:
    
    The set of simple java class names.
  - getConvertedSimpleClassName
```
public java.lang.String getConvertedSimpleClassName(java.lang.String qname)
```
    Get the converted simple class name for the specified fully-qualified 4GL class name.
    
    Parameters:
    
    qname - The qualified class name.
    
    Returns:
    
    The simple Java class name or null if it was not found.

Class CommonAstSupport.Library

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Library

Method Detail

getGapMarking

getGapMarking

loadConvertedClass

loadConvertedClassByQname

loadClassDefinition

endCurrentWalk

classForName

classForName

getMethod

invoke

declaresMember

getMethodNoCase

getMethodParamType

getResourceType

getClassSimpleName

returnsHandle

getLegacyName

create

create

createList

splitToList

createListFromObject

createSet

createMap

createUUID

getNow

getThis

getCopy

getAnalog

parseTree

loadTree

registerTree

getAst

getAst

removeAst

isAst

getType

setType

getName

getParent

getText

setText

getId

getFile

getPersistenceFilename

getLine

getColumn

getDepth

getPath

getTreeDump

getAncestorTreeDump

matches

matches

evalLib

execLib

eval

exec

root

leaf

getNumImmediateChildren

getNextChildIndex

imaginary

absolutePath

relativePath

upPath

downPath

ancestor

descendant

childAt

sibling

getLeftSiblings

getRightSiblings

getChildIndex