com.aspc.commander

Class Command

java.lang.Object

com.aspc.commander.Command

Direct Known Subclasses:

CursorCommand, MultiResultCommand, SQLCommand

public abstract class Command
extends java.lang.Object

Parse SQL like statements to implement in terms of DBObjects
THREAD MODE: SINGLE THREADED command A command is single usage and maintains state of the user's request.

Since:

3 December 2003

Author:

Nigel Leck

Constructor Summary

Constructors

Constructor and Description
Command(Connection connection, Pattern pattern) Std.

Method Summary

Modifier and Type	Method and Description
abstract void	appendResult(org.w3c.dom.Element group, int seq) Append the result to the result group.
void	execute(DBCommand dbCommand, java.lang.String isql) Execute this text.
protected abstract void	execute(Parser p) execute the command.
protected java.lang.String	extMakeThreadName(java.lang.String sql) OVERRIDE THIS METHOD: to change sql text that is used to set the thread name.
Connection	getConnection() The connection for this command.
Pattern	getPattern() The pattern for this command.
java.lang.String	getRawTitle() Get the raw/original title.
java.lang.String	getTitle() Get the current title.
java.lang.String	makeThreadName(java.lang.String sql) OVERRIDE THIS METHOD: to change sql text that is used to set the thread name.
protected void	recordCall(Parser p, long start, long allocatedTime, DataSource ds) OVERRIDE THIS METHOD: To alter the recording of the command call statistics
void	setTitle(java.lang.String title) Set the title of this command.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(@Nonnull
               Connection connection,
               @Nonnull
               Pattern pattern)

Std. Command

Parameters:

connection - The connection

pattern - The command pattern

Method Detail

appendResult

public abstract void appendResult(org.w3c.dom.Element group,
                                  int seq)
                           throws java.lang.Exception

Append the result to the result group.

Parameters:

group - The result group to be appended to

seq - The sequence number of the result set

Throws:

java.lang.Exception - A serious problem

getPattern

@CheckReturnValue
 @Nonnull
public Pattern getPattern()

The pattern for this command.

Returns:

The pattern

getConnection

@CheckReturnValue
 @Nonnull
public Connection getConnection()

The connection for this command.

Returns:

The connection

makeThreadName

public final java.lang.String makeThreadName(java.lang.String sql)

OVERRIDE THIS METHOD: to change sql text that is used to set the thread name.

Parameters:

sql - The sql that will be processed.

Returns:

The thread name.

extMakeThreadName

@Nonnull
protected java.lang.String extMakeThreadName(@Nonnull
                                                      java.lang.String sql)

OVERRIDE THIS METHOD: to change sql text that is used to set the thread name.

Parameters:

sql - The sql that will be processed.

Returns:

The thread name.

execute

public final void execute(@Nonnull
                          DBCommand dbCommand,
                          java.lang.String isql)
                   throws java.lang.Exception

Execute this text.

Parameters:

isql - the sql to execute

dbCommand - the command

Throws:

java.lang.Exception - A serious problem

recordCall

protected void recordCall(Parser p,
                          long start,
                          long allocatedTime,
                          DataSource ds)

OVERRIDE THIS METHOD: To alter the recording of the command call statistics

Parameters:

p - The command

start - When the command started.

allocatedTime - the allocated time

ds - the data source

setTitle

public void setTitle(java.lang.String title)

Set the title of this command.

Parameters:

title - The title.

getTitle

@CheckReturnValue
 @Nonnull
public java.lang.String getTitle()

Get the current title.

Returns:

The title.

getRawTitle

@CheckReturnValue
 @Nonnull
public java.lang.String getRawTitle()

Get the raw/original title.

Returns:

The raw title.

execute

protected abstract void execute(@Nonnull
                                Parser p)
                         throws java.lang.Exception

execute the command.

Parameters:

p - The actual command.

Throws:

java.lang.Exception - A serious problem