com.highqsoft.hqlx

Class HQLX

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.hqlx.HQLX

All Implemented Interfaces:

ImplementationIF

public class HQLX
extends AbstractImplementation

This is the HQLX executor. It can be used to execute hqlx xml files directly from command line by passing the filename or url as first command line argument to that class.

Since:

$Date: 2017/04/06 13:30:12 $

Version:

$Revision: 1.38 $

Author:

Andreas Hofmann

See Also:

ImplementationIF

Field Summary

Fields

Modifier and Type	Field and Description
protected AoSession	aoSession
protected java.lang.String	loglevel
protected java.lang.String	messagelevel
protected ResultSetPrinterIF	printer
protected QueryStructureExt	queryStructureExt
protected java.lang.String	tracelevel

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
HQLX() Create the HQLX using a context.
HQLX(XSDContextIF ctx) Create the HQLX using a context.
HQLX(XSDContextIF ctx, Hqlx hqlxXSD) Create the HQLX using a context.
HQLX(XSDContextIF ctx, java.util.Properties arguments) Create the HQLX using a context.
HQLX(XSDContextIF ctx, java.util.Properties arguments, Hqlx hqlxXSD) Create the HQLX using a context.

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	checkDescriptor(java.lang.Object descriptor)
static HQLX	createInstance(XSDContextIF ctx, java.io.InputStream is) Use this method to create a HQLX object from XML input stream
static HQLX	createInstance(XSDContextIF ctx, java.lang.String buf) Use this method to create a HQLX object XML string
static HQLX	createInstance(XSDContextIF ctx, java.lang.String[] buf) Use this method to create a HQLX object from XML string array
static HQLX	createInstance(XSDContextIF ctx, java.lang.StringBuffer buf) Use this method to create a object from XML string buffer
java.util.List<java.lang.String>	createQueryStructureExt() Create a QueryStructureExt from XML querystructureext descriptor.
ResultSetPrinterIF	createResultSetPrinter() Create a result set printer from an implementation xml descriptor.
AoSession	createSession() Create a session from XML aosession descriptor.
java.util.List<java.lang.String>	getAliases() Get the current alias list.
static java.lang.String[]	getDefaultColumnNames(ApplicationStructure asObj, ResultSetExt[] resultSet) Get the default column names from a resultSet.
java.util.List<FormatToStringIF>	getFormatStrings() Get the current format string list.
static java.lang.String	getLocalFilename(XSDContextIF ctx, java.lang.String filename) Get the local filename.
int	getMaxRows() Get the maximum number of rows to be selected.
QueryStructureExt	getQueryStructureExt() Return the internal QueryStructureExt structure.
ResultSetExt[]	getResultSet() Get the result set.
ResultSetExt[]	getResultSet(java.util.List<java.lang.String> alias) Get the result set and fill the default alias list.
AoSession	getSession() Get the internal session.
void	init() Initialize the program.
static void	main(java.lang.String[] args) The main program to execute an HQLX XML fromn commandline.
void	printResultSet(java.util.List<java.lang.String> alias, ResultSetPrinterIF printer, java.lang.String prefix, java.lang.String postfix) Print the result set.
void	printResultSet(ResultSetExt[] resultSet) Print the result set.
void	printResultSet(ResultSetExt[] resultSet, java.util.List<java.lang.String> alias) Print the result set.
void	printResultSet(ResultSetExt[] resultSet, java.util.List<java.lang.String> alias, java.util.List<FormatToStringIF> formats, ResultSetPrinterIF printer, java.lang.String prefix, java.lang.String postfix) Print the result set.
void	printResultSet(ResultSetExt[] resultSet, java.util.List<java.lang.String> alias, java.util.List<FormatToStringIF> formats, java.lang.String prefix, java.lang.String postfix) Print the result set.
void	printResultSet(ResultSetExt[] resultSet, java.util.List<java.lang.String> alias, ResultSetPrinterIF printer, java.lang.String prefix, java.lang.String postfix) Print the result set.
void	printResultSet(ResultSetExt[] resultSet, java.lang.String prefix, java.lang.String postfix) Print the result set.
void	printResultSet(java.lang.String prefix, java.util.List<java.lang.String> alias, java.lang.String postfix) Print the result set.
void	setDescriptor(java.lang.Object descriptor) Set the xml tree descriptor.
void	setMaxRows(int maxRows) Set the maximum number of rows to be selected.
void	setResultSetPrinter(ResultSetPrinterIF printer) Set a resultset printer.
void	setSession(AoSession aoSession) Set the session.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext

Methods inherited from class java.lang.Object

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

Field Detail

aoSession

protected AoSession aoSession

loglevel

protected java.lang.String loglevel

messagelevel

protected java.lang.String messagelevel

tracelevel

protected java.lang.String tracelevel

queryStructureExt

protected QueryStructureExt queryStructureExt

printer

protected ResultSetPrinterIF printer

Constructor Detail

HQLX

public HQLX()

