com.technia.tvc.core.db.util

Class MQLCommand

java.lang.Object

com.technia.tvc.core.db.util.MQLCommand

public class MQLCommand
extends java.lang.Object

Represents a parsed MQL command with placeholders. For example:

• print person ? select property[?].value dump
• list property name ? on person ?

Since:

2009.1, 2012.1.0 Rewrote this class due to buggy behavior.

Constructor Summary

Constructors

Constructor and Description
MQLCommand(java.lang.String pattern)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Tests the equality of this instance.
java.lang.String	execute(java.lang.String... args) Executes this command and substitutes the ? characters with arguments from the provided argument array.
java.lang.String	executePrivileged(boolean inCurrentTransaction, java.lang.String... args) Executes this command with privileged rights and substitutes the ? characters with arguments from the provided argument array.
java.lang.String	executePrivileged(java.lang.String... args) Executes this command with privileged rights and substitutes the ? characters with arguments from the provided argument array.
int	getArgCount()
java.lang.String	getCommand(java.lang.String... args) Returns the command and substitutes the ? characters with arguments from the provided argument array.
int	hashCode()
static void	main(java.lang.String[] args)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MQLCommand

public MQLCommand(java.lang.String pattern)

Method Detail

getArgCount

public int getArgCount()

Returns:

The number of arguments this command requires

Since:

2012.1.0

execute

public java.lang.String execute(java.lang.String... args)
                         throws TVCException

Executes this command and substitutes the ? characters with arguments from the provided argument array.

Parameters:

args - The arguments to use for replacement of ? characters

Returns:

The result of the MQL command

Throws:

TVCException - If unable to execute the command for any reason.

executePrivileged

public java.lang.String executePrivileged(java.lang.String... args)
                                   throws TVCException

Executes this command with privileged rights and substitutes the ? characters with arguments from the provided argument array.

Note: The command is executed with privileged rights outside of any transaction so be aware of the scope of your transaction.

To run the command with privileged rights within the current transaction, use the method executePrivileged(boolean, String...) instead.

Parameters:

args - The arguments to use for replacement of ? characters

Returns:

The result of the MQL command

Throws:

TVCException - If unable to execute the command for any reason.

executePrivileged

public java.lang.String executePrivileged(boolean inCurrentTransaction,
                                          java.lang.String... args)
                                   throws TVCException

Executes this command with privileged rights and substitutes the ? characters with arguments from the provided argument array.

The first argument specifies if the command should be executed within any current ongoing transaction or outside of that scope.

Parameters:

inCurrentTransaction - True to run the MQL command within the current transaction boundary.

args - The arguments to use for replacement of ? characters

Returns:

The result of the MQL command

Throws:

TVCException - If unable to execute the command for any reason.

getCommand

public java.lang.String getCommand(java.lang.String... args)

Returns the command and substitutes the ? characters with arguments from the provided argument array.

Parameters:

args - The arguments to use for replacement of ? characters

Returns:

A command that can be executed through MQL.

Since:

2012.1.0

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this instance. E.g. the pattern itself.

equals

public boolean equals(java.lang.Object o)

Tests the equality of this instance. This method returns true if the object to compare against are of the same type and holds the exact same pattern.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code based upon the command pattern.

main

public static void main(java.lang.String[] args)