home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: Java / Java.zip / rdb084r2.zip / MaxBase.doc < prev    next >
Text File  |  1997-03-15  |  6KB  |  167 lines
  1. This is the official documentation for MaxBase V 2.4
  2.  
  3. Index:
  4.  
  5.   1 .. What Is MaxBase?
  6.   2 .. Features available
  7.   3 .. Menu Structure
  8.   4 .. Limitations
  9.   5 .. Legal Stuff
  10.  
  11.  
  12. 1 What is MaxBase?
  13. ------------------
  14.  
  15. MaxBase is a graphical tool that allows you to manage your 
  16. databases, both as a database administrator (working with DBs structure), 
  17. and as a user. Of course the db created with MaxBase are compatible with 
  18. the RXDbase class, and vice versa, since MaxBase is only a front end 
  19. to the RXDbase APIs. 
  20. At the moment, nearly all of the RXDbase 0.84 features are implemented.
  21.  
  22. MaxBase can be useful if you want to create a DB without 'hardwiring' it
  23. into your application. When you create a new DB with MaxBase, you actually 
  24. create a .DAT and some (at least one) .IDX files.
  25. Ship these all with your application, and simply connect to them with a 
  26. xxx.connect(rFileName) in your source.
  27.  
  28. MaxBase can be used as a stand-alone application, also, and so now you've
  29. found a truly portable phone book (and now it's fast, too). :)
  30.  
  31.  
  32.  
  33. 2 Features available:
  34. ---------------------
  35.  
  36. First of all, let's say that not all the features are available at any
  37. time; they show up only when they make sense (i.e. you won't see 
  38. the 'logout' function if you're not logged in to a database).
  39.  
  40. Also, you can select which of the standard MaxBase's functions are to be
  41. activated upon MaxBase startup. If MaxBase finds a file called maxbase.mnu
  42. then it reads all the strings in it, and labels buttons and text bits
  43. after those strings. If a button string is set to '-' (the dash character,
  44. without the single-quotes), then that button is disabled. If maxbase.mnu
  45. doesn't exist, then the default strings will be used.
  46.  
  47. NB: All the messages and buttons presented to the user are configurable
  48. through the customization of maxbase.mnu ASCII file, and that means also 
  49. that you can _translate_ maxbase from english to other languages (as 
  50. examples I've put in this package the english and the italian translations; 
  51. if you translated MaxBase into another language let me know!).
  52.  
  53. MaxBase can be given a parameter in the command line: the name of the
  54. database to log in to at startup (trailing .dat extension NEEDED).
  55. E.g.: 'java MaxBase imgs.dat' or (OS/2's 1.0.1 Java) 'javapm MaxBase imgs.dat'
  56.  
  57.  
  58. Just another thing: you can expand MaxBase functionalities through
  59. the use of plug-ins. Refer to the plugins.zip package for more details.
  60.  
  61.  
  62. ".dbf->.dat" lets you convert a DB III/IV file into RXDbase native format.
  63.  
  64. ".dat->.dbf" converts a RXDbase native file into a DBIII/IV archive.
  65.  
  66. "Login" and "Logout" functions let you connect to a database, and the 
  67. records that this latter contains will be displayed .
  68.  
  69. "Del DB" lets you delete from the HD the db on which you're working.
  70.  
  71. "New DB" is meant for creation of a new database.
  72.  
  73. "Pack DB" lets you pack the archive: it deletes the records that are 
  74. marked as 'discarded' and rebuilds all the indexes. It may take some
  75. time.
  76.  
  77. "Add Fld" - "Del Fld" allow you to add/delete fields from the archive
  78. while it is still open. Warning: you must have at least one indexed
  79. field on the archive (you won't be able to delete the last indexed
  80. field).
  81.  
  82. "Sel All" - "Des All" do selects/deselect all the records that are loaded
  83. into MaxBase.
  84.  
  85. "Mod Index" lets you modify the indexing strategy for a field; it works
  86. similarly to "Add/Del Fld".
  87.  
  88. "Property" brings up a panel where you can state if you want to load for 
  89. display all the articles in the archive or the first 50 only. It defaults
  90. to the first 50, and helps keeping MaxBase quick (it will be more useful
  91. when the 'search' functions will be introduced).
  92.  
  93. "Add" - "Modify" - "Delete" do what the names suggest; they work with records.
  94.  
  95. "Form View" lets you see the currently selected record in, guess what, 
  96. a form view. This can be very useful, for example if you have records 
  97. which length makes them not to appear fully in the one-line view, or if
  98. you need to put in the clipboard the contents of a field (E-mail addresses
  99. or home page URLs come to mind).
  100.  
  101. "Order By" Lets you choose which index to order the db on.
  102.  
  103. "Refresh Now" refresh the current view with the contents of the db stored on
  104. disk. Useful if you are using the "First 50" visualization strategy and delete
  105. a lot of records.
  106.  
  107. "Set Filter" Lets you set filtering conditions for the records showed.
  108. A note about filtering:
  109.  Filter sentences are divided by the .&. token, which means "logical AND".
  110.  You can setup as many as 100 of them.
  111.  
  112. From RXDbase.doc (adapted):
  113. -----------
  114. Operators recognized: >,>=,<,<=,=,<>.
  115. Wildcards are allowed only for the = and <> operators, and they are represented by
  116. the symbol '*', which means "every number of any character".
  117. So, Ro* can be Robert, Ronald, etc. 
  118.     *t can be Matt, Robert, etc.
  119.     M*t can be Matt, mount, etc. (The search is always case-insensitive)
  120.  
  121. You can use only one '*' on a given filter (e.g. you can't query for "Name = *u*i*l*"),
  122. with the notable exception of the form *value*, which means "find a substring anywhere
  123. that is equal to 'value'".
  124. Example: "Telephone = *555*" will search for all phone numbers with a 555 in them.
  125.  
  126. If you specify a filter condition when another one is in use, the first one will be
  127. dropped, and the most recent one will be used.
  128.  
  129. Passing as a value the null string will reset the filter conditions.
  130. -----------
  131. Example of valid filter sentence:
  132. Name=M* .&. Surname =Johnson .&. Age >25 .&. Sex = M
  133.  
  134.  
  135.  
  136.  
  137. 3 Menu Structure
  138. ----------------
  139.  
  140. Main Panel   : 'Tools..'  'Records..'  'Login|Logout'  'Sel All'  'Des All'  'Order By..'  <Plugins,if any>
  141.  
  142. Tools Panel  : 'New DB' 'Del DB' 'Pack DB' 'Add Fld' 'Del Fld' 'Mod Index' '.dbf->.dat' '.dat->.dbf' 'Properties' 'Main Panel..'
  143.  
  144. Records Panel: 'Add' 'Modify' 'Delete' 'Set Filter' 'Form View' 'Refresh Now' 'Main Panel..'
  145.  
  146.  
  147.  
  148. 4 Limitations: (these may be removed as MaxBase is enhanced)
  149. --------------
  150.  
  151. You can create only DBs with <100 fields, although you can LOAD db with
  152. more than 99 fields.
  153.  
  154. Record undelete is not supported.
  155.  
  156. MaxBase works only with files that are stored in the directory where MaxBase
  157. resides.
  158.  
  159.  
  160.  
  161. 5 Legal Stuff
  162. -------------
  163.  
  164. MaxBase is a graphic frontend for the RXDbase class. It follows the RXDbase
  165. licensing schema. See RXDbase.doc for details.
  166. MaxBase is (c) Max Marsiglietti 1996, 97.
  167.