Create the HQLX using a context.

HQLX

public HQLX(XSDContextIF ctx,
    java.util.Properties arguments,
    Hqlx hqlxXSD)
     throws InvalidArgumentException,
            InvalidDescriptorException

Create the HQLX using a context.

Parameters:

ctx - the context in that the query should run.

properties - the arguments (may be null)

hqlxXSD - the XML tree node of the query.

Throws:

InvalidArgumentException

InvalidDescriptorException

HQLX

public HQLX(XSDContextIF ctx,
    Hqlx hqlxXSD)
     throws InvalidArgumentException,
            InvalidDescriptorException

Create the HQLX using a context.

Parameters:

ctx - the context in that the query should run.

hqlxXSD - the XML tree node of the query.

Throws:

InvalidArgumentException

InvalidDescriptorException

HQLX

public HQLX(XSDContextIF ctx,
    java.util.Properties arguments)
     throws InvalidArgumentException,
            InvalidDescriptorException

Create the HQLX using a context.

Parameters:

ctx - the context in that the query should run.

properties - the arguments (may be null)

Throws:

InvalidArgumentException

InvalidDescriptorException

HQLX

public HQLX(XSDContextIF ctx)
     throws InvalidArgumentException,
            InvalidDescriptorException

Create the HQLX using a context.

Parameters:

ctx - the context in that the query should run.

Throws:

InvalidArgumentException

InvalidDescriptorException

Method Detail

createInstance

public static HQLX createInstance(XSDContextIF ctx,
                  java.lang.StringBuffer buf)
                           throws java.lang.Exception

Use this method to create a object from XML string buffer

Parameters:

ctx - the context

buf - the string buffer

Returns:

the HQLX object.

Throws:

java.lang.Exception

createInstance

public static HQLX createInstance(XSDContextIF ctx,
                  java.lang.String[] buf)
                           throws java.lang.Exception

Use this method to create a HQLX object from XML string array

Parameters:

ctx - the context

buf - the string array

Returns:

the HQLX object.

Throws:

java.lang.Exception

createInstance

public static HQLX createInstance(XSDContextIF ctx,
                  java.lang.String buf)
                           throws java.lang.Exception

Use this method to create a HQLX object XML string

Parameters:

ctx - the context

buf - the string

Returns:

the HQLX object.

Throws:

java.lang.Exception

createInstance

public static HQLX createInstance(XSDContextIF ctx,
                  java.io.InputStream is)
                           throws java.lang.Exception

Use this method to create a HQLX object from XML input stream

Parameters:

ctx - the context

is - the inputstream

Returns:

the HQLX object.

Throws:

java.lang.Exception

setDescriptor

public void setDescriptor(java.lang.Object descriptor)
                   throws InvalidDescriptorException

Set the xml tree descriptor.

Specified by:

setDescriptor in interface ImplementationIF

Overrides:

setDescriptor in class AbstractImplementation

Parameters:

descriptor - the tree node.

Throws:

InvalidDescriptorException - if the descriptor isn't valid.

checkDescriptor

protected static void checkDescriptor(java.lang.Object descriptor)
                               throws InvalidDescriptorException

Throws:

InvalidDescriptorException

init

public void init()
          throws InitializationFailedException

Initialize the program.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if the initialization fails.

setSession

public void setSession(AoSession aoSession)

Set the session.

Parameters:

aoSession - the ASAM ODS session.

createSession

public AoSession createSession()
                        throws AoException,
                               java.lang.Exception

Create a session from XML aosession descriptor.
If the session is already available, this method returns the existing session object. If the session is not available this methods tries to get the session from the reference assigned by the sessionref attribute first. If this fails it tries to get the session defined by the session node of the XML structure.

Returns:

the session or null if unable to connect.

Throws:

AoException

java.lang.Exception

createQueryStructureExt

public java.util.List<java.lang.String> createQueryStructureExt()
                                                         throws AoException,
                                                                java.text.ParseException,
                                                                java.lang.Exception

Create a QueryStructureExt from XML querystructureext descriptor.

Parameters:

alias - a list containing the aliases for column names.

Returns:

the alias list of the column names.

Throws:

AoException

java.text.ParseException

java.lang.Exception

getAliases

public java.util.List<java.lang.String> getAliases()

Get the current alias list.

Returns:

the alias list of the column names.

getFormatStrings

public java.util.List<FormatToStringIF> getFormatStrings()

Get the current format string list.

Returns:

the column specific format list.

setResultSetPrinter

public void setResultSetPrinter(ResultSetPrinterIF printer)

Set a resultset printer.

Parameters:

printer - the printer

createResultSetPrinter

public ResultSetPrinterIF createResultSetPrinter()
                                          throws java.io.FileNotFoundException,
                                                 java.io.IOException,
                                                 java.lang.ClassNotFoundException,
                                                 java.lang.InstantiationException,
                                                 java.lang.IllegalAccessException,
                                                 java.lang.Exception

Create a result set printer from an implementation xml descriptor.

Returns:

the Implementation or null

Throws:

java.io.FileNotFoundException

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.Exception

getSession

public AoSession getSession()

Get the internal session.

Returns:

the ASAM ODS session.

setMaxRows

public void setMaxRows(int maxRows)

Set the maximum number of rows to be selected.

Parameters:

maxRows - the total number

getMaxRows

public int getMaxRows()

Get the maximum number of rows to be selected.

Returns:

the total number

getQueryStructureExt

public QueryStructureExt getQueryStructureExt()

Return the internal QueryStructureExt structure.

Returns:

the ASAM ODS QueryStructureExt

getResultSet

public ResultSetExt[] getResultSet()
                            throws AoException

Get the result set.

Returns:

the ResultSetExt ASAM ODS structure.

Throws:

AoException

getResultSet

public ResultSetExt[] getResultSet(java.util.List<java.lang.String> alias)
                            throws AoException

Get the result set and fill the default alias list.

Parameters:

alias - the list containing the aliases. It is also used to return the alias list.

Returns:

the ResultSetExt ASAM ODS structure.

Throws:

AoException

printResultSet

public void printResultSet(ResultSetExt[] resultSet)
                    throws java.lang.Exception

Print the result set.

Parameters:

resultSet - the result set

Throws:

AoException

java.lang.Exception

printResultSet

public void printResultSet(ResultSetExt[] resultSet,
                  java.util.List<java.lang.String> alias)
                    throws java.lang.Exception

Print the result set.

Parameters:

resultSet - the result set

alias - the list of aliases.

Throws:

AoException

java.lang.Exception

printResultSet

public void printResultSet(ResultSetExt[] resultSet,
                  java.util.List<java.lang.String> alias,
                  java.util.List<FormatToStringIF> formats,
                  java.lang.String prefix,
                  java.lang.String postfix)
                    throws java.lang.Exception

Print the result set.

Parameters:

resultSet - the result set

alias - the list of aliases.

prefix - the line prefix for printing.

postfix - the line postfix.

Throws:

AoException

java.lang.Exception

printResultSet

public void printResultSet(ResultSetExt[] resultSet,
                  java.lang.String prefix,
                  java.lang.String postfix)
                    throws java.lang.Exception

Print the result set.

Parameters:

resultSet - the result set

prefix - the line prefix for printing.

postfix - the line postfix.

Throws:

AoException

java.lang.Exception

printResultSet

public void printResultSet(java.lang.String prefix,
                  java.util.List<java.lang.String> alias,
                  java.lang.String postfix)
                    throws java.lang.Exception

Print the result set.

Parameters:

prefix - the line prefix for printing.

alias - the list of aliases.

postfix - the line postfix.

Throws:

AoException

java.lang.Exception

printResultSet

public void printResultSet(java.util.List<java.lang.String> alias,
                  ResultSetPrinterIF printer,
                  java.lang.String prefix,
                  java.lang.String postfix)
                    throws java.lang.Exception

Print the result set.

Parameters:

printer - the printer to be used.

alias - the list of aliases.

prefix - the line prefix for printing.

postfix - the line postfix.

Throws:

AoException

java.lang.Exception

printResultSet

public void printResultSet(ResultSetExt[] resultSet,
                  java.util.List<java.lang.String> alias,
                  ResultSetPrinterIF printer,
                  java.lang.String prefix,
                  java.lang.String postfix)
                    throws java.lang.Exception

Print the result set.

Parameters:

resultSet - the result set.

alias - the list of aliases.

printer - the printer to be used.

prefix - the line prefix for printing.

postfix - the line postfix.

Throws:

AoException

java.lang.Exception

printResultSet

public void printResultSet(ResultSetExt[] resultSet,
                  java.util.List<java.lang.String> alias,
                  java.util.List<FormatToStringIF> formats,
                  ResultSetPrinterIF printer,
                  java.lang.String prefix,
                  java.lang.String postfix)
                    throws java.lang.Exception

Print the result set.

Parameters:

resultSet - the result set.

alias - the list of aliases.

printer - the printer to be used.

prefix - the line prefix for printing.

postfix - the line postfix.

Throws:

AoException

java.lang.Exception

getDefaultColumnNames

public static java.lang.String[] getDefaultColumnNames(ApplicationStructure asObj,
                                       ResultSetExt[] resultSet)

Get the default column names from a resultSet.

Parameters:

asObj - The application structure.

resultSet - the result set.

Returns:

the column names.

main

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

The main program to execute an HQLX XML fromn commandline. The first argument must be the filename, resource or url that should be used.

Parameters:

args - the command line arguments.

getLocalFilename

public static java.lang.String getLocalFilename(XSDContextIF ctx,
                                java.lang.String filename)
                                         throws java.io.IOException

Get the local filename. This routine tries to find a local file specification. If that fails, it tries to resolve a the relative filename in classpath and tries get a local file.

Parameters:

a - filename spec.

Throws:

java.io.IOException