com.highqsoft.querytree

Class QueryTree

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.querytree.QueryTree

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class QueryTree
extends AbstractImplementation
implements ExecutableIF

This is the Querytree executor. It can be used to print out the result of the querytree xml files by passing the filename or url as first command line argument to that class.

Since:

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

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

See Also:

ImplementationIF

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_REF_NAME The cache reference name (value="QUERYTREE_CACHE").

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
QueryTree() Create the using a context.
QueryTree(XSDContextIF ctx, java.util.Properties arguments, Querytree queryTreeXSD) Create the QueryTree using a context.
QueryTree(XSDContextIF ctx, Querytree queryTreeXSD) Create the QueryTree using a context.

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkDescriptor(java.lang.Object descriptor) Check the descriptor.
static QueryTree	createInstance(XSDContextIF ctx, java.io.InputStream is) Use this method to create a QueryTree object from XML input stream
static QueryTree	createInstance(XSDContextIF ctx, java.lang.String buf) Use this method to create a QueryTree object XML string
static QueryTree	createInstance(XSDContextIF ctx, java.lang.String[] buf) Use this method to create a QueryTree object from XML string array
static QueryTree	createInstance(XSDContextIF ctx, java.lang.StringBuffer buf) Use this method to create a object from XML string buffer
AoSession	createSession() Create a session from XML aosession descriptor.
void	execute() Execute the QueryTree.
protected static void	execute(XSDContextIF ctx, ExecutableIF executable, java.util.logging.Logger messenger, java.lang.String classname, java.lang.String method) Execute an implementation.
protected static void	executeSequence(XSDContextIF ctx, java.lang.String classname, java.lang.String ident, Implementationseq implSeq) Execute a sequence of executable interfaces.
static java.lang.String	getLocalFilename(XSDContextIF ctx, java.lang.String filename) Get the local filename.
java.lang.String	getPostfix() Get the postfix string value belong to the tree element.
java.lang.String	getPrefix() Get the prefix string value belong to the tree element.
NodeQuery	getQuery(TreeNodeIF node) Get node query object.
java.util.Iterator<TreeNodeIF>	getRoot() Get the tree root.
AoSession	getSession() Get the internal session.
void	init() Initialize the program.
static void	main(java.lang.String[] args) The main program to execute an QueryTree XML fromn commandline.
void	print(java.io.PrintStream out, XSDContextIF ctx, TreeNodeIF node) Print one special node to the stream.
void	printTree(java.io.PrintStream out) Print the tree.
void	setDescriptor(java.lang.Object descriptor) Set the XML tree descriptor.
void	setSession(AoSession aoSession) Set the session.
void	terminate() Terminate the QueryTree.

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

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext

Field Detail

CACHE_REF_NAME

public static final java.lang.String CACHE_REF_NAME

The cache reference name (value="QUERYTREE_CACHE").

See Also:

Constant Field Values

Constructor Detail

QueryTree

public QueryTree()

Create the using a context.

QueryTree

public QueryTree(XSDContextIF ctx,
         java.util.Properties arguments,
         Querytree queryTreeXSD)
          throws InvalidArgumentException,
                 InvalidDescriptorException

Create the QueryTree using a context.

Parameters:

ctx - the context in that the query should run.

arguments - the arguments (may be null)

queryTreeXSD - the XML tree node of the drop job.

Throws:

InvalidArgumentException - if arguments are invalid.

InvalidDescriptorException - if descriptor is invalid.

QueryTree

public QueryTree(XSDContextIF ctx,
         Querytree queryTreeXSD)
          throws InvalidArgumentException,
                 InvalidDescriptorException

Create the QueryTree using a context.

Parameters:

ctx - the context in that the query should run.

queryTreeXSD - the XML tree node of the drop job.

Throws:

InvalidArgumentException - if arguments are invalid.

InvalidDescriptorException - if descriptor is invalid.

Method Detail

createInstance

public static QueryTree createInstance(XSDContextIF ctx,
                       java.lang.StringBuffer buf)
                                throws java.io.FileNotFoundException,
                                       javax.xml.bind.JAXBException,
                                       java.io.IOException,
                                       InvalidArgumentException,
                                       InvalidDescriptorException,
                                       InitializationFailedException

Use this method to create a object from XML string buffer

Parameters:

ctx - the context

buf - the string buffer

Returns:

the QueryTree object.

Throws:

java.io.FileNotFoundException - if schema file was not found.

javax.xml.bind.JAXBException - if the XML context was wrong.

java.io.IOException - if an IO problem occurs.

InvalidArgumentException - if there are wrong arguments for the implementation.

InvalidDescriptorException - if the descriptor is wrong.

InitializationFailedException - if initialization fails.

createInstance

public static QueryTree createInstance(XSDContextIF ctx,
                       java.lang.String[] buf)
                                throws java.io.FileNotFoundException,
                                       javax.xml.bind.JAXBException,
                                       java.io.IOException,
                                       InvalidArgumentException,
                                       InvalidDescriptorException,
                                       InitializationFailedException

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

Parameters:

ctx - the context

buf - the string array

Returns:

the QueryTree object.

Throws:

java.io.FileNotFoundException - if schema file was not found.

javax.xml.bind.JAXBException - if the XML context was wrong.

java.io.IOException - if an IO problem occurs.

