com.highqsoft.odsx.hql

Class HQL

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkPersistence

com.highqsoft.fwk.FwkItem

com.highqsoft.fwk.FwkInfoBusMember

com.highqsoft.fwk.FwkApplication

com.highqsoft.odsx.hql.HQL

All Implemented Interfaces:

FwkApplicationInterface, FwkCompareInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkDOMHandlerInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPrintableInterface, FwkPropertyChangeInterface, FwkThreadInterface, FwkTransferableInterface, FwkVetoableChangeInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.awt.print.Pageable, java.awt.print.Printable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.lang.Runnable, javax.infobus.DataItem, javax.infobus.InfoBusMember

public class HQL
extends FwkApplication

The HQL interpreter. Via the property group HQL.Command the interpreter is able to extend the command pool. This property group must contain property groups describing the commands. The name of the property group is the name of the command to be configured.

Property Keyword	Description
Classname	The name of the class to be used for the command.
Help	The help text of the command.

Author:

Andreas Hofmann $Revision: 1.15 $ $Date: 2017/04/06 13:29:54 $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPEND_ERR Contants to used for method openStream
static java.lang.String	APPEND_OUT Contants to used for method openStream
protected FwkPropertyGroupInterface	cmdGroup
protected java.lang.String[]	cmds
static java.lang.String	DELIMITERS
protected static FwkDescriptionInterface	descriptor
java.io.PrintStream	err The error stream.
protected java.util.Vector	errStack The error output stream stack.
java.io.InputStream	in The input stream.
protected com.highqsoft.odsx.hql.HQL.HQLController	infoBusController
static java.lang.String	OPEN_ERR Contants to used for method openStream
static java.lang.String	OPEN_OUT Contants to used for method openStream
java.io.PrintStream	out The output printer.
protected java.util.Vector	outStack The output stream stack.
protected com.highqsoft.odsx.hql.HQL.HQLResultSetConsumer	resultSetConsumer
protected OdsxResultSetProducer	resultSetProducer
protected boolean	verbose The flag that decides whether to print out result sets.
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkApplication

applicationThread, args, controller, eternal, executeStateListeners, pageFormat, panel, port, readingDOM, serviceControlManager, statusLabel, statusPanel

Fields inherited from class com.highqsoft.fwk.FwkInfoBusMember

infoBusMemberSupport

Fields inherited from class com.highqsoft.fwk.FwkItem

changeManager, properties, suspendChangeManager

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

source

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

INFOBUS_SOURCE

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Constructor Summary

Constructors

Constructor and Description
HQL() The constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	closeSession(java.lang.String name) Close a session.
boolean	closeStream(java.lang.String type) Close output stream.
CommandInterface	createCommand(java.lang.String name) Create a command object.
boolean	exit() Exit the application gracefully and release all related resources
FwkPropertyGroupInterface	getCommandProperties(java.lang.String cmd) Get the property group describing the given command.
static FwkDescriptionInterface	getDescriptor()
java.util.Enumeration	getInterpreterCommands() Get all available command name string.
OdsxSessionInterface	getLastUsedSession() Get thge last used session.
FwkPanelInterface	getPanel() Get the panel of the interpreter.
OdsxSessionInterface	getSession(java.lang.String name) Get the session of the current connection.
boolean	getVerbose() Get the verbose flag.
java.lang.String	getVersion() Get the version of the HQL implementation.
java.util.Iterator	listSessions() List the established sessions.
static void	main(java.lang.String[] args) The main HQL programm that reads commands from keyboard.
boolean	openStream(java.lang.String type, java.lang.String spec) Open output stream.
static java.lang.String[]	parseParams(java.lang.String params, FwkPropertyGroup keys) Parse the parameters.
protected static java.lang.String	parseString(java.util.StringTokenizer st, char delimiter) Parse the string literal.
static void	printCols(java.io.PrintStream out, ResultColumnInterface[] cols) Print out an array of result column.
void	publishResultSet(OdsxResultSetInterface result) Publish a result set.
CommandInterface	readFrom(java.io.BufferedReader in) Read commands from BuffereedReader
CommandInterface	readFrom(java.io.InputStream in) Read commands from InputStream
CommandInterface	readFrom(java.io.InputStreamReader in) Read commands from InputStreamReader
void	readFromKeyboard() Read from input steam until stop.
CommandInterface	readString(java.lang.String cmdString) Read commands from String
void	release() Release and purge the object.
void	revokeResultSet(OdsxResultSetInterface result) Revoke a result set.
void	run() The run method.
CommandInterface	scanLine(java.lang.String line) Scan a single statement line.
void	setErr(java.io.PrintStream err) The the error print stream.
void	setOut(java.io.PrintStream out) The the output print stream.
void	setSession(java.lang.String name, OdsxSessionInterface session) Set the session.
void	setVerbose(boolean flag) Set the verbose flag.

