com.technia.tvc.core.db

Class MQLUtils

java.lang.Object

com.technia.tvc.core.db.MQLUtils

public final class MQLUtils
extends java.lang.Object

Some useful methods concerning MQLCommand objects.

Method Summary

Modifier and Type	Method and Description
static void	closeCommand(matrix.db.MQLCommand cmd) Closes the specific command.
static java.lang.String	doPrivilegedMQL(java.lang.String mql) Executes the specified MQL with the super user context and returns the result.
static java.lang.String	escapeString(java.lang.String str) Escapes the characters ", ', and \ in the specified string.
static java.lang.String	executeCommand(matrix.db.MQLCommand mql, java.lang.String command) Executes the specified command using the provided context and mql-command object.
static TxAction<java.lang.String>	getMQLAction(java.lang.String mql) Returns a TxAction instance that will run the specified MQL command and return the result as a String once executed.
static java.lang.String	getRPEVar(java.lang.String name, boolean global) Returns the RPE variable
static java.lang.String	getSetRPEVarsCommand(java.util.Map<java.lang.String,java.lang.String> data, boolean global)
static boolean	isAllowMultipleMQLCommandExecution() Detects the mode we use when listing / printing properties.
static java.lang.String	mql(java.lang.String mql) Executes the specified MQL and returns the result.
static java.lang.String[]	mql(java.lang.String[] mql) Executes the specified MQL commands and returns the results.
static java.lang.String	mqlf(boolean historyOff, boolean triggerOff, java.lang.String format, java.lang.String... args)
static java.lang.String	mqlf(java.lang.String format, java.lang.String... args)
static boolean	mqlfAvailable()
static matrix.db.MQLCommand	openCommand() Creates a new MQLCommand instance and opens it.
static java.lang.String	quoteString(java.lang.String s) Encloses the specified string within quote characters.
static void	setRPEVars(java.util.Map<java.lang.String,java.lang.String> data, boolean global) Sets the names and their respective value as a RPE (Runtime Program Environment) variable.
static java.lang.String[]	splitString(java.lang.String str, char delim) Splits the string by the specified delimeter.
static java.lang.String	staticMql(java.lang.String mql) Performs a static MQL call, where the result of the command may be cached and reused for later calls.
static java.lang.String	tcl(java.lang.String tcl) Executes the specified TCL and returns the result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isAllowMultipleMQLCommandExecution

public static boolean isAllowMultipleMQLCommandExecution()

Detects the mode we use when listing / printing properties.

Returns:

True if we should use "quote on;list properties on TYPE NAME", false for doing "print TYPE NAME select property.* dump tcl"

Since:

2014.1.0

staticMql

public static java.lang.String staticMql(java.lang.String mql)
                                  throws TVCException

Performs a static MQL call, where the result of the command may be cached and reused for later calls.

NOTE: Only MQL commands where the result expects to be equal upon repeating calls, should be executed via this method !!!!!!! Otherwise, VERY suspicious behavior will appear !!

Parameters:

mql - The MQL statement

Returns:

The result

Throws:

TVCException

Since:

5.0

doPrivilegedMQL

public static java.lang.String doPrivilegedMQL(java.lang.String mql)
                                        throws TVCException

Executes the specified MQL with the super user context and returns the result. If an error occurs a TVCException is raised. Please note that this method will run in a separate Context (thus, a separate transaction). I.e., any modifications in the database will not be visible in the current Context if a transaction is active.

This method simply does:

 TxManager.doPrivileged(new TxAction() {

     public Object run() throws Exception {
         return MQLUtils.mql(mql);
     }
 });
 

Parameters:

mql - the command to execute.

Returns:

the result of the command.

Throws:

TVCException - If an error occurs upon executing the command

Since:

6.2.1

getMQLAction

public static TxAction<java.lang.String> getMQLAction(java.lang.String mql)

Returns a TxAction instance that will run the specified MQL command and return the result as a String once executed.

Parameters:

mql - The mql to execute.

Returns:

A TxAction that till run the specified MQL command.

Since:

6.3.0

mql

public static java.lang.String mql(java.lang.String mql)
                            throws TVCException

Executes the specified MQL and returns the result. If an error occurs a TVCException is raised.

