com.aspc.commander.sql

Class SQLCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

Direct Known Subclasses:

AddContactCommand, AddOnlineMemberCommand, AddRemoveContactCategoryCommand, AddWebOrder, AdminLoginResetCommand, ArtworkCommand, BestRowIdentifierCommand, BlankCommand, CacheCommand, CatalogCommand, CheckDirectDebitStatusCommand, CheckWorkHours, ColumnPrivilegesCommand, ColumnsCommand, CommitCommand, ConvertDBEmailToTask, CopyCommand, CopyTaskTemplate, CreateComponentCommand, CreateEmailCommand, CreateOrderCommand, CreatePurchaseOrderCommand, CreateSalesCycleCommand, CreateTaskCommand, CreditInvoiceCommand, CrossReferenceCommand, DBLogicalLockCommand, DeleteCommand, DeleteQuoteProduct, DeletProduct, DiscoverCommand, DroidCommand, EditionCommand, EmailCheckCommand, EmailScreenCommand, EventRegistrationCommand, EwayCreditProcessingCommand, ExportCommand, ExportedKeysCommand, ExtMyobInitialSync, FileCommand, FileSyncCommand, FileSyncManualCommand, ForgotPasswdCommand, GenerateTaskSeriesCommand, GetConferenceCommand, GetOnlineMemberCommand, HealthCommand, ICalendarCommand, ImportCommand, ImportedKeysCommand, IndexInfoCommand, InsertCommand, InvoiceCommand, JobCommand, JobDailyReport, JobWeeklyReport, LoadEmployerDeductionCommand, LogCommand, LogLocationErrorCommand, MagicCommand, MapCommand, MemberRenewalCommand, MemberRsvpEventCommand, MembershipAuditCommand, MemoryCommand, MergeCommand, MessageCommand, MoveComponentCommand, MYOBImportCommand, NotifyCommand, OnlineAccountCommand, PasswdCommand, PreferenceCommand, PrimaryKeysCommand, ProcedureColumnsCommand, ProceduresCommand, ProcessCommand, ProcessDirectDebitCommand, ProcessEmailSend, ProductItemRecurringCommand, PullLDArtworks, RaiseEventCommand, RecordNoticeSentCommand, RecordOnlineSub, RecordValidateCommand, ReindexFilesCommand, ReloadCommand, RenewalCommand, ReportCommand, RestCommand, RetrieveLogCommand, ReverseCommand, ReverseCreditEftosBatch, RollbackCommand, RunMembershipAccountingFigures, RunMembershipAccountingFiguresV2, SavePointCommand, ScanRFQTSDocsFolder, SchedulerPreferencesCommand, SchemaCommand, SelectCommand, SendActivityReport, SendEmailPage, SendEmailPageV2, SendNoticeCommand, SendSmsCommand, SequenceCommand, ShutdownCommand, SiteSpiderCommand, SleepCommand, SleepTestCommand, SnapToCommand, SplitBuildPestReport, SqlPagingCommand, StatsPartCommand, StoredResultCommand, StoreWordsCommand, SuperTablesCommand, SuperTypesCommand, SyncCommand, TablePrivilegesCommand, TablesCommand, TaskCommand, TasksByStatusChart, TaskStatusJournalChart, TasksWinLoseChart, TaskTagsCommand, TeamJobWeeklyReport, TransactionCommand, TransactionLogCommand, UpdateCommand, UpdateCreditCardDetailsCommand, UpdateKeywordCommand, UpdateMembersCommand, UpdateOnlineMemberCommand, UpdatePaymentStatusCommand, ValidateCommand, VCardCommand, VersionColumnsCommand, WordsExtractorCommand

public abstract class SQLCommand
extends Command
implements CommandBuildResultsPlugin

Parse SQL like statements to implement in terms of DBObjects
THREAD MODE: SINGLE THREADED command

Since:

3 December 2003

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static int	CURSOR_SIZE The default cursor size

Constructor Summary

Constructors

Constructor and Description
SQLCommand(Connection connection, Pattern pattern) The base class for all commands that return a record set.

Method Summary

Modifier and Type	Method and Description
void	appendResult(org.w3c.dom.Element group, int seq) append the result set to a result group.
void	appendResult(org.w3c.dom.Element group, int offset, int size, java.lang.String cursorName, int seq) Append a result set to a result group for a cursor.
java.lang.String	getCursorName() Returns the name for the current cursor
java.lang.String	getRecordKey(int row) Not mandatory to supply a key for the row as well.
boolean	isExecuteOnly() is this defined ( JDBC spec) to be execute only

Methods inherited from class com.aspc.commander.Command

execute, execute, extMakeThreadName, getConnection, getPattern, getRawTitle, getTitle, makeThreadName, recordCall, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspc.commander.sql.results.CommandBuildResultsPlugin

getColumnName, getColumnType, getRawTitle, getRecordID, getValue

Field Detail

CURSOR_SIZE

public static final int CURSOR_SIZE

The default cursor size

See Also:

Constant Field Values

Constructor Detail

SQLCommand

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

The base class for all commands that return a record set.

Parameters:

connection - The current connection

pattern - The command pattern

Method Detail

appendResult

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

append the result set to a result group.

Specified by:

appendResult in class Command

Parameters:

group - The XML Element for the result group

seq - The sequence in the result group.

Throws:

java.lang.Exception - A serious problem.

appendResult

public final void appendResult(org.w3c.dom.Element group,
                               int offset,
                               int size,
                               java.lang.String cursorName,
                               int seq)
                        throws java.lang.Exception

Append a result set to a result group for a cursor.

Parameters:

group - The XML Element for the result group

offset - The row offset

size - The number of rows to append

cursorName - The cursor name to use

seq - The sequence number in the result group.

Throws:

java.lang.Exception - A serious problem.

getRecordKey

public java.lang.String getRecordKey(int row)

Not mandatory to supply a key for the row as well. If not the ID will be used.

Specified by:

getRecordKey in interface CommandBuildResultsPlugin

Parameters:

row - The row number ( offset from 1)

Returns:

The record key

getCursorName

public java.lang.String getCursorName()
                               throws java.lang.Exception

Returns the name for the current cursor

Specified by:

getCursorName in interface CommandBuildResultsPlugin

Returns:

The value

Throws:

java.lang.Exception - A serious problem

isExecuteOnly

public boolean isExecuteOnly()

is this defined ( JDBC spec) to be execute only

Specified by:

isExecuteOnly in interface CommandBuildResultsPlugin

Returns:

true if execute only