Methods inherited from class com.highqsoft.fwk.FwkApplication

addExecuteStateListener, destroyController, fireExecuteStateEvent, getController, getFwkPort, getNumberOfPages, getPageFormat, getPrintable, getPrintJobName, getPriority, getStatusPanel, hasFwkPort, init, isEternal, isInterrupted, isRegistered, print, readConstructor, readFromDOM, readingDOM, readingDOM, register, register, register, removeExecuteStateListener, setArguments, setController, setEternal, setPageFormat, setPanel, setPriority, setServiceControlManager, start, stop, unregister, writeConstructor, writeToDOM, writeToXML

Methods inherited from class com.highqsoft.fwk.FwkInfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, finalize, getInfoBus, getInfoBusName, getMemberName, isConnected, joinInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus, setInfoBusName, setMemberName, setName

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getProperty, getPropertyGroup, getSource, isChangeManagerSuspended, removeDataItemChangeListener, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from class com.highqsoft.fwk.FwkPersistence

addCommand, addCommand, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, commandsAvailable, compareTo, deleteGroup, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getBuild, getCommand, getCommands, getCommands, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getFwkMimeTypes, getGroup, getIcon, getIcon, getIconKey, getIconKey, getPersistentObjectNames, getSupportEMail, getTitle, getTitleName, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, groupExists, removeCommand, removeFromGroup, removeVetoableChangeListener, removeVetoableChangeListener, setAuthor, setBuild, setCommands, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setDateFormatString, setDescription, setDescriptor, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setSource, setSupportEMail, setTitleName

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, suspendPropertyChangeEvents

Methods inherited from class com.highqsoft.fwk.FwkDescription

getClassName, getPresentationString, getPresentationString, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setClassName, setCreationDate, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusMemberInterface

getInfoBusName, getMemberName, isConnected, setInfoBusName, setMemberName

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDOMHandlerInterface

getCompany

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getProperty, getPropertyGroup, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPersistenceInterface

getCommands, getPersistentObjectNames

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkVetoableChangeInterface

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getCommands, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface javax.infobus.DataItem

getSource

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

descriptor

protected static final FwkDescriptionInterface descriptor

DELIMITERS

public static final java.lang.String DELIMITERS

See Also:

Constant Field Values

OPEN_OUT

public static final java.lang.String OPEN_OUT

Contants to used for method openStream

See Also:

Constant Field Values

APPEND_OUT

public static final java.lang.String APPEND_OUT

Contants to used for method openStream

See Also:

Constant Field Values

OPEN_ERR

public static final java.lang.String OPEN_ERR

Contants to used for method openStream

See Also:

Constant Field Values

APPEND_ERR

public static final java.lang.String APPEND_ERR

Contants to used for method openStream

See Also:

Constant Field Values

infoBusController

protected com.highqsoft.odsx.hql.HQL.HQLController infoBusController

resultSetConsumer

protected com.highqsoft.odsx.hql.HQL.HQLResultSetConsumer resultSetConsumer

resultSetProducer

protected OdsxResultSetProducer resultSetProducer

outStack

protected java.util.Vector outStack

The output stream stack.

errStack

protected java.util.Vector errStack

The error output stream stack.

out

public java.io.PrintStream out

The output printer.

in

public java.io.InputStream in

The input stream.

verbose

protected boolean verbose

The flag that decides whether to print out result sets.

err

public java.io.PrintStream err

The error stream.

cmdGroup

protected FwkPropertyGroupInterface cmdGroup

cmds

protected java.lang.String[] cmds

Constructor Detail

HQL

public HQL()

The constructor

Method Detail

getVersion

public java.lang.String getVersion()

Get the version of the HQL implementation.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkApplication

Returns:

the version string.

getDescriptor

public static FwkDescriptionInterface getDescriptor()

setVerbose

public void setVerbose(boolean flag)

Set the verbose flag.

Parameters:

flag - true to ommit result printing.

getVerbose

public boolean getVerbose()

Get the verbose flag.

Returns:

true if the printing of the result will ommit.

run

public void run()

The run method. Currently it does nothing.

Specified by:

run in interface java.lang.Runnable

Specified by:

run in class FwkApplication

getPanel

public FwkPanelInterface getPanel()

Get the panel of the interpreter.

Specified by:

getPanel in interface FwkApplicationInterface

Overrides:

getPanel in class FwkApplication

Returns:

null This object has currently no panel.

exit

public boolean exit()

Exit the application gracefully and release all related resources

Specified by:

exit in interface FwkApplicationInterface

Overrides:

