*---------------------------------------------------------------
* XBench Database Generator V1.0 December 2002
* (c) 2002 by Benjamin Bin Yao, M. Tamer Ozsu
*             University of Waterloo
* All rights reserved.
*
* ToXgene V1.1 April 2002
* (c) 2001 by University of Toronto, IBM Corporation
* All rights reserved.
*
* WGEN: TPC-W Population Generator V1.0.0
* (c) 1999 - 2000 by Transaction Processing Performance Council
* All rights reserved.
*
* Xerces XML Parser in Java v1.4.3
* Copyright (c) 1999 The Apache Software Foundation.
* All rights reserved.
* --------------------------------------------------------------


1. INSTALLATION
---------------
Uncompress the package to your hard disk.

Make sure that you have to following software installed on your
machine and their locations are in PATH variable.
* Java Virtual Machine compatible with JDK1.3 (available at
  http://java.sun.com)
* Perl interpreter (available at http://www.perl.org)

*****************************************************************
For Unix:
    You have to go to wgen directory and compile the TPC-W
population generator since it's written in C. Please read the
README file in that directory for details. This package comes
with a makefile and a executable file which work under SunOS 5.8.
*****************************************************************


2. CONTENTS OF THIS PACKAGE
---------------------------
* README.TXT: this file
* xdbgen.pl: main perl script of XBench database generator
* input: directory that contains XML documents needed for database
  generating
* output: directory where the database generator stores final XML
  documents
* schemas: directory with XML schemas and DTDs that generated XML
  documents conform to
* temp: temporary working directory
* templates: directory containing ToXgene templates used by ToXgene
  to generate XML documents
* toxgene: template-based XML document generator (v1.1a) developed
  by University of Toronto and IBM Corporation
  (http://www.alphaworks.ibm.com/tech/toxgene)
* wgen: TPC-W database population generator (v1.0.0)
  (http://www.tpc.org/tpcw)
* xerces: Apache XML parser in Java (v1.4.3) 
  (http://xml.apache.org), used by ToXgene
* workloads: containing queries for each class of database

This product includes software developed by the Apache Software 
Foundation (http://www.apache.org/).


3. GENERATING DATABASES
-----------------------
Database generation uses ToXgene V1.1a ((c) 2001 by University of
Toronto and IBM Corporation).

Execute "xdbgen.pl" (depending on the version of your perl, you may
need to execute "perl xdbgen.pl").

You should see the following output:
*******************************************************
 ----------------------------------------------------
|           XBench Database Generator v1.0           |
|         (c)2002 by University of Waterloo          |
 ----------------------------------------------------

Database Class: [1]TC/SD [2]TC/MD [3]DC/SD [4]DC/MD
Please choose database class (any other key to exit):
*******************************************************
Choose from [1,4] representing Text-Centric Single Document class,
Text-Centric Multiple Document class, Data-Centric Single Document
class and Data-Centric Multiple Document class, respectively.
Hit on any other key will exit the program.

After choose the document class, you should see the following
output:
****************************************************
Database Size: [1]Small [2]Normal [3]Large [4]Huge
Please choose database size (default is Normal):
****************************************************
Choose from [1,4] representing the size of database: small (10MB),
normal (100MB), Large (1GB) and Huge (10GB). Hit on any other key
will set the size of database to normal.

After that, you can sit back and the database generator will
generate XML documents in output directory. Depending on the
document class and database size, and the speed of your machine,
generation time may vary.


4. DOCUMENT CLASS, SCHEMA, DTD, AND XML DOCUMENT
------------------------------------------------
The following list describes the XML documents that are included
in each document class and the XML schema/DTD files to which they
conform (XXX represents numbers and any documents ending with XXX
means these are a set of files).

---------------------------------------------------------------
Document Class |    Schema    |     DTD      | XML Document
    TC/SD      |   TCSD.xsd   |   TCSD.dtd   | dictionary.xml
    TC/MD      |   TCMD.xsd   |   TCMD.dtd   | articleXXX.xml
    DC/SD      |   DCSD.xsd   |   DCSD.dtd   | catalog.xml
    DC/MD      | DCMDOrd.xsd  | DCMDOrd.dtd  | orderXXX.xml
    DC/MD      | DCMDCust.xsd | DCMDCust.dtd | customer.xml
    DC/MD      | DCMDItem.xsd | DCMDItem.dtd | item.xml
    DC/MD      | DCMDAuth.xsd | DCMDAuth.dtd | author.xml
    DC/MD      | DCMDAddr.xsd | DCMDAddr.dtd | address.xml
    DC/MD      | DCMDCoun.xsd | DCMDCoun.dtd | country.xml
---------------------------------------------------------------


5. OTHERS
---------
Detailed information of this database generator can be found in the
technical report.

Please send your comments and suggestions to the authors for future
improvements.
*Benjamin Bin Yao (bbyao AT uwaterloo.ca)
*M. Tamer Ozsu (tozsu AT uwaterloo.ca)