org.objectweb.cjdbc.console.text.module.AbstractConsoleModule Class Reference

Inheritance diagram for org.objectweb.cjdbc.console.text.module.AbstractConsoleModule:

[legend]Collaboration diagram for org.objectweb.cjdbc.console.text.module.AbstractConsoleModule:

[legend]List of all members.

Public Member Functions
	AbstractConsoleModule (Console console)
abstract String	getDescriptionString ()
void	help ()
void	quit ()
TreeSet	getCommands ()
abstract String	getPromptString ()
void	handlePrompt ()
final Hashtable	getHashCommands ()
final void	handleCommandLine (String commandLine, Hashtable hashCommands) throws Exception
final void	manageHistory (String command)
abstract void	login (String[] params) throws Exception
Console	getConsole ()
LinkedList	getHistory ()
Protected Member Functions
abstract void	loadCommands ()
void	loadCompletor ()
Package Attributes
Console	console
TreeSet	commands
boolean	quit
LinkedList	history

---

Detailed Description

This class defines a AbstractConsoleModule

Author:

Nicolas Modrzyk

Mathieu Peltier

Version:

1.0

Definition at line 51 of file AbstractConsoleModule.java.

---

Constructor & Destructor Documentation

org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.AbstractConsoleModule (  Console  console  )

Creates a new AbstractConsoleModule.java object Parameters: console  to refer from Definition at line 64 of file AbstractConsoleModule.java. References org.objectweb.cjdbc.console.text.Console.println(). { this.console = console; this.commands = new TreeSet(); this.history = new LinkedList(); commands.add(new Help(this)); commands.add(new History(this)); commands.add(new Quit(this)); console.println(ConsoleTranslate.get("module.loading", getDescriptionString())); this.loadCommands(); this.loadCompletor(); }

---

Member Function Documentation

TreeSet org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.getCommands (   )

Get all the commands for this module Returns: TreeSet of commands (commandName|commandObject) Definition at line 136 of file AbstractConsoleModule.java. { return commands; }

Console org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.getConsole (   )

Get access to the console Returns: Console instace Definition at line 273 of file AbstractConsoleModule.java. { return console; }

abstract String org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.getDescriptionString (   )  [pure virtual]

Text description of this module Returns: String description to display Implemented in org.objectweb.cjdbc.console.text.module.ControllerConsole, org.objectweb.cjdbc.console.text.module.MonitorConsole, org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin, and org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.

final Hashtable org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.getHashCommands (   )

Get the list of commands as strings for this module Returns: Hashtable list of String objects Definition at line 195 of file AbstractConsoleModule.java. References org.objectweb.cjdbc.console.text.commands.ConsoleCommand.getCommandName(). Referenced by org.objectweb.cjdbc.console.text.commands.History.parse(). { Hashtable hashCommands = new Hashtable(); ConsoleCommand consoleCommand; Iterator it = commands.iterator(); while (it.hasNext()) { consoleCommand = (ConsoleCommand) it.next(); hashCommands.put(consoleCommand.getCommandName(), consoleCommand); } return hashCommands; }

LinkedList org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.getHistory (   )

Returns the history value. Returns: Returns the history. Definition at line 283 of file AbstractConsoleModule.java. Referenced by org.objectweb.cjdbc.console.text.commands.History.parse(). { return history; }

abstract String org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.getPromptString (   )  [pure virtual]

Get the prompt string for this module Returns: String to place before prompt Implemented in org.objectweb.cjdbc.console.text.module.ControllerConsole, org.objectweb.cjdbc.console.text.module.MonitorConsole, org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin, and org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.

final void org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.handleCommandLine (  String  commandLine, Hashtable  hashCommands )  throws Exception