Parameters:

mql - the command to execute.

Returns:

the result of the command.

Throws:

TVCException - if an error occurs upon executing the command.

mql

public static java.lang.String[] mql(java.lang.String[] mql)
                              throws TVCException

Executes the specified MQL commands and returns the results. If an error occurs a TVCException is raised. The commands will be executed one at a time.

Parameters:

mql - the commands to execute.

Returns:

the results of the commands.

Throws:

TVCException - if an error occurs upon executing the commands.

tcl

public static java.lang.String tcl(java.lang.String tcl)
                            throws TVCException

Executes the specified TCL and returns the result. If an error occurs a TVCException is raised.

Parameters:

tcl - the TCL to execute.

Returns:

the result of the TCL.

Throws:

TVCException - if an error occurs upon executing the TCL.

mqlfAvailable

public static boolean mqlfAvailable()

mqlf

public static java.lang.String mqlf(java.lang.String format,
                                    java.lang.String... args)
                             throws TVCException

Throws:

TVCException

mqlf

public static java.lang.String mqlf(boolean historyOff,
                                    boolean triggerOff,
                                    java.lang.String format,
                                    java.lang.String... args)
                             throws TVCException

Throws:

TVCException

executeCommand

public static java.lang.String executeCommand(matrix.db.MQLCommand mql,
                                              java.lang.String command)
                                       throws TVCException

Executes the specified command using the provided context and mql-command object. If the command results in error a TVCException is thrown.

Parameters:

mql - the mql-command object.

command - the command string.

Returns:

the result of the command.

Throws:

TVCException - if failed to execute the command.

openCommand

public static matrix.db.MQLCommand openCommand()
                                        throws TVCException

Creates a new MQLCommand instance and opens it.

Returns:

the new and opened MQLCommand object.

Throws:

TVCException

closeCommand

public static void closeCommand(matrix.db.MQLCommand cmd)

Closes the specific command.

Parameters:

cmd - the command object to close.

quoteString

public static java.lang.String quoteString(java.lang.String s)

Encloses the specified string within quote characters. If the string is empty "" will be returned. If the string contains a quote <">, this method will return a string quoted with '.

Parameters:

s - the string to quote.

splitString

public static java.lang.String[] splitString(java.lang.String str,
                                             char delim)

Splits the string by the specified delimeter.

The differences between this method and the one defined in StringUtils is that this method will return empty string array elements if two delimeters follow each other. For example:

 String[] s = MQLUtils.split("a|b||d|e|", '|');
 for (int i = 0; i < s.length; i++) {
     System.out.println("\"" + s[i] + "\"");
 }
 

Produces the output:

   "a"
   "b"
   ""
   "d"
   "e"
   ""
 

escapeString

public static java.lang.String escapeString(java.lang.String str)

Escapes the characters ", ', and \ in the specified string. If the string doesn't contain any of these characters it is returned unchanged.

The purpose of this method is to escape arguments used in MQL commands beginning with the escape keyword. Example:

 String expr = "(type == \"Part\") && (revision == last)";

 String mqlStr = "escape evaluate expression \"" + MQLUtils.escapeString(expr) + "\" on businessobject "
         + objectId;

 String result = MQLUtils.mql(ctx, mqlStr);
 

getRPEVar

public static java.lang.String getRPEVar(java.lang.String name,
                                         boolean global)
                                  throws TVCException

Returns the RPE variable

Parameters:

name - The name of the variable

global - True for global

Returns:

The value of the variable.

Throws:

TVCException

Since:

5.2.2

setRPEVars

public static void setRPEVars(java.util.Map<java.lang.String,java.lang.String> data,
                              boolean global)
                       throws TVCException

Sets the names and their respective value as a RPE (Runtime Program Environment) variable.

Parameters:

data - The Map containing the variables to be set.

global - True for global.

Throws:

TVCException - If unable to set the RPE vars.

getSetRPEVarsCommand

public static java.lang.String getSetRPEVarsCommand(java.util.Map<java.lang.String,java.lang.String> data,
                                                    boolean global)

Parameters:

data -

global -

Returns:

The result of the command setting the rpe variables as a String

Since:

2012.3.0