Standard Functions and Variables

Function/Variable Description
i * j Integer multiplication
i + j Integer addition
x ++ y Appends two 'compatible' items together e.g. Strings, Maps etc
i - j Integer subtraction
i div j Integer division (gives a round number)
i mod j Integer division (gives the remainder)
x /= y Structural inequality
x /== y Not identical
i < j Numerical less-than
i <= j Numerical less-than or equals
x = y Structural equality
x == y Identity
x > y Numerical greater-than
x >= y Numerical greater-than or equal
absent Constant
addLast( list, item ) Adds item to the end of a (modifiable) list
attribute( e, name ) Returns value of name/attribute pair of element e
attributesMap( e ) Returns entire name/value mapping of an element e
bindingMatched( Binding ) Returns the sub-section of the original string this binding matched
bindingMatchedLimits( Binding ) Returns the start and end indices of the matched section of the original string
bindingMatchVar( Binding, Int ) Returns the specified match variable
bindingMatchVarCount( Binding ) Returns the number of match variables in the binding
bindingMatchVarLimits( Binding, Int ) Returns both the start and end indices of the match variable in the original string
bindingOriginalRegEx( Binding ) Returns the original regular expression used to match
bindingOriginalString( Binding ) Returns the original string matched against
cacheFile( fname ) Returns saved item from a file
cacheFile( fname ) := item Saves item to a file
charCode( c ) Returns character code (integer) of character c
children( e ) Returns all the children of an element
className( object ) Returns the Java class name of the supplied object
clone( item ) Returns a copy of an item
cmpNumString( x, y ) Returns -1,0,1 if x<y, x=y,x>y respectively - after converting x & y to numbers
cmpString( x, y ) Returns -1,0,1 if string x precedes y, is equal to y, or follows y respectively
commentText( c ) Returns the text content of an XML comment c
dataFile( fname, list ) Creates a datafile fname from a list of lists
dateDate( d ) Returns date field of a Date d
dateMonth( d ) Returns month field of a Date d
dateYear( d ) Returns year field of a Date d
deltaChildrenList( e, list ) Returns a new XML element with the same name and attributes as e, but with list as it's children
explode( item ) Returns all the components of an item
false Constant
findFullMatch( RegEx, String ) Returns a Binding if the regular expression matches the entire string, absent otherwise
findMatch( RegEx, String ) Returns a Binding if the regular expression matches part of the string, absent otherwise
findPrefixMatch( RegEx, String ) Returns a Binding if the regular expression matches the start of the string, absent otherwise
findSuccessiveMatches( RegEx, String ) Returns a list of all successive bindings resulting from matching the regular expression against the string
findSuffixMatch( RegEx, String ) Returns a Binding if the regular expression matches the end of the string, absent otherwise
folder Variable: bound to a list of strings used to construct the current effective directory
format( fmt, args ... ) Formatted printing to a new string (like sprintf with a newly allocated string)
functionName( function ) Returns the name of the specified function
getCharSet() Returns the name of the current output character set
getDefault( map ) Returns the default value for this map
group( rset, field, ... ) Groups a result set by a field or fields by returning a map from that field to subsets of the result set
groupPreserveOrder( rset, field, ... ) Provides the same functionality as the normal group function, but preserves the order of the original result set. i.e. The order of the keys in the resulting map follows the order of that field in the result set.
homeDir Variable: contains the home directory
htmlFile( fname, e ) Renders an element e as an entire HTML page to a file fname
htmlFragmentFile( fname, e ) Renders an HTML fragment e to a file fname
indexByPrimaryKey( rset, field ) Indexes a result set by a field to return a map from field values to records
isComment( item ) Returns true if the item is an XML comment
isElement( item ) Returns true if item is an Element
isFullMatch( RegEx, String ) Returns true if the regular expression matches the entire string
isList( item ) Returns true if item is a list
isMatch( RegEx, String ) Returns true if the regular expression matches part of the string
isMap( item ) Returns true if item is a map
isPrefixMatch( RegEx, String ) Returns true if the regular expression matches the start of the string
isString( item ) Returns true if item is a string
isSuffixMatch( RegEx, String ) Returns true if the regular expression matches the end of the string
javaConstructor( cName, pType, ... ) Imports a java constructor which is returned as a function
javaFunction( cName, mName, pType, ... ) Imports a Java method which is returned as a function
javaRecognizer( cName ) Returns a function that can recognize instances of a Java class and its subclasses
join( String, { String } ) Returns a string made by concatenating the list of strings and separating them by the given separator string
joinByPrimaryKey( rest1, rest2, field ) Joins rset1 to rset2 by matching values of the specified field
length( item ) Returns the length of Strings, Maps, Lists, etc
linesFile( fname, list ) Renders a list of strings into a file of lines
makeDirectory Creates a directory in the output folder based on the contents of the folder variable
mapKeys( map ) Returns all the keys of a map
mapKeysList( map ) Returns a list of the keys of a map
mapValues( map ) Returns all the values of a map
mapValuesList( map ) Returns a list of the values of a map
mishap( string, string | list | map | maplet* ) Generates a mishap, causing the script to stop. The reported error will be constructed from the mishap arguments
modDefault( map, item ) Returns the map, with it's default value set to item
newArrayList( item, ... ) Returns a new modifiable List implemented on top of an array, initialized with the items
newHashMap( map|list|maplet, ... ) Returns a new Map, implemented via a Hashtable, initialized from the maps, name-value lists or maplets supplied
newLinkedHashMap( map|list|maplet, ... ) Returns a new Map, implemented via a LinkedHashMap, which is a HashMap with a doubly linked list defining the iteration order. The map is initialized with the items supplied.
newLinkedList( item, ... ) Returns a new modifiable list implemented via a doubly linked list, initialized with the items supplied
newList( item, ... ) Returns a new modifiable map, the implementation chosen by the compiler, initialized with the items supplied.
newLiteList( item, ... ) Returns a new unmodifiable list implemented via an array initialized with the items supplied.
newMap( map|list|maplet, ... ) Returns a new Map, the implementation chosen by the compiler, initialized from maps, name-value lists or maplets supplied
newMaplet( key, value ) Returns a new Maplet, initialized with the key and value supplied.
newPage
newTreeMap( map|list|maplet, ... ) Returns a new Map, implemented via sorted tree, initialized from maps, name-value lists and maplets supplied
newVector( item, ... ) Returns a new modifiable List, implemented as a Vector, initialized from the items supplied
newWeakHashMap( map|list|maplet, ... ) Returns a new Map, implemented via a weak Hashtable, initialized from the maps, maplets and name-value lists supplied
print( item, ... ) Prints items - used to prepare formatted output
println( item, ... ) Prints items and a newline - used for preparing formatted output
relative( page ) Returns a relative URL to the page, based on the current effective directory(folder)
list.removeLast() Removes the last item from a modifiable list
setCharSet( string ) Sets the current output character set to one with the name string
setDefault( map, item ) Sets the default value for the map to item
show( item ) Programmer oriented printing
showLim( item, length ) Programmer oriented printing, limited to length characters
showln( item ) Programmer oriented printing
showlnLim( item, length ) Programmer oriented printing, limited to length characters
sort( list, cmp ) Returns a new sorted list, uses cmp to decide order
sortBy( list, field, cmp ) Returns a new sorted list, sorted on the indexed field using the comparison function cmp
split( RegEx, String ) Returns all the tokens in the string, split on the supplied regular expression
splitString( string, delim ) Returns all the tokens in the string, split on the supplied delimiter
stringFile( fname, string ) Prints a string to a file
stringToFragment( string ) Returns all the fragments in the string after parsing it as XML
substituteAll( string1, string2, string3 ) Returns a copy of string1, with all instances of string2 replaced with string3
toDate( string ) Converts a FileMaker date string to a Date object
toNumber( string ) Converts a number to a string
toString( item ) Prints item to create a new String
toUpperCase( string ) Returns an upper case version of a string
true Constant
urlEncode( string ) Returns a URL encoded version of a string
xmlFile( fname, e ) Renders element e to file fname as XML
xmlFragmentFile( fname, e, ... ) Renders element e and others to file fname as a fragment of an XML document
xsltFile( fname, e ) Renders element e to file fname as XSLT
xsltFragmentFile( fname, e, ... ) Renders element e and others to file fname as a fragment of an XSLT document