exit in class FwkApplication

Returns:

true if successful.

release

public void release()

Release and purge the object.

Specified by:

release in interface FwkInterface

Specified by:

release in interface javax.infobus.DataItem

Overrides:

release in class FwkItem

parseParams

public static java.lang.String[] parseParams(java.lang.String params,
                             FwkPropertyGroup keys)

Parse the parameters.

Parameters:

params - The parameter string.

keys - The property group the receives the options, specified by a name value pair.

Returns:

string array containing the parameters.

parseString

protected static java.lang.String parseString(java.util.StringTokenizer st,
                           char delimiter)

Parse the string literal.

Parameters:

st - the tokenizer.

delimiter - the delimiter of the string to be parsed.

Returns:

The result string.

readString

public CommandInterface readString(java.lang.String cmdString)
                            throws java.lang.RuntimeException

Read commands from String

Parameters:

cmdString - the command string

Throws:

java.lang.RuntimeException

readFrom

public CommandInterface readFrom(java.io.InputStream in)
                          throws java.lang.RuntimeException

Read commands from InputStream

Parameters:

in - the input stream

Throws:

java.lang.RuntimeException

readFrom

public CommandInterface readFrom(java.io.InputStreamReader in)
                          throws java.lang.RuntimeException

Read commands from InputStreamReader

Parameters:

in - the input stream reader

Throws:

java.lang.RuntimeException

readFrom

public CommandInterface readFrom(java.io.BufferedReader in)
                          throws java.lang.RuntimeException

Read commands from BuffereedReader

Parameters:

in - the input stream reader

Throws:

java.lang.RuntimeException

scanLine

public CommandInterface scanLine(java.lang.String line)
                          throws java.lang.Throwable

Scan a single statement line.

Parameters:

line - the line to be scanned.

Throws:

java.lang.Throwable

createCommand

public CommandInterface createCommand(java.lang.String name)

Create a command object.

Parameters:

name - the command name.

Returns:

a newly created instance of the command.

readFromKeyboard

public void readFromKeyboard()

Read from input steam until stop.

printCols

public static void printCols(java.io.PrintStream out,
             ResultColumnInterface[] cols)

Print out an array of result column.

getCommandProperties

public FwkPropertyGroupInterface getCommandProperties(java.lang.String cmd)

Get the property group describing the given command.

Parameters:

cmd - the command.

getInterpreterCommands

public java.util.Enumeration getInterpreterCommands()

Get all available command name string.

Returns:

the enumeration that contains the names.

setSession

public void setSession(java.lang.String name,
              OdsxSessionInterface session)

Set the session.

Parameters:

name - the name to be assigned to the session. if null, the name of the session is used.

session - the session of the current connection.

closeSession

public void closeSession(java.lang.String name)

Close a session.

Parameters:

name - the of the session to be closed.

getSession

public OdsxSessionInterface getSession(java.lang.String name)

Get the session of the current connection.

Parameters:

name - the name of the requested session.

Returns:

the session.

getLastUsedSession

public OdsxSessionInterface getLastUsedSession()

Get thge last used session.

Returns:

the last used session.

listSessions

public java.util.Iterator listSessions()

List the established sessions.

Returns:

An iterator containing the session names.

openStream

public boolean openStream(java.lang.String type,
                 java.lang.String spec)

Open output stream. Use the predefined constants to specify what kind of stream should be opened.

• OPEN_OUT
• APPEND_OUT
• OPEN_ERR
• APPEND_ERR

Parameters:

type - the type of stream.

spec - the file specification.

Returns:

true if successful.

closeStream

public boolean closeStream(java.lang.String type)

Close output stream. Use the predefined constants to specify what kind of stream should be closed.

• OPEN_OUT
• APPEND_OUT
• OPEN_ERR
• APPEND_ERR

Parameters:

type - the type of stream.

Returns:

true if successful.

setOut

public void setOut(java.io.PrintStream out)

The the output print stream.

Parameters:

out - the output print stream.

setErr

public void setErr(java.io.PrintStream err)

The the error print stream.

Parameters:

err - the error print stream.

publishResultSet

public void publishResultSet(OdsxResultSetInterface result)

Publish a result set.

Parameters:

result - the result set to be published.

See Also:

to find out the infobus conditions.

revokeResultSet

public void revokeResultSet(OdsxResultSetInterface result)

Revoke a result set.

Parameters:

result - the result set to be revoked.

See Also:

to find out the infobus conditions.

main

public static void main(java.lang.String[] args)

The main HQL programm that reads commands from keyboard. To start HQL use the following command:

java -mx100m -ms60m com.highqsoft.odsx.hql.HQL -Odsx.NewSession.AskForPassword false

Parameters:

args - the commands line arguments.