Permalink
Browse files

Added README.md

  • Loading branch information...
1 parent 0adec4c commit 524d6d2fa6fe601753dc3b2618b3c4c5a07efe54 Brandon Tilley committed Mar 8, 2010
Showing with 81 additions and 0 deletions.
  1. +81 −0 README.md
View
@@ -0,0 +1,81 @@
+What is JUDAW
+=============
+
+The Java UniData API Wrapper is a small collection of Java classes designed to
+assist with connecting to and querying off a UniData data source. Example source
+can be found at the end of this document.
+
+Dependencies
+============
+
+Note that the library is dependent on the Java UniObjects SDK located in
+`asjava.zip` from the IBM Developer's Kit (UniDK). This file is included in
+the JUDAW repository in the `deps` directory. The version number for the
+included version of this file is in the `VERSION` file in the same directory.
+
+Special Thanks
+==============
+
+A special thanks to Rich Harrington and others from
+[University Web Developers][uwd] for introducing me to the UniObjects API and
+for great initial code posts, which inspired this project.
+
+Example Code
+============
+
+Creating and Connecting to the UniDataConnection Object
+-------------------------------------------------------
+
+ UniDataConnection ud = new UniDataConnection("username", "password",
+ "datatel.domain.local", "D:\\account\\path");
+ ud.connect();
+
+Accessing the Underlying UniJava Object
+---------------------------------------
+
+In version 1.2:
+
+ System.out.println("Using UniData SDK version " + ud.UniJava.getVersionNumber());
+ System.out.println("Connection number " + ud.UniJava.getNumSessions() +
+ " of " + ud.UniJava.getMaxSessions());
+
+In master and version 1.3+, accessing the UniJava object directly is
+deprecated, and you should use the UniJava() getter instead:
+
+ System.out.println("Using UniData SDK version " + ud.UniJava().getVersionNumber());
+ System.out.println("Connection number " + ud.UniJava().getNumSessions() +
+ " of " + ud.UniJava.getMaxSessions());
+
+Opening a File and Reading a Record
+
+ UniSession session = ud.getSession();
+ UniFile person = session.open("PERSON");
+ person.setRecordID("0123456");
+ System.out.println("First Name: " + person.readNamedField("FIRST.NAME"));
+ System.out.println("Last Name: " + person.readNamedField("LAST.NAME"));
+
+Selecting Data with SELECT and LIST Wrappers
+
+ ud.query("SELECT PERSON WITH @ID EQ '0123456''0654321'");
+ // A map of Field objects to specify which
+ // fields we wish to retrieve data from:
+ Map<String,String> fields = new HashMap<String, String>();
+ fields.put("FIRST.NAME", "fname");
+ fields.put("LAST.NAME", "lname");
+ List<FieldSet> sets = ud.getFields("PERSON", fields);
+ if(sets == null)
+ System.out.println("No data returned.");
+ Iterator<FieldSet> iter = sets.iterator();
+ while(iter.hasNext())
+ {
+ // A FieldSet contains information regarding the field name,
+ // the friendly field name we used (if any), and the
+ // data contained within the field.
+ // Each row is turned into a FieldSet, and each FieldSet contains a number
+ // of Fields (based on the second parameter to getFields).
+ FieldSet set = iter.next();
+ System.out.println("Last Name: " + set.getFieldByName("LAST.NAME").getData());
+ System.out.println("First Name: " + set.getFieldByFriendlyName("fname").getData());
+ }
+
+[uwd]: http://cuwebd.ning.com/ "University Web Developers"

0 comments on commit 524d6d2

Please sign in to comment.