com.oberon.ooql.sdk
Class OOQLCommand

java.lang.Object
  com.oberon.ooql.sdk.OOQLCommand

public class OOQLCommand
extends java.lang.Object

Basic class for executing OBEROn OOQL commands

Version:

5.0

Constructor Summary

OOQLCommand(java.lang.String command)
Constructor for a new OOQL command

Method Summary

java.util.Vector<java.lang.String>	execute(Framework framework) Execute the OOQL command for the input user Framework
java.lang.String	execute1(Framework framework) Execute a single OOQL command.
java.lang.String	getCommand() Return the OOQL command text
java.util.Vector<int[]>	getCommandCoords() Get the command text coordinates for each OOQL command in the text
java.lang.String	getResultLog() Return the execution log with additional information
java.lang.String	parse(Framework framework) Parse the OOQL command text

Methods inherited from class java.lang.Object

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

Constructor Detail

OOQLCommand

public OOQLCommand(java.lang.String command)

Constructor for a new OOQL command

Parameters:

command - the OOQL command

Method Detail

execute

public java.util.Vector<java.lang.String> execute(Framework framework)
                                           throws OberonException,
                                                  com.oberon.ooql.parser.ParserLogException,
                                                  com.oberon.ooql.parser.ParserCreationException

Execute the OOQL command for the input user Framework

Returns:

a Vector of results: the command text can include multiple OOQL commands ( each command ends with ";" ), the number of vector elements are equal to the number of commands and represents the result for each of them.

Throws:

com.oberon.ooql.parser.ParserLogException - when the command syntax is not correct

com.oberon.ooql.parser.ParserCreationException - when the command syntax is not correct

OberonException

execute1

public java.lang.String execute1(Framework framework)
                          throws OberonException

Execute a single OOQL command. If the command text includes multiple commands, only the first result is returned, even if all commands are executed

Throws:

OberonException

parse

public java.lang.String parse(Framework framework)
                       throws OberonException,
                              com.oberon.ooql.parser.ParserLogException,
                              com.oberon.ooql.parser.ParserCreationException

Parse the OOQL command text

Returns:

a report representing the OOQL language parsed tree

Throws:

OberonException

com.oberon.ooql.parser.ParserLogException

com.oberon.ooql.parser.ParserCreationException

getCommand

public java.lang.String getCommand()

Return the OOQL command text

getResultLog

public java.lang.String getResultLog()

Return the execution log with additional information

getCommandCoords

public java.util.Vector<int[]> getCommandCoords()

Get the command text coordinates for each OOQL command in the text

Returns:

Vector of int[4]{startLine,startColumn,endLine,endColumn}