Handle module command Parameters: commandLine  the command line to handle hashCommands  the list of commands available for this module Exceptions: Exception  if fails Definition at line 215 of file AbstractConsoleModule.java. References org.objectweb.cjdbc.console.text.commands.ConsoleCommand.execute(), and org.objectweb.cjdbc.console.text.Console.printError(). Referenced by org.objectweb.cjdbc.console.text.commands.History.parse(). { ConsoleCommand consoleCommand; StringTokenizer st = new StringTokenizer(commandLine); if (!st.hasMoreTokens()) { console.printError(ConsoleTranslate.get("module.command.not.supported", "")); return; } String command = st.nextToken(); consoleCommand = null; // reinit try { consoleCommand = (ConsoleCommand) hashCommands.get(command); } catch (NoSuchElementException e) { consoleCommand = null; } if (consoleCommand == null) { console.printError(ConsoleTranslate.get("module.command.not.supported", command)); } else { consoleCommand.execute(commandLine.substring(command.length())); } }

void org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.handlePrompt (   )

Handle a serie of commands Reimplemented in org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole. Definition at line 151 of file AbstractConsoleModule.java. References org.objectweb.cjdbc.console.text.Console.printError(), and org.objectweb.cjdbc.console.text.Console.readLine(). { if (quit) { console.printError(ConsoleTranslate.get("module.quitting", getDescriptionString())); return; } Hashtable hashCommands = getHashCommands(); //login(); quit = false; while (!quit) { try { String commandLine = console.readLine(getPromptString()); if (commandLine == null) { quit = true; break; } if (commandLine.equals("")) continue; else manageHistory(commandLine); handleCommandLine(commandLine, hashCommands); } catch (Exception e) { console.printError(ConsoleTranslate.get("module.command.got.error", new Object[]{e.getClass(), e.getMessage()}), e); } } }

void org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.help (   )

Display help for this module Reimplemented in org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole. Definition at line 108 of file AbstractConsoleModule.java. References org.objectweb.cjdbc.console.text.commands.ConsoleCommand.getCommandDescription(), org.objectweb.cjdbc.console.text.commands.ConsoleCommand.getCommandName(), org.objectweb.cjdbc.console.text.commands.ConsoleCommand.getCommandParameters(), org.objectweb.cjdbc.console.text.Console.printInfo(), and org.objectweb.cjdbc.console.text.Console.println(). Referenced by org.objectweb.cjdbc.console.text.commands.Help.parse(). { console.println(ConsoleTranslate.get("module.commands.available", getDescriptionString())); ConsoleCommand command; Iterator it = commands.iterator(); while (it.hasNext()) { command = (ConsoleCommand) it.next(); console.printInfo(command.getCommandName() + " " + command.getCommandParameters()); console.println(" " + command.getCommandDescription()); } }

abstract void org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.loadCommands (   )  [protected, pure virtual]

Loads the commands for this module Implemented in org.objectweb.cjdbc.console.text.module.ControllerConsole, org.objectweb.cjdbc.console.text.module.MonitorConsole, org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin, and org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.

abstract void org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.login (  String[]  params  )  throws Exception [pure virtual]

Handles login in this module Parameters: params  parameters to use to login in this module Exceptions: Exception  if fails Implemented in org.objectweb.cjdbc.console.text.module.ControllerConsole, org.objectweb.cjdbc.console.text.module.MonitorConsole, org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin, and org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole.

final void org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.manageHistory (  String  command  )

Add the command to the history. Removes the first item in the list if the history is too large. Parameters: command  taken from the command line Definition at line 253 of file AbstractConsoleModule.java. { history.add(command); if (history.size() > HISTORY_MAX) history.removeFirst(); }

void org.objectweb.cjdbc.console.text.module.AbstractConsoleModule.quit (   )

Quit this module Reimplemented in org.objectweb.cjdbc.console.text.module.ControllerConsole, and org.objectweb.cjdbc.console.text.module.VirtualDatabaseConsole. Definition at line 126 of file AbstractConsoleModule.java. Referenced by org.objectweb.cjdbc.console.text.module.VirtualDatabaseAdmin.login(). { this.quit = true; }

---

The documentation for this class was generated from the following file:

• AbstractConsoleModule.java

---