Question and Answer (QA) Client Examples
========================================


Overview
--------

Within this folder we offer Java client  examples for  the
J2SE Business Components  provided within this package. In
particular, for each business method contained within each
business Component we provide a client side example; which
illustrates   how  functionality  contained   within  this
component can be applied to solve real world problems.  In
addition,  to  these  examples  we  also  include   custom
applications  which  solve  some of the  generic  problems
which this Component is designed to address.


Structure of `Question and Answer' (QA) Examples Directory
----------------------------------------------------------


(Client Level) (Technology Level)          (Business Module Level)       (Business Class Level)        (Example Level)         (Custom Example Level)


Client +
       |
       + Java -------------------+
       |                         |
       + Readme.txt              + `Business Module 1' --------+
                                 |                             |
                                 + `Business Module 2' --+...  + `Business Class 1' --------+
                                 |                             |                            |
                                 + QALibrary.jar               + `Business Class 2' --+...  + `BusinessClass'.java
                                                               |                            |
                                                               + ...                        + compile.cmd (.sh for Linux)
                                                                                            |
                                                                                            + run.cmd (.sh for Linux)
                                                                                            |
                                                                                            + run_gui.cmd (.sh for Linux)
                                                                                            |
                                                                                            + `CustomClient' -----------------+ `CustomClient'.java
                                                                                                                              | 
                                                                                                                              + compile.cmd (.sh for Linux)
                                                                                                                              |
                                                                                                                              + run.cmd (.sh for Linux)



Quick Start Guide
-----------------

Browse down to the  particular client within the  business
module for the given client  technology you are interested
in.  Run the compile.cmd  (.sh for Linux), script in order
to compile the  example and then run the run.cmd  (.sh for
Linux), script in order to run the example.


Explanation of the QA Directory Structure and its files
------------------------------------------------------- 

1) Client Level

The directory containing the Questions and Answer Examples
is   named  `QAClients'. This directory can be located  by
using the Index.html file, which is presented at  the end
of the installation process, by selecting:

Run Examples > Client Examples Directory

Within this folder you will also find the following file:

Readme.txt - this readme file


2) Client Technology Level

Within the `Client' folder is the Technology Level  of the
QA  directory structure.  Within this folder you will find
sub-directories; which contain examples written in each of
the  Java  Client Technologies in  which the  clients have
been implemented.

As  mentioned  above  within  the overview  we  provide an
implementation of each `Question and  Answer (QA)' example
using each of the client technologies used. Selecting  one
of these folders in order to view the client implemented
within the corresponding technology.


3) Business Module Level

After selecting one of the technology sub-folders  at  the
`Client Technology Level' (see (2) above) you will enter a
folder which contains a sub-folder for each of the modules
contained within this component package.  The modules  are
convenient collections of business classes containing  the
business functionality offered  by this  component.   Each
module  has a  sub-folder which contains the `Question and
Answer' examples  of each method of  the classes  which it
contains.

This directory will also contain the following file:

QALibrary.jar -  contains utility functionality  necessary
for running  the clients.


4) Business Class Level

At the  business class level under the module level we are
presented with  one  sub-folder  for each  of the  classes
within the business module. Each of these folders contains
the  files  of  the  examples  for  each  of  the  methods
contained with the respective class.


5) Example Level

At the Example level you will be presented with the  files
which allow  you to compile and then  run  the examples of
the application of the  Business methods of the respective
class.  The  files within this directory  which constitute
the Client example are as follows:

Source Code File(s) - Depending  on  the  Java  compatible
technology selected at the `Technology Level' this  folder
will contain a source code file(s) of the client.

Compile Batch File - Assuming that you have access to  the
relevant compiler the  compile batch file (compile.cmd  or
compile.sh) once run will compile the client example  from
the folders  source  code  file.  Below  we  include  some
remarks  on  how  to  obtaining  suitable Java compiler in
order  to  be  able  to  compile  and  then  run  the Java
examples.

Run Batch File -  The run batch file (run.cmd  or  run.sh)
will run the  examples  executable  file  (exe)  which  is
generated from the compilation of the source code file. If
the example over  runs your  console screenful  then press
space  in order to page  down or  enter is order to scroll
down.


6) Custom Example Level

At  the Custom  Example level you  will find a source code
file  containing  the  implementation  of  the Application
which addresses a typical question for which the Component
is designed. The source  code has a linear structure  with
full inline commentary. By  just running  the  compile and
then run scripts  contained within this directory you will
be  able  to  solve to  given problems  view  the  results
obtained. The files contained  within each  Custom  Client
Example directory are as follows:
  
Source Code File(s) -  The  custom clients source code  in
the appropriate  client technology.

Compile Batch File - Assuming that you have access to  the
relevant compiler the  compile batch file  (compile.cmd or
compile.sh) once run will compile the client example  from
the folders source code file.

Run Batch File - The run batch file  (run.cmd  or  run.sh)
will run the examples executable file  which is  generated
from the compilation  of  the  source code  file.  If  the
example over runs your console screenful then press  space
in order to page down or enter in order to scroll down..


Remarks on Java compilers
-------------------------

1) Required compilers and how to test for them

In order to compile the  Java examples  you will require a
suitable  Java  compiler  which  should  be  installed and
configured  within  your  environment  variable  PATH. The
easiest way in which  to test whether you have access to a
Java compiler at your command prompt is to type the follow
command at the command line:

java - Invokes the Java compiler

2) How to obtain the required Java compiler

Compilers  for  the Java programming language are provided
within Sun's Java SDK which can be obtained from:

http://java.sun.com
