home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Demos / OOFILE / docs / readme.txt < prev    next >
Encoding:
Text File  |  1995-09-28  |  5.5 KB  |  208 lines  |  [TEXT/ttxt]
  1. 95/09/28
  2. This is OOFILE beta release 1.04
  3.  
  4. The main focus of this release is framework integration and combinatorial
  5. searches, including compound indexes (which are also read-only fields).
  6.  
  7. A significant amount of testing has improved the quality of code (more const
  8. cleansing) and MicroQuill's SmartHeap has been used on Mac and Windows.
  9.  
  10. This is the final beta release. The v1.1 retail release will be in the second
  11. week of October.
  12.  
  13. It will include an enhanced version of the report-writer that produces HTML code
  14. (with option of Netscape tables). If people are interested, a beta of the
  15. report-writer can be released before that date.
  16.  
  17. zApp and PowerPlant framework integrations are being released on a separate
  18. schedule - expect a beta release in the first week of October. The PowerPlant
  19. integration includes code generation with AppMaker, and an early demo (not quite
  20. functional beta) was included on the CodeWarrior CW7 CD.
  21.  
  22. 1.2b1 will be out about 2 weeks after v1.1 and will feature indexing by set,
  23. keyword, phonetic, group & method and filtered indexes. We decided to complete
  24. the v1.1 release without these features to allow more time for testing and your
  25. reactions to their design.
  26.  
  27.  
  28. Summary of features
  29. -------------------
  30. BUGS:
  31. - minor iterator bug fixed (more() allowed you to iterate one rec too many in a
  32.   selection of allRecords().)
  33.  
  34. - bug in ANDing selections of some records (>1 but not all)
  35.  
  36. - portability of databases with blobs from Windows 16bit fixed
  37.  
  38. NEW FEATURES
  39. - Deleting records
  40. - import from streams (for dbChar field types only)
  41. - minor recoding for compatability with gcc 2.7 and CodeWarrior 6 & 7.
  42. - compound (virtual) fields and indices
  43. - combinatorial searches (AND & OR) including automatic use of compound indices
  44.  
  45. FILE REARRANGEMENT
  46. The samples have been renamed to keep them in alphabetical order (eg:
  47. ooftest1.cpp is now ooftst01.cpp) and moved into the "samples" directory.
  48.  
  49. OOFILE source is now in the "source" directory.
  50.  
  51. Sample output from the test programs (where applicable) is in "results".
  52.  
  53. Note: if you want project documents for Borland or CodeWarrior please ask. We
  54. will also be creating makefiles for different environments, for the retail
  55. release.
  56.  
  57. DOCUMENTS (see changes.txt for which of these have changed):
  58. (reading order at end)
  59.  
  60. start.txt 
  61. - instructions on how to get started
  62.  
  63. status.txt 
  64. - list of features implemented and planned
  65.  
  66. changes.txt 
  67. - change history
  68.  
  69. ctree.txt
  70. - some internals doc for the c-tree Plus backend
  71.  
  72. debug.txt
  73. - info on debugging flags and the tests they perform
  74.  
  75. fields.txt
  76. - lists the field types and operations
  77.  
  78. gotchas.txt
  79. - list of common "gotchas" found by beta testers. Some of these issues
  80.   may be removed over time.
  81.  
  82. gui.txt
  83. - describes common GUI integration philosophy in detail
  84.  
  85. guicases.txt
  86. - describes GUI integration in terms of Use Cases - the situations which 
  87.   should be handled by the GUI integration classes
  88.  
  89. guihooks.txt
  90. - describes points where you can hook in to easily customise 
  91.   gui integration behaviour, particularly editing records
  92.  
  93. internals.txt
  94. - list of classes owning heap memory, and the relevant members
  95.   (will be expanded to include more internals doc)
  96.  
  97. limits.txt
  98. - database size limits
  99.  
  100. misc.txt
  101. - programming conventions
  102. - a few idioms used in oofile
  103. - a resource list of recommended books and net resources
  104.  
  105. multi.txt
  106. - discussion of how multi-user features work
  107.  
  108. odmg.txt
  109. - OOFILE vs ODMG-93 standard
  110.  
  111. patterns.txt
  112. - describes OOFILE in terms of the GOF Patterns, and our own efforts. 
  113. (See "Design Patterns" by Gamma, Helm, Johnson & Vlissides)
  114.  
  115. pplant.txt
  116. - describes MetroWerks' PowerPlant GUI integration
  117.  
  118. relation.txt
  119. - documents how relations work - an overview and details
  120.  
  121. srcfiles.txt
  122. - describe how OOFILE classes are divided amongst files
  123.  
  124. testplan.txt
  125. - some issues in testing, and list of platform coverage of in-house testing
  126.  
  127. valprogs.txt
  128. - list of the sample programs, which also serve as a validation suite for 
  129.   regression testing
  130.  
  131. xplat.txt
  132. - discusses cross-platform database issues, including optional longword align
  133.  
  134. zapp.txt
  135. - documents the zApp integration classes. These provide a good example for 
  136.   writing your own integration classes (and we will be providing other 
  137.   frameworks in the near future).
  138.  
  139.  
  140. READING ORDER
  141. If just interested, or getting started
  142.     start
  143.     fields
  144.     relation
  145.     misc
  146.  
  147. If want to compare OOFILE to other OODBMS
  148.     odmg
  149.  
  150. Summary of test/example programs
  151.     valprogs
  152.  
  153. Essential reading when wanting to start using OOFILE
  154.     debug
  155.     gotchas
  156.     xplat
  157.  
  158. If want to use multi-user databases
  159.     multi
  160.  
  161. Docs not worth reading unless interested in how product works
  162.     ctree
  163.     limits
  164.     internals
  165.     patterns
  166.  
  167.  
  168. To get a quick idea of places to customise gui behaviour
  169.     guihooks.txt
  170.  
  171. To understand facilities provided by gui integration
  172.     guicases.txt
  173.     gui.txt
  174.  
  175. Specific details on particular gui implementations
  176.     pplant.txt
  177.     zapp.txt
  178.  
  179.  
  180. Contact:
  181. Andy Dent
  182. A.D. Software
  183. 94 Bermuda Dve
  184. Ballajura  WA  6066
  185. Australia
  186.  
  187. phone/fax +61 9 249 2719
  188. Internet: dent@highway1.com.au
  189. CompuServe: 100033,3241
  190. ftp://perth.highway1.com.au:/pub/adsoftware/oofile/
  191. http://www.highway1.com.au/adsoftware/
  192.  
  193. Mailing lists:
  194. oofile@perth.highway1.com.au
  195.  
  196. You can subscribe to the list by mailing to:
  197. majordomo@highway1.com.au  (or listserv@highway1.com.au)
  198. with "subscribe oofile" in the body of the message
  199.  
  200.  
  201. c-treetimes@perth.highway1.com.au
  202. This is a general list for anyone using the c-tree Plus database, not just
  203. OOFILE users.
  204.  
  205. You can subscribe to the list by mailing to:
  206. majordomo@highway1.com.au  (or listserv@highway1.com.au)
  207. with "subscribe c-treetimes" in the body of the message
  208.