|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecthenplus.AbstractCommand
henplus.commands.ListUserObjectsCommand
public class ListUserObjectsCommand
FIXME: use SQLMetaData stuff instead.
Field Summary |
---|
Fields inherited from interface henplus.Command |
---|
EXEC_FAILED, SUCCESS, SYNTAX_ERROR |
Constructor Summary | |
---|---|
ListUserObjectsCommand(HenPlus hp)
|
Method Summary | |
---|---|
Collection |
columnsFor(String tabName)
fixme: add this to the cached values determined by rehash. |
Iterator |
completeAllColumns(String partialColumn)
|
Iterator |
completeTableName(SQLSession session,
String partialTable)
used from diverse commands that need table name completion. |
String |
correctTableName(String tabName)
see, if we find exactly one alternative, that is spelled correctly. |
int |
execute(SQLSession session,
String cmd,
String param)
execute the command given. |
String[] |
getCommandList()
returns the command-strings this command can handle. |
String |
getLongDescription(String cmd)
returns a longer string describing this action. |
String |
getShortDescription()
return a descriptive string. |
String |
getSynopsis(String cmd)
retuns a synopsis-string. |
SortedSet |
getTableNamesForSession(SQLSession session)
|
Iterator |
getTableNamesIteratorForSession(SQLSession session)
|
void |
interrupt()
|
void |
unhash(SQLSession session)
|
Methods inherited from class henplus.AbstractCommand |
---|
argumentCount, complete, getOption, getOptions, handleCommandline, isComplete, participateInCommandCompletion, registerOptions, requiresValidSession, setOptions, shutdown |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ListUserObjectsCommand(HenPlus hp)
Method Detail |
---|
public String[] getCommandList()
getCommandList
in interface Command
public int execute(SQLSession session, String cmd, String param)
execute
in interface Command
session
- the SQLsession this command is executed from.cmd
- the command as string.param
- the rest parameters following the command.
public void unhash(SQLSession session)
public Collection columnsFor(String tabName)
public String correctTableName(String tabName)
public Iterator completeTableName(SQLSession session, String partialTable)
public Iterator completeAllColumns(String partialColumn)
public Iterator getTableNamesIteratorForSession(SQLSession session)
public SortedSet getTableNamesForSession(SQLSession session)
public String getShortDescription()
getShortDescription
in interface Command
getShortDescription
in class AbstractCommand
public String getSynopsis(String cmd)
Command
export-xml <table> <filename>
help [command]
Should contain no newline, no leading spaces. This synopsis is printed in the detailed help of a command or if the execute()-method returned a SYNTAX_ERROR.
getSynopsis
in interface Command
getSynopsis
in class AbstractCommand
cmd
- the command the synopsis is for. This is one of the possible
commands returned by Command.getCommandList()
.public String getLongDescription(String cmd)
Command
getLongDescription
in interface Command
getLongDescription
in class AbstractCommand
cmd
- The command the long description is asked for. This
is one of the possible commands returned by
Command.getCommandList()
.public void interrupt()
interrupt
in interface Interruptable
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |