Package org.quattor.pan.dml.functions

Includes classes that implement all of the pan language build-in functions.

See: Description

Class Summary

Class	Description
AbstractMatcher	Determine whether a string matches a given regular expression, using optional matching flags.
AbstractStaticMatcher	Determine whether a string matches a given regular expression, using optional matching flags.
AbstractVariableMatcher	Abstract class to bring together checks done for both match() and matches().
Append	Will append a value to the end of a list.
Base64Decode	Decodes a Base64-encoded string.
Base64Encode	Encodes a string into its Base64 representation.
BuiltInFunction	This is just a marker class to identify those classes that are built-in functions in the pan language.
Clone	This function will clone the given element.
Create	Creates an dict from the named structure template.
Debug	Prints the argument to the standard error stream.
DebugSuppressed	This is a suppressed debug() function call.
Delete	Deletes the variable referenced in the function's argument.
Deprecated	Prints the argument to the standard error stream if the given level is less than or equal to the deprecation level option.
Digest	Creates a digest of a string using the specified algorithm.
ErrorMessage	Implements the error function that prints its argument to the standard error stream and then aborts the compilation of the object profile.
Escape	Escape an arbitrary string so that it can be used as a key for a dict.
Exists	Tests whether the variable referenced in the function's argument exists.
FileContents	Searches for a file on the load path and reads the contents of the file into a String if found.
FileExists	Searches for a file on the load path and returns true if the file is found.
First	Initializes an iterator for the named resource and sets the variable arguments to the values of the first entry.
Format	Produces a formatted string based on the given format specification and arguments.
Function	Implements a function call to a user defined function.
Hash	Creates a dict from the function's arguments.
IfExists	This tests if the given template exists.
Index	Determines the index for a substring within a string or a value within a Resource.
IpToLong	Produces the binary representation of an IPv4 address, maybe with the binary representation of the network mask part of the string.
IsBoolean	Wrapper that creates an is_boolean function call from the IsOfType class.
IsDefined	Wrapper that creates an is_defined function call from the IsOfType class.
IsDouble	Wrapper that creates an is_double function call from the IsOfType class.
IsHash	Wrapper that creates an is_dict function call from the IsOfType class.
IsList	Wrapper that creates an is_list function call from the IsOfType class.
IsLong	Wrapper that creates an is_long function call from the IsOfType class.
IsNull	Wrapper that creates an is_null function call from the IsOfType class.
IsNumber	Wrapper that creates an is_number function call from the IsOfType class.
IsOfType	This is the parent class for those classes that implement the type checking functions of pan (e.g.
IsProperty	Wrapper that creates an is_property function call from the IsOfType class.
IsResource	Wrapper that creates an is_resource function call from the IsOfType class.
IsString	Wrapper that creates an is_string function call from the IsOfType class.
IsValueOfType	Tests whether the given value (may be a calculated value via a DML block) is a particular type.
IsVariableOfType	Tests if the given variable reference is of the given class.
Key	Returns the key associated with the entry given by the index.
Length	Returns the length of a string or the size of a resource.
List	Create a list from the function's arguments.
LongToIp	Produces a string representing an IPv4 address in dotted format from a long
Match	Determine whether a string matches a given regular expression, using optional matching flags.
Matches	Returns a list of the matched groups for a given regular expression against a given string.
Merge	Combine the contents of two resources.
Next	Increment the iterator associated with the given resource.
PathExists	Tests whether or not the given path exists.
Prepend	Will prepend a value to the beginning of a list.
Replace	Replace occurrences of a regular expression with a given string.
Return	Sets the result of a DML block to the function's argument and immediately leaves the innermost function call or DML block.
Splice	Splice two resources or strings.
Split	Replace occurrences of a regular expression with a given string.
StaticMatch	Determine whether a string matches a given regular expression, using optional matching flags where the regular expression and match flags are compile time constants.
StaticMatches	Returns a list of the matched groups for a given regular expression against a given string where the regular expression and match flags are compile time constants.
StringExists	Tests that the path or template name exists.
Substitute	Produces a formatted string based on the given format specification and dictionary of arguments
Substr	Extract a substring from a string.
ToBoolean	Convert the function's argument to a boolean value.
ToDouble	Convert the function's argument to a double value.
ToLong	Convert the function's argument to a long value.
ToLongRadix	Convert the function's argument to a long value using the given radix.
ToLowerCase	Convert a string entirely to lowercase.
ToString	Convert the function's argument to a string value.
ToUpperCase	Convert a string entirely to lowercase.
Traceback	Print the traceback from the current point in the execution to the standard error stream.
TracebackSuppressed	Suppressed traceback call.
Unescape	Unescape a string that was previously escaped with the escape function.
Value	Extract a value from the configuration tree based on a given path.
VariableExists	Tests whether a particular variable reference exists.

Package org.quattor.pan.dml.functions Description

Includes classes that implement all of the pan language build-in functions.