First batch of the tools merged in...

Author: Peter Mount

contrib/retep/CHANGELOG

@@ -1,4 +1,7 @@
+Fri Mar 02 16:08:00 GMT 2001 peter@retep.org.uk
+    - Started importing in the rest of the retep tools.
+
 Tue Jan 23 10:19:00 GMT 2001 peter@retep.org.uk
-        - Finished the XML Export classes
+    - Finished the XML Export classes
 	- First of the test data suite now in CVS.
 

contrib/retep/Implementation

@@ -0,0 +1,116 @@
+Retep Tools Implementation
+--------------------------
+
+
+The tools are designed to be put into a single jar file, but each one is
+executable either individually or part of one single application.
+
+To run the big application, you can either:
+
+  java -jar retepTools.jar
+
+or with the retepTools.jar in the classpath run:
+
+  java uk.org.retep.tools.Main
+
+Windows users: For you you can also double click the retepTools.jar as windows
+will automatically run javac for you.
+
+To run the individual tools, you must have the .jar file in your classpath and
+then run the relevant Main class.
+
+Tool                          Type        Class
+------------------------------------------------------------------------------
+pg_hba.conf Editor/repairer   Editor      uk.org.retep.util.hba.Main
+Properties Editor             Editor      uk.org.retep.util.proped.Main
+
+
+Layout of the classes
+---------------------
+
+Simply, tools that work on property files (Java properties, resource files,
+configuration settings - pg_hba.conf for example) go under uk.org.retep.util in
+their own package. Other utility classes (like PropertyIO) go in to the
+uk.org.retep.util.misc package except for certain ones where they are related.
+
+ie: TableModels. In swing you have JTable which uses a TableModel to display
+(and possibly update) some data. These go under uk.org.retep.util.models where
+you will find PropertiesTableModel for example. This one allows a Properties
+object to be displayed & updated.
+
+Come core classes like Logger, ExceptionDialog etc go into the main
+uk.org.retep.util package.
+
+Directory/Package                   Contents
+------------------------------------------------------------------------------
+uk.org.retep                        Home of the tools.properties file
+uk.org.retep.tools                  The main all-in-one application
+uk.org.retep.dtu                    The Data Transform Unit
+uk.org.retep.util                   Core utility classes
+uk.org.retep.util.hba               pg_hba.conf editor/repairer
+uk.org.retep.util.misc              Misc utility classes
+uk.org.retep.util.models            Swing table models
+uk.org.retep.util.proped            Property Editor
+uk.org.retep.util.xml.core          Basic XML Factory
+uk.org.retep.util.xml.jdbc          JDBC/XML interface
+uk.org.retep.util.xml.parser        Simple SAX parser
+
+Structure of a tool
+-------------------
+
+Each tool has at least 2 base classes, and an entry in the tools.properties
+file. For this example, I'll show you the Properties Editor:
+
+Base package      uk.org.retep.util.proped
+Main tool class   uk.org.retep.util.proped.PropertyEditor
+Standalone class  uk.org.retep.util.proped.Main
+
+The main tool class is the entry point used by the main application. Because
+they are used in a GUI, this class must extend javax.swing.JComponent and
+implement the uk.org.retep.tools.Tool interface. (NB: You will find I always
+use JPanel, but JComponent is used here so that any swing class can be used
+you are not limited to JPanel.)
+
+The standalone class is a basic static class that implements the main method.
+It should extend the uk.org.retep.misc.StandaloneApp class and be written along
+the lines of the following example:
+
+      import uk.org.retep.util.StandaloneApp;
+      import javax.swing.JComponent;
+
+      public class Main extends StandaloneApp
+      {
+        public Main(String[] args)
+        throws Exception
+        {
+          super(args);
+        }
+
+        public JComponent init()
+        throws Exception
+        {
+          // Your initialisation here. In this case the PropertyEditor
+          PropertyEditor panel = new PropertyEditor();
+
+          // do stuff here, ie load a file if supplied
+
+          // return the tool
+          return panel;
+        }
+
+        public static void main(String[] args)
+        throws Exception
+        {
+          Main main = new Main(args);
+          main.pack();
+          main.setVisible(true);
+        }
+      }
+
+you will find a template in the uk.org.retep.util.Main class. Simply copy this
+classes source, as it gives you the basic stub. Just add your own implementation
+if init() like the one above. Look at the full Main class for the
+PropertiesEditor to see how to get at the command line args.
+
+By convention, the standalone class is named Main.
+

contrib/retep/README

