README

   1 \r
   2 Bob is an XML Data Binding tool. 'Bob' provides a convenient way to bind XML definitions to object representations. It can be used for:\r
   3     1. application prototyping\r
   4     2. rapid application development\r
   5     3. easily handling large amounts of xml data\r
   6 \r
   7 The idea is to map out your business objects in xml. Xml tags with matching names and namespaces can be mentioned across many documents and still represent the same business object.\r
   8 \r
   9 There are some articles that go into the utility and features if Data Binding tools:\r
  10 http://www.xml.com/pub/a/2003/09/03/binding.html\r
  11 http://www-106.ibm.com/developerworks/library/x-databdopt/index.html\r
  12 \r
  13 'XML Data Binding Resources'\r
  14 http://www.rpbourret.com/xml/XMLDataBinding.htm\r
  15 \r
  16 \r
  17 FEATURES:\r
  18     -- 'n' documents. definition set generated from multiple documents\r
  19     -- same tag & namespace. is part of same definition across documents\r
  20     -- write objects out with 'toXML()'\r
  21 \r
  22 \r
  23 USAGE:\r
  24     \r
  25     java -classpath $CP com.interrupt.bob.Main $xml_files\r
  26 \r
  27     options:\r
  28         gen - directory in which to put generated documents (deafult: gen)\r
  29         base - the base directory from which to run 'bob'   (default: .)\r
  30         end - select xml files with a given suffix          (default: .xml)\r
  31         \r
  32         ex) \r
  33         java -classpath $CP com.interrupt.bob.Main -gen gen/ -base . -end xml $xml_files\r
  34 \r
  35 \r
  36 IBob:\r
  37     content/accessors\r
  38     attributes/accessors\r
  39 \r
  40     all\r
  41     adders\r
  42     removers\r
  43     finders\r
  44 \r
  45     toXML\r
  46 \r
  47     CDATA\r
  48     attribute type definition\r
  49 \r
  50     \r
  51 \r
  52 LIBRARY DEPENDANCIES:\r
  53 \r
  54     Piccolo.jar (http://piccolo.sourceforge.net/)\r
  55     commons-cli-1.0.jar (http://jakarta.apache.org/commons/cli/)\r
  56     javafind.jar (http://sourceforge.net/projects/javafind/)\r
  57     velocity-1.3.1.jar (http://jakarta.apache.org/velocity/)\r
  58     velocity-dep-1.3.1.jar\r
  59 \r
  60     \r
  61 ISSUES\r
  62     -- xml attributes cannot be named 'tagName' as this conflicts with bob internals\r
  63     -- xml attributes cannot have dashes in thier names\r
  64     -- tags cannot have more than 1 child with the same name (even with different packages)\r
  65     -- user should specify type of subclass to generated classes; default to 'GClazz' is 'Clazz'\r
  66         -- 'Bob' needs bob.jar to compile and begin the compile process. This is because the Queue & DocumentProcessor\r
  67                 portion of the code uses generated 'Bob' classes, which need to be generated and compiled to be used. \r
  68                 This makes it neccessary to have 'bob.jar' as part of the required libraries of 'Bob'.\r
  69 \r
  70 \r
  71 \r