InvalidArgumentException - if there are wrong arguments for the implementation.

InvalidDescriptorException - if the descriptor is wrong.

InitializationFailedException - if initialization fails.

createInstance

public static QueryTree createInstance(XSDContextIF ctx,
                       java.lang.String buf)
                                throws java.io.FileNotFoundException,
                                       javax.xml.bind.JAXBException,
                                       java.io.IOException,
                                       InvalidArgumentException,
                                       InvalidDescriptorException,
                                       InitializationFailedException

Use this method to create a QueryTree object XML string

Parameters:

ctx - the context

buf - the string

Returns:

the QueryTree object.

Throws:

java.io.FileNotFoundException - if schema file was not found.

javax.xml.bind.JAXBException - if the XML context was wrong.

java.io.IOException - if an IO problem occurs.

InvalidArgumentException - if there are wrong arguments for the implementation.

InvalidDescriptorException - if the descriptor is wrong.

InitializationFailedException - if initialization fails.

createInstance

public static QueryTree createInstance(XSDContextIF ctx,
                       java.io.InputStream is)
                                throws java.io.FileNotFoundException,
                                       javax.xml.bind.JAXBException,
                                       java.io.IOException,
                                       InvalidArgumentException,
                                       InvalidDescriptorException,
                                       InitializationFailedException

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

Parameters:

ctx - the context

is - the input stream

Returns:

the QueryTree object.

Throws:

java.io.FileNotFoundException - if schema file was not found.

javax.xml.bind.JAXBException - if the XML context was wrong.

java.io.IOException - if an IO problem occurs.

InvalidArgumentException - if there are wrong arguments for the implementation.

InvalidDescriptorException - if the descriptor is wrong.

InitializationFailedException - if initialization fails.

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 descriptor is not valid.

checkDescriptor

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

Check the descriptor.

Parameters:

descriptor - the descriptor.

Throws:

InvalidDescriptorException - if descriptor is invliad.

init

public void init()
          throws InitializationFailedException

Initialize the program.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if initialization fails.

execute

public void execute()
             throws ExecutableException

Execute the QueryTree.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if execution fails.

terminate

public void terminate()

Terminate the QueryTree.

Specified by:

terminate in interface ExecutableIF

getPrefix

public java.lang.String getPrefix()

Get the prefix string value belong to the tree element.

Returns:

the prefix string value.

getPostfix

public java.lang.String getPostfix()

Get the postfix string value belong to the tree element.

Returns:

the postfix string value.

getRoot

public java.util.Iterator<TreeNodeIF> getRoot()

Get the tree root.

Returns:

An iterator containing the tree root nodes.

getQuery

public NodeQuery getQuery(TreeNodeIF node)
                   throws InitializationFailedException

Get node query object.

Parameters:

node - the tree node.

Returns:

the query object.

Throws:

InitializationFailedException - if the query registry could not be build initially.

printTree

public void printTree(java.io.PrintStream out)
               throws AoException,
                      java.text.ParseException,
                      InitializationFailedException

Print the tree.

Parameters:

out - the output stream.

Throws:

AoException - if ASAM ODS fails.

java.text.ParseException - if unable to parse the XML structure.

InitializationFailedException - if the query registry could not be build initially.

print

public void print(java.io.PrintStream out,
         XSDContextIF ctx,
         TreeNodeIF node)
           throws AoException,
                  java.text.ParseException,
                  InitializationFailedException

Print one special node to the stream.

Parameters:

out - the output stream.

ctx - the context

node - the node

Throws:

AoException - If ASAM ODS fails.

java.text.ParseException - if the parser fails.

InitializationFailedException - if the query registry could not be build initially.

executeSequence

protected static void executeSequence(XSDContextIF ctx,
                   java.lang.String classname,
                   java.lang.String ident,
                   Implementationseq implSeq)
                               throws java.io.FileNotFoundException,
                                      InvalidDescriptorException,
                                      InvalidArgumentException,
                                      InitializationFailedException,
                                      java.io.IOException,
                                      java.lang.ClassNotFoundException,
                                      java.lang.InstantiationException,
                                      java.lang.IllegalAccessException

Execute a sequence of executable interfaces.

Parameters:

ident - The method ident.

implSeq - the sequence.

Throws:

java.lang.IllegalAccessException

java.lang.InstantiationException

java.lang.ClassNotFoundException

java.io.IOException

InitializationFailedException

InvalidArgumentException

InvalidDescriptorException

java.io.FileNotFoundException

execute

protected static void execute(XSDContextIF ctx,
           ExecutableIF executable,
           java.util.logging.Logger messenger,
           java.lang.String classname,
           java.lang.String method)

Execute an implementation.

Parameters:

ctx - the context.

executable - the executable definition.

messenger - the messenger.

classname - the name of the class to be executed.

method - the name of the method that calls this method.

setSession

public void setSession(AoSession aoSession)
                throws AoException

Set the session.

Parameters:

aoSession - the ASAM ODS session.

Throws:

AoException - if ASAM ODS call fails.

createSession

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

Create a session from XML aosession descriptor.
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

Throws:

AoException

java.lang.Exception

getSession

public AoSession getSession()

Get the internal session.

Returns:

the ASAM ODS session.

main

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

The main program to execute an QueryTree 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:

ctx - the context.

filename - a filename spec.

Throws:

java.io.IOException