Java Doc for AbstractConsoleModule.java in  » Database-JDBC-Connection-Pool » sequoia-2.10.9 » org » continuent » sequoia » console » text » module » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Database JDBC Connection Pool » sequoia 2.10.9 » org.continuent.sequoia.console.text.module 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.continuent.sequoia.console.text.module.AbstractConsoleModule

All known Subclasses:   org.continuent.sequoia.console.text.module.VirtualDatabaseConsole,  org.continuent.sequoia.console.text.module.VirtualDatabaseAdmin,  org.continuent.sequoia.console.text.module.ControllerConsole,
AbstractConsoleModule
abstract public class AbstractConsoleModule (Code)
This class defines a AbstractConsoleModule
author:
   Nicolas Modrzyk
author:
   Mathieu Peltier
version:
   1.0

Inner Class :class CommandDelimiter extends ArgumentCompletor.AbstractArgumentDelimiter

Field Summary
final public static  StringDEFAULT_COMMAND_PROPERTIES_FILE
    
 TreeSetcommands
    
 Consoleconsole
    
protected  CompletorconsoleCompletor
    
 booleanquit
    

Constructor Summary
public  AbstractConsoleModule(Console console)
    

Method Summary
protected  voidaddCommands(String[] commandClasses, Set commands)
     Add commands to this module.
public  ConsoleCommandfindConsoleCommand(String commandLine, Hashtable hashCommands)
     Find the ConsoleCommand based on the name of the command from the commandLine in the hashCommands.
public  TreeSetgetCommands()
    
public  CompletorgetCompletor()
     Returns the console completor to use for this module.
public  ConsolegetConsole()
    
abstract public  StringgetDescriptionString()
    
final public  HashtablegetHashCommands()
    
abstract protected  StringgetModuleID()
     Returns an unique ID which identifies the module.
abstract public  StringgetPromptString()
    
final public  voidhandleCommandLine(String commandLine, Hashtable hashCommands)
    
public  voidhandlePrompt()
    
public  voidhelp()
    
final protected  voidloadCommands()
    
protected  StringloadCommandsFromProperties(String moduleID)
     Extracts the commands from the command properties file as a single String containing a list of comma-separated command classes.
protected  voidloadCompletor()
    
abstract public  voidlogin(String[] params)
    
protected  String[]parseCommands(String commandClassesAsString)
    
public  voidquit()
    
protected synchronized  voidreloadCompletor()
     Reload the completor associated with this module.

Field Detail
DEFAULT_COMMAND_PROPERTIES_FILE
final public static String DEFAULT_COMMAND_PROPERTIES_FILE(Code)
location of the default command lists for the console modules



commands
TreeSet commands(Code)



console
Console console(Code)



consoleCompletor
protected Completor consoleCompletor(Code)



quit
boolean quit(Code)




Constructor Detail
AbstractConsoleModule
public AbstractConsoleModule(Console console)(Code)
Creates a new AbstractConsoleModule.java object
Parameters:
  console - to refer from




Method Detail
addCommands
protected void addCommands(String[] commandClasses, Set commands)(Code)
Add commands to this module. Commands instances are created by reflection based on the command class names passed in parameter
Parameters:
  commandClasses - a String[] containing the class names of the commandto instantiate
Parameters:
  commands - Set where the commands are added



findConsoleCommand
public ConsoleCommand findConsoleCommand(String commandLine, Hashtable hashCommands)(Code)
Find the ConsoleCommand based on the name of the command from the commandLine in the hashCommands. If more than one ConsoleCommand's command name start the same way, return the ConsoleCommand with the longest one.
Parameters:
  commandLine - the command line to handle
Parameters:
  hashCommands - the list of commands available for this module the ConsoleCommand corresponding to the name of thecommand from the commandLine or nullif there is no matching



getCommands
public TreeSet getCommands()(Code)
Get all the commands for this module TreeSet of commands (commandName|commandObject)



getCompletor
public Completor getCompletor()(Code)
Returns the console completor to use for this module. Completor object.



getConsole
public Console getConsole()(Code)
Get access to the console Console instance



getDescriptionString
abstract public String getDescriptionString()(Code)
Text description of this module String description to display



getHashCommands
final public Hashtable getHashCommands()(Code)
Get the list of commands as strings for this module Hashtable list of String objects



getModuleID
abstract protected String getModuleID()(Code)
Returns an unique ID which identifies the module. This value is used to identify the commands to load for this given module. an unique String which identifies the module



getPromptString
abstract public String getPromptString()(Code)
Get the prompt string for this module String to place before prompt



handleCommandLine
final public void handleCommandLine(String commandLine, Hashtable hashCommands) throws Exception(Code)
Handle module command
Parameters:
  commandLine - the command line to handle
Parameters:
  hashCommands - the list of commands available for this module
throws:
  Exception - if fails *



handlePrompt
public void handlePrompt()(Code)
Handle a serie of commands



help
public void help()(Code)
Display help for this module



loadCommands
final protected void loadCommands()(Code)
Loads the commands for this module



loadCommandsFromProperties
protected String loadCommandsFromProperties(String moduleID)(Code)
Extracts the commands from the command properties file as a single String containing a list of comma-separated command classes.
Parameters:
  moduleID - module ID used as the key in the properties file a single String containing a list of comma-separatedcommand classes corresponding to the module identified by



loadCompletor
protected void loadCompletor()(Code)
Loads the commands for this module



login
abstract public void login(String[] params) throws Exception(Code)
Handles login in this module
Parameters:
  params - parameters to use to login in this module
throws:
  Exception - if fails



parseCommands
protected String[] parseCommands(String commandClassesAsString)(Code)
Parses a String representing a list of command classes (separated by commas) and returns an String[] representing the command classes
Parameters:
  commandClassesAsString - a String representing a list of commandclasses (separated by commas) a (eventually empty) String[] where each String represents acommand class



quit
public void quit()(Code)
Quit this module



reloadCompletor
protected synchronized void reloadCompletor()(Code)
Reload the completor associated with this module. This method must be called if the list of commands has been dynamically modified.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.