@@ -0,0 +1,35 @@
+Before you ask what retepTools are, they are my personal suite of utilities.
+About 90% of them are JDBC related (either they use JDBC, or I use them in
+developing the JDBC driver).
+
+Now, because of various reasons I won't go into now, in January 2001 I decided
+to release the entire lot to the public. I could have used something like
+SourceForge, but as they are mainly JDBC related I thought here is the best
+place.
+
+Now all (bar retepPDF, see end-note) will over the next few months be going
+into the /contrib/retep directory. They range from simple XML Inport/Export
+classes to entire sub-systems that can be plugged into applications.
+
+All this lot were never released, so I'm placing them under PostgreSQL's
+licence.
+
+Please refer to Implementation for details of what package does what.
+
+It all requires Java2SE (JDK1.2) as a minimum. I do have some plans for some
+EJB tools later, so those will need Java2EE, but not yet ;-)
+
+Peter Mount
+peter@retep.org.uk
+March 2 2001
+
+retepPDF: This is not included for two reasons:
+
+1: It's big and not really related in any way to PostgreSQL
+2: More importantly, I (may be foolishly) released it some 3 years ago under
+   the LGPL. As a few people have added to it, it's not really possible to
+   change the licence, and I don't want to polute PostgreSQL's source tree ;-)
+
+retepGraph: This was an old graphics library. It's been obsolete for 3 years
+now, so it's not going in.
+

contrib/retep/build.xml

@@ -2,7 +2,7 @@
 
   build file to build the donated retep tools packages
 
-  $Id: build.xml,v 1.2 2001/01/23 10:22:18 peter Exp $
+  $Id: build.xml,v 1.3 2001/03/05 09:15:35 peter Exp $
 
 -->
 
@@ -35,16 +35,16 @@
   </target>
 
   <!-- Builds the XML Tools -->
-  <target name="xml" depends="checks,prepare" if="xml">
+  <target name="compile" depends="checks,prepare">
     <javac srcdir="${src}" destdir="${dest}">
-      <include name="${package}/xml/**" />
+      <include name="${package}/**" />
     </javac>
   </target>
 
   <!-- Builds the various jar files -->
-  <target name="jar" depends="xml">
+  <target name="jar" depends="compile">
     <jar jarfile="${jars}/retepTools.jar" basedir="${dest}">
-      <include name="${package}/xml/**" if="xml" />
+      <include name="${package}/**" />
     </jar>
   </target>
 

contrib/retep/retep.jpx

@@ -4,6 +4,12 @@
 <project>
   <property category="idl" name="ProcessIDL" value="false" />
   <property category="runtime.0" name="RunnableType" value="com.borland.jbuilder.runtime.ApplicationRunner" />
+  <property category="runtime.0" name="application.class" value="uk.org.retep.util.hba.Main" />
+  <property category="runtime.0" name="application.parameters" value="-d2 pg_hba.conf" />
+  <property category="runtime.0" name="appserver.ejbJarsSaved" value="1" />
+  <property category="runtime.0" name="appserver.parameters" value="-jts -jns -jss -jdb" />
+  <property category="runtime.0" name="appserver.servername" value="ejbcontainer" />
+  <property category="runtime.0" name="appserver.vmparameters" value="" />
   <property category="runtime.0" name="jsprunner.docbase" value="." />
   <property category="runtime.0" name="jsprunner.jspfile" value="E%|/docs/java/xml/example6" />
   <property category="sys" name="AuthorLabel" value="@author" />
@@ -15,7 +21,7 @@
   <property category="sys" name="CompanyLabel" value="Company:" />
   <property category="sys" name="Copyright" value="Copyright (c) 2001" />
   <property category="sys" name="CopyrightLabel" value="Copyright:" />
-  <property category="sys" name="DefaultPackage" value="uk.org.retep.xml.jdbc" />
+  <property category="sys" name="DefaultPackage" value="uk.org.retep.util.misc" />
   <property category="sys" name="Description" value="" />
   <property category="sys" name="DescriptionLabel" value="Description:" />
   <property category="sys" name="DocPath" value="doc" />
@@ -25,7 +31,7 @@
   <property category="sys" name="InstanceVisibility" value="0" />
   <property category="sys" name="JDK" value="java 1.3.0-C" />
   <property category="sys" name="LastTag" value="0" />
-  <property category="sys" name="Libraries" value="JAXP;Oracle JDBC" />
+  <property category="sys" name="Libraries" value="JAXP;Oracle JDBC;JDK1.3 JRE" />
   <property category="sys" name="MakeStable" value="0" />
   <property category="sys" name="OutPath" value="build" />
   <property category="sys" name="SourcePath" value="." />
@@ -34,13 +40,17 @@
   <property category="sys" name="Version" value="1.0" />
   <property category="sys" name="VersionLabel" value="@version" />
   <property category="sys" name="WorkingDirectory" value="." />
-  <node type="Folder" name="core" />
+  <node type="Package" name="uk.org.retep.app" />
+  <node type="Package" name="uk.org.retep.dtu" />
+  <node type="Package" name="uk.org.retep.tools" />
+  <node type="Package" name="uk.org.retep.util" />
   <node type="Package" name="uk.org.retep.xml.core" />
   <node type="Package" name="uk.org.retep.xml.jdbc" />
   <node type="Package" name="uk.org.retep.xml.parser" />
   <file path="build.xml" />
   <file path="CHANGELOG" />
   <file path="Implementation" />
+  <file path="uk/org/retep/util/models/PropertiesTableModel.java" />
   <file path="README" />
 </project>