com.aspc.message

Class MessageCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.message.MessageCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class MessageCommand
extends SQLCommand

List all the messages into a XML file so that they can be used by an extenal program.
Syntax

  MESSAGE GENERATE [PATH file_path] [WHERE clause]
  

Usage

  /* create a message file for all messages. */
  MESSAGE GENERATE PATH remote/messages.xml
  

THREAD MODE: SINGLE THREADED command

Since:

23 October 2005

Author:

Mei Xiao

Field Summary

Fields inherited from class com.aspc.commander.sql.SQLCommand

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
MessageCommand(Connection connection, Pattern pattern) std.

Method Summary

Modifier and Type	Method and Description
protected void	execute(Parser p) execute the command.
java.lang.String	getColumnName(int col) implements getColumnName of interface CommandBuildResultsPlugin.
java.lang.String	getColumnType(int col) get the column type
java.lang.String	getRecordID(int row) the record ID
java.lang.Object	getValue(int row, int col) get the value

Methods inherited from class com.aspc.commander.sql.SQLCommand

appendResult, appendResult, getCursorName, getRecordKey, isExecuteOnly

Methods inherited from class com.aspc.commander.Command

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

getRawTitle

Constructor Detail

MessageCommand

public MessageCommand(Connection connection,
                      Pattern pattern)

std. Command.

Parameters:

connection - the connection

pattern - the pattern

Method Detail

execute

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

execute the command.

Specified by:

execute in class Command

Parameters:

p - The parser

Throws:

java.lang.Exception - A serious problem

getColumnName

public java.lang.String getColumnName(int col)

implements getColumnName of interface CommandBuildResultsPlugin. Returns the name for the given column index. Column indexes start at 1

Parameters:

col - the column number to name

Returns:

String the name of the column

getColumnType

public java.lang.String getColumnType(int col)

get the column type

Parameters:

col - the column

Returns:

the type

getRecordID

public java.lang.String getRecordID(int row)

the record ID

Parameters:

row - the row

Returns:

the ID

getValue

public java.lang.Object getValue(int row,
                                 int col)

get the value

Parameters:

row - the row

col - the col

Returns:

the value