637 lines
		
	
	
	
		
			17 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			637 lines
		
	
	
	
		
			17 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
 | |
| <!--NewPage-->
 | |
| <HTML>
 | |
| <HEAD>
 | |
| <TITLE>
 | |
| jala.db.FileDatabase
 | |
| </TITLE>
 | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
 | |
| </HEAD>
 | |
| <SCRIPT>
 | |
| function asd()
 | |
| {
 | |
| parent.document.title="jala.db.FileDatabase";
 | |
| }
 | |
| </SCRIPT>
 | |
| <BODY BGCOLOR="white" onload="asd();">
 | |
| 
 | |
| <!-- ========== START OF NAVBAR ========== -->
 | |
| <A NAME="navbar_bottom"><!-- --></A>
 | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 | |
| <TR>
 | |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A>
 | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 | |
|   <TR ALIGN="center" VALIGN="top">
 | |
|   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
 | |
|   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="overview-summary-Database.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
 | |
|   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
 | |
|   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
 | |
|   <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
 | |
|   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
 | |
|   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
 | |
|   </TR>
 | |
| </TABLE>
 | |
| </TD>
 | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 | |
| <B>Jala 1.3</B>
 | |
| </EM>
 | |
| </TD
 | |
| </TR>
 | |
| 
 | |
| <TR>
 | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 | |
|  <A HREF="jala.db.html"><B>PREV CLASS</B></A><!-- 
 | |
|    NEXT CLASS 
 | |
| -->
 | |
|  <A HREF="jala.db.RamDatabase.html"><B>NEXT CLASS</B></A></FONT></TD>
 | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 | |
|   <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>   
 | |
|  <A HREF="jala.db.FileDatabase.html" TARGET="_top"><B>NO FRAMES</B></A>   
 | |
|  
 | |
| <SCRIPT>
 | |
|   <!--
 | |
|   if(window==top) {
 | |
|     document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
 | |
|   }
 | |
|   //-->
 | |
| </SCRIPT>
 | |
| <NOSCRIPT>
 | |
| <A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
 | |
| </NOSCRIPT>
 | |
| </FONT></TD>
 | |
| </TR>
 | |
| <TR>
 | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 | |
|   SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
 | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
 | |
| </TR>
 | |
| </TABLE>
 | |
| <!-- =========== END OF NAVBAR =========== -->
 | |
| <HR>
 | |
| 
 | |
| <!-- ======== START OF CLASS DATA ======== -->
 | |
| <H2>Class jala.db.FileDatabase</H2>
 | |
| <PRE>Object
 | |
|    |
 | |
|    +--<a href='jala.db.RamDatabase.html'>jala.db.RamDatabase</a>
 | |
|          |
 | |
|          +--<b>jala.db.FileDatabase</b>
 | |
| </PRE>
 | |
| 
 | |
| 
 | |
| <HR>
 | |
| <DL>
 | |
|    <!-- Class definition -->
 | |
|    <DT>class 
 | |
|    <B>jala.db.FileDatabase</B>
 | |
|    
 | |
|       <DT>extends <a href='jala.db.RamDatabase.html'>jala.db.RamDatabase</a> 
 | |
|    
 | |
| 
 | |
| </DL>
 | |
|    
 | |
|    <P>
 | |
|    <BR/>Instances of this class represent a file based in-process database
 | |
|  <br /><strong>Important:</strong> You need the h2.jar in directory "lib/ext"
 | |
|  of your helma installation for this library to work, which you can get
 | |
|  at http://www.h2database.com/.
 | |
|  <BR/><I>Defined in <a href='overview-summary-Database.js.html'>Database.js</a></I><BR/><BR/>
 | |
|    </P>
 | |
|    
 | |
|    <HR>
 | |
| 
 | |
| <!-- ======== NESTED CLASS SUMMARY ======== -->
 | |
| 
 | |
| <!-- ======== END NESTED CLASS SUMMARY ======== -->
 | |
| 
 | |
| 
 | |
| <!-- =========== FIELD SUMMARY =========== -->
 | |
| 
 | |
| 
 | |
|    
 | |
| 
 | |
| <!-- =========== END FIELD SUMMARY =========== -->
 | |
| 
 | |
| 
 | |
| <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 | |
| 
 | |
| <A NAME="constructor_summary"><!-- --></A>
 | |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 | |
| <TD COLSPAN=2><FONT SIZE="+2">
 | |
| <B>Constructor Summary</B></FONT></TD>
 | |
| </TR>
 | |
| <TR BGCOLOR="white" CLASS="TableRowColor">
 | |
|    <TD>
 | |
|       <CODE>
 | |
| 	 <B>
 | |
| 	    <A HREF="jala.db.FileDatabase.html#jala.db.FileDatabase()">jala.db.FileDatabase</A> 
 | |
| 	 </B>
 | |
| 	 (<String> name, <helma.File> directory, <String> username, <String> password)
 | |
|       </CODE>
 | |
|       <BR>
 | |
|                  
 | |
|       Returns a newly created instance of FileDatabase.
 | |
|       </TD>
 | |
| </TR>
 | |
| </TABLE>
 | |
| 
 | |
| <!-- ======== END CONSTRUCTOR SUMMARY ======== -->
 | |
| 
 | |
|  
 | |
| 
 | |
| <!-- ========== METHOD SUMMARY =========== -->
 | |
| 
 | |
| <A NAME="method_summary"><!-- --></A>
 | |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 | |
| <TD COLSPAN=2><FONT SIZE="+2">
 | |
| <B>Method Summary</B></FONT></TD>
 | |
| </TR>
 | |
| 
 | |
| 
 | |
|    <TR BGCOLOR="white" CLASS="TableRowColor">
 | |
|       <TD ALIGN="right" VALIGN="top" WIDTH="1%">
 | |
| 	 <FONT SIZE="-1">
 | |
| 	    <CODE> Boolean</CODE>
 | |
| 	 </FONT>
 | |
|       </TD>
 | |
|       <TD>
 | |
| 	 <CODE>
 | |
| 	    <B>
 | |
| 	       <A HREF="#backup">backup</A></B>(<helma.File> file)
 | |
| 	 </CODE>
 | |
| 	 <BR>
 | |
| 	           
 | |
| 	 Creates a backup of this database, using the file passed as argument.
 | |
|       </TD>
 | |
|    </TR>
 | |
| 
 | |
|    <TR BGCOLOR="white" CLASS="TableRowColor">
 | |
|       <TD ALIGN="right" VALIGN="top" WIDTH="1%">
 | |
| 	 <FONT SIZE="-1">
 | |
| 	    <CODE> helma.File</CODE>
 | |
| 	 </FONT>
 | |
|       </TD>
 | |
|       <TD>
 | |
| 	 <CODE>
 | |
| 	    <B>
 | |
| 	       <A HREF="#getDirectory">getDirectory</A></B>()
 | |
| 	 </CODE>
 | |
| 	 <BR>
 | |
| 	           
 | |
| 	 Returns the directory where the database files are stored.
 | |
|       </TD>
 | |
|    </TR>
 | |
| 
 | |
|    <TR BGCOLOR="white" CLASS="TableRowColor">
 | |
|       <TD ALIGN="right" VALIGN="top" WIDTH="1%">
 | |
| 	 <FONT SIZE="-1">
 | |
| 	    <CODE> String</CODE>
 | |
| 	 </FONT>
 | |
|       </TD>
 | |
|       <TD>
 | |
| 	 <CODE>
 | |
| 	    <B>
 | |
| 	       <A HREF="#getName">getName</A></B>()
 | |
| 	 </CODE>
 | |
| 	 <BR>
 | |
| 	           
 | |
| 	 Returns the name of the database.
 | |
|       </TD>
 | |
|    </TR>
 | |
| 
 | |
|    <TR BGCOLOR="white" CLASS="TableRowColor">
 | |
|       <TD ALIGN="right" VALIGN="top" WIDTH="1%">
 | |
| 	 <FONT SIZE="-1">
 | |
| 	    <CODE> String</CODE>
 | |
| 	 </FONT>
 | |
|       </TD>
 | |
|       <TD>
 | |
| 	 <CODE>
 | |
| 	    <B>
 | |
| 	       <A HREF="#getPassword">getPassword</A></B>()
 | |
| 	 </CODE>
 | |
| 	 <BR>
 | |
| 	           
 | |
| 	 Returns the password of this database
 | |
|       </TD>
 | |
|    </TR>
 | |
| 
 | |
|    <TR BGCOLOR="white" CLASS="TableRowColor">
 | |
|       <TD ALIGN="right" VALIGN="top" WIDTH="1%">
 | |
| 	 <FONT SIZE="-1">
 | |
| 	    <CODE> String</CODE>
 | |
| 	 </FONT>
 | |
|       </TD>
 | |
|       <TD>
 | |
| 	 <CODE>
 | |
| 	    <B>
 | |
| 	       <A HREF="#getUsername">getUsername</A></B>()
 | |
| 	 </CODE>
 | |
| 	 <BR>
 | |
| 	           
 | |
| 	 Returns the username of this database
 | |
|       </TD>
 | |
|    </TR>
 | |
| 
 | |
|    <TR BGCOLOR="white" CLASS="TableRowColor">
 | |
|       <TD ALIGN="right" VALIGN="top" WIDTH="1%">
 | |
| 	 <FONT SIZE="-1">
 | |
| 	    <CODE> Boolean</CODE>
 | |
| 	 </FONT>
 | |
|       </TD>
 | |
|       <TD>
 | |
| 	 <CODE>
 | |
| 	    <B>
 | |
| 	       <A HREF="#remove">remove</A></B>()
 | |
| 	 </CODE>
 | |
| 	 <BR>
 | |
| 	           
 | |
| 	 Deletes all files of this database on disk.
 | |
|       </TD>
 | |
|    </TR>
 | |
| 
 | |
|    <TR BGCOLOR="white" CLASS="TableRowColor">
 | |
|       <TD ALIGN="right" VALIGN="top" WIDTH="1%">
 | |
| 	 <FONT SIZE="-1">
 | |
| 	    <CODE> Boolean</CODE>
 | |
| 	 </FONT>
 | |
|       </TD>
 | |
|       <TD>
 | |
| 	 <CODE>
 | |
| 	    <B>
 | |
| 	       <A HREF="#restore">restore</A></B>(<helma.File> backupFile)
 | |
| 	 </CODE>
 | |
| 	 <BR>
 | |
| 	           
 | |
| 	 Restores this database using a backup on disk.
 | |
|       </TD>
 | |
|    </TR>
 | |
| 
 | |
| 
 | |
| </TABLE>
 | |
| 
 | |
| 
 | |
| 
 | |
|  <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 | |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 | |
| <TD><B>Methods inherited from class <a href="jala.db.RamDatabase.html">jala.db.RamDatabase</a></B></TD>
 | |
| </TR>
 | |
| <TR BGCOLOR="white" CLASS="TableRowColor">
 | |
| <TD><CODE>
 | |
| <!-- Inherited methods -->
 | |
| <a href="jala.db.RamDatabase.html#getUrl">getUrl</a>, <a href="jala.db.RamDatabase.html#getProperties">getProperties</a>, <a href="jala.db.RamDatabase.html#getConnection">getConnection</a>, <a href="jala.db.RamDatabase.html#shutdown">shutdown</a>, <a href="jala.db.RamDatabase.html#dropTable">dropTable</a>, <a href="jala.db.RamDatabase.html#tableExists">tableExists</a>, <a href="jala.db.RamDatabase.html#copyTables">copyTables</a>, <a href="jala.db.RamDatabase.html#runScript">runScript</a>, <a href="jala.db.RamDatabase.html#dump">dump</a>
 | |
| </CODE></TD>
 | |
| </TR>
 | |
| </TABLE>
 | |
|  
 | |
| 
 | |
| <P>
 | |
| <!-- ========== END METHOD SUMMARY =========== -->
 | |
| 
 | |
| 
 | |
| <!-- ============ FIELD DETAIL START =========== -->
 | |
| 
 | |
| 
 | |
| <!-- ============ FIELD DETAIL END =========== -->
 | |
| 
 | |
|     <!-- ========= CONSTRUCTOR DETAIL START ======== -->
 | |
| 
 | |
| <A NAME="constructor_detail"><!-- --></A>
 | |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 | |
|    <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 | |
|       <TD COLSPAN=1>
 | |
|       <FONT SIZE="+2"><B>Constructor Detail</B></FONT>
 | |
|       </TD>
 | |
|    </TR>
 | |
| </TABLE>
 | |
| 
 | |
| <A NAME="jala.db.FileDatabase()"><!-- --></A><H3>
 | |
| jala.db.FileDatabase</H3>
 | |
| <PRE><B>jala.db.FileDatabase</B>(<String> name, <helma.File> directory, <String> username, <String> password)</PRE>
 | |
| 
 | |
| 
 | |
| <UL>
 | |
|    Returns a newly created instance of FileDatabase.
 | |
| </UL>
 | |
| 
 | |
| 
 | |
| 
 | |
|    <UL>
 | |
|    <B>Parameters:</B>
 | |
|    
 | |
|      <UL><CODE>name</CODE> -  The name of the database. This name is used as  prefix for all database files  
 | |
|      </UL>
 | |
|    
 | |
|      <UL><CODE>directory</CODE> -  The directory where the database files  should be stored in.  
 | |
|      </UL>
 | |
|    
 | |
|      <UL><CODE>username</CODE> -  Optional username (defaults to "sa"). This username  is used when creating the database, so the same should be used when  creating subsequent instances of jala.db.FileDatabase pointing to the  same database  
 | |
|      </UL>
 | |
|    
 | |
|      <UL><CODE>password</CODE> -  Optional password (defaults to "").  
 | |
|      </UL>
 | |
|    
 | |
|    
 | |
|    </UL>
 | |
| 
 | |
| 
 | |
| <!-- Constructor return value(s) -->
 | |
| 
 | |
|    <UL>
 | |
|    <B>Returns:</B>
 | |
|      <UL>
 | |
|      A newly created FileDatabase instance   
 | |
|      </UL>
 | |
|    </UL>
 | |
| 
 | |
| <!-- End constructor return value(s) -->
 | |
| 
 | |
| <!-- ADDITIONAL ATTRIBUTES -->
 | |
| 
 | |
| <HR/>
 | |
| <!-- END ADDITIONAL ATTRIBUTES  -->
 | |
| 
 | |
| <!-- ========= CONSTRUCTOR DETAIL END ======== -->
 | |
| 
 | |
| 
 | |
| <!-- ============ METHOD DETAIL START ========== -->
 | |
| 
 | |
| <A NAME="method_detail"><!-- --></A>
 | |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 | |
|    <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 | |
|       <TD COLSPAN=1><FONT SIZE="+2">
 | |
|          <B>Method Detail</B></FONT>
 | |
|       </TD>
 | |
|    </TR>
 | |
| </TABLE>
 | |
| 
 | |
| <!-- One single method detail entry -->
 | |
| 
 | |
|    <A NAME="backup"><!-- --></A>
 | |
|    <H3>backup</H3>
 | |
|    <PRE>Boolean <B>backup</B>(<helma.File> file)</PRE>
 | |
|    
 | |
|       <UL>Creates a backup of this database, using the file passed as argument. The
 | |
|  result will be a zipped file containing the database files</UL>
 | |
|    
 | |
| 
 | |
|    <!-- METHOD PARAMETERS START -->
 | |
|    
 | |
|    <UL>
 | |
|    <B>Parameters:</B>
 | |
|    
 | |
|      <UL><CODE>file</CODE> -  The file to write the backup to  
 | |
|       </UL> 
 | |
|    
 | |
|    </UL>
 | |
|    
 | |
|    <!-- METHOD PARAMETERS END -->
 | |
| 
 | |
|    
 | |
|    <UL>
 | |
|    <B>Returns:</B>
 | |
|         <UL>
 | |
|         True if the database backup was created successfully, false otherwise   
 | |
|         </UL>
 | |
|    </UL>
 | |
|    
 | |
| 
 | |
|    <!-- ADDITIONAL ATTRIBUTES START -->
 | |
|    
 | |
|    <!-- ADDITIONAL ATTRIBUTES  END -->
 | |
| <HR>
 | |
| 
 | |
|    <A NAME="getDirectory"><!-- --></A>
 | |
|    <H3>getDirectory</H3>
 | |
|    <PRE>helma.File <B>getDirectory</B>()</PRE>
 | |
|    
 | |
|       <UL>Returns the directory where the database files are stored.</UL>
 | |
|    
 | |
| 
 | |
|    <!-- METHOD PARAMETERS START -->
 | |
|    
 | |
|    <!-- METHOD PARAMETERS END -->
 | |
| 
 | |
|    
 | |
|    <UL>
 | |
|    <B>Returns:</B>
 | |
|         <UL>
 | |
|         The directory where this database is stored.   
 | |
|         </UL>
 | |
|    </UL>
 | |
|    
 | |
| 
 | |
|    <!-- ADDITIONAL ATTRIBUTES START -->
 | |
|    
 | |
|    <!-- ADDITIONAL ATTRIBUTES  END -->
 | |
| <HR>
 | |
| 
 | |
|    <A NAME="getName"><!-- --></A>
 | |
|    <H3>getName</H3>
 | |
|    <PRE>String <B>getName</B>()</PRE>
 | |
|    
 | |
|       <UL>Returns the name of the database. This name is used as prefix
 | |
|  for all files of this database in the specified directory</UL>
 | |
|    
 | |
| 
 | |
|    <!-- METHOD PARAMETERS START -->
 | |
|    
 | |
|    <!-- METHOD PARAMETERS END -->
 | |
| 
 | |
|    
 | |
|    <UL>
 | |
|    <B>Returns:</B>
 | |
|         <UL>
 | |
|         The name of the database   
 | |
|         </UL>
 | |
|    </UL>
 | |
|    
 | |
| 
 | |
|    <!-- ADDITIONAL ATTRIBUTES START -->
 | |
|    
 | |
|    <!-- ADDITIONAL ATTRIBUTES  END -->
 | |
| <HR>
 | |
| 
 | |
|    <A NAME="getPassword"><!-- --></A>
 | |
|    <H3>getPassword</H3>
 | |
|    <PRE>String <B>getPassword</B>()</PRE>
 | |
|    
 | |
|       <UL>Returns the password of this database</UL>
 | |
|    
 | |
| 
 | |
|    <!-- METHOD PARAMETERS START -->
 | |
|    
 | |
|    <!-- METHOD PARAMETERS END -->
 | |
| 
 | |
|    
 | |
|    <UL>
 | |
|    <B>Returns:</B>
 | |
|         <UL>
 | |
|         The password of this database   
 | |
|         </UL>
 | |
|    </UL>
 | |
|    
 | |
| 
 | |
|    <!-- ADDITIONAL ATTRIBUTES START -->
 | |
|    
 | |
|    <!-- ADDITIONAL ATTRIBUTES  END -->
 | |
| <HR>
 | |
| 
 | |
|    <A NAME="getUsername"><!-- --></A>
 | |
|    <H3>getUsername</H3>
 | |
|    <PRE>String <B>getUsername</B>()</PRE>
 | |
|    
 | |
|       <UL>Returns the username of this database</UL>
 | |
|    
 | |
| 
 | |
|    <!-- METHOD PARAMETERS START -->
 | |
|    
 | |
|    <!-- METHOD PARAMETERS END -->
 | |
| 
 | |
|    
 | |
|    <UL>
 | |
|    <B>Returns:</B>
 | |
|         <UL>
 | |
|         The username of this database   
 | |
|         </UL>
 | |
|    </UL>
 | |
|    
 | |
| 
 | |
|    <!-- ADDITIONAL ATTRIBUTES START -->
 | |
|    
 | |
|    <!-- ADDITIONAL ATTRIBUTES  END -->
 | |
| <HR>
 | |
| 
 | |
|    <A NAME="remove"><!-- --></A>
 | |
|    <H3>remove</H3>
 | |
|    <PRE>Boolean <B>remove</B>()</PRE>
 | |
|    
 | |
|       <UL>Deletes all files of this database on disk. Note that this also
 | |
|  closes the database before removing it.</UL>
 | |
|    
 | |
| 
 | |
|    <!-- METHOD PARAMETERS START -->
 | |
|    
 | |
|    <!-- METHOD PARAMETERS END -->
 | |
| 
 | |
|    
 | |
|    <UL>
 | |
|    <B>Returns:</B>
 | |
|         <UL>
 | |
|         True in case the database was removed successfully, false otherwise   
 | |
|         </UL>
 | |
|    </UL>
 | |
|    
 | |
| 
 | |
|    <!-- ADDITIONAL ATTRIBUTES START -->
 | |
|    
 | |
|    <!-- ADDITIONAL ATTRIBUTES  END -->
 | |
| <HR>
 | |
| 
 | |
|    <A NAME="restore"><!-- --></A>
 | |
|    <H3>restore</H3>
 | |
|    <PRE>Boolean <B>restore</B>(<helma.File> backupFile)</PRE>
 | |
|    
 | |
|       <UL>Restores this database using a backup on disk.</UL>
 | |
|    
 | |
| 
 | |
|    <!-- METHOD PARAMETERS START -->
 | |
|    
 | |
|    <UL>
 | |
|    <B>Parameters:</B>
 | |
|    
 | |
|      <UL><CODE>backupFile</CODE> -  The backup file to use for restore  
 | |
|       </UL> 
 | |
|    
 | |
|    </UL>
 | |
|    
 | |
|    <!-- METHOD PARAMETERS END -->
 | |
| 
 | |
|    
 | |
|    <UL>
 | |
|    <B>Returns:</B>
 | |
|         <UL>
 | |
|         True if the database was successfully restored, false otherwise   
 | |
|         </UL>
 | |
|    </UL>
 | |
|    
 | |
| 
 | |
|    <!-- ADDITIONAL ATTRIBUTES START -->
 | |
|    
 | |
|    <!-- ADDITIONAL ATTRIBUTES  END -->
 | |
| <HR>
 | |
| 
 | |
| 
 | |
| 
 | |
| <!-- ============ METHOD DETAIL END ========== -->
 | |
| 
 | |
| <!-- ========= END OF CLASS DATA ========= -->
 | |
| 
 | |
| <!-- ========== START OF NAVBAR ========== -->
 | |
| <A NAME="navbar_bottom"><!-- --></A>
 | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 | |
| <TR>
 | |
| <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A>
 | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 | |
|   <TR ALIGN="center" VALIGN="top">
 | |
|   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
 | |
|   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="overview-summary-Database.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
 | |
|   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
 | |
|   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
 | |
|   <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
 | |
|   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
 | |
|   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
 | |
|   </TR>
 | |
| </TABLE>
 | |
| </TD>
 | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 | |
| <B>Jala 1.3</B>
 | |
| </EM>
 | |
| </TD
 | |
| </TR>
 | |
| 
 | |
| <TR>
 | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 | |
|  <A HREF="jala.db.html"><B>PREV CLASS</B></A><!-- 
 | |
|    NEXT CLASS 
 | |
| -->
 | |
|  <A HREF="jala.db.RamDatabase.html"><B>NEXT CLASS</B></A></FONT></TD>
 | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 | |
|   <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>   
 | |
|  <A HREF="jala.db.FileDatabase.html" TARGET="_top"><B>NO FRAMES</B></A>   
 | |
|  
 | |
| <SCRIPT>
 | |
|   <!--
 | |
|   if(window==top) {
 | |
|     document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
 | |
|   }
 | |
|   //-->
 | |
| </SCRIPT>
 | |
| <NOSCRIPT>
 | |
| <A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
 | |
| </NOSCRIPT>
 | |
| </FONT></TD>
 | |
| </TR>
 | |
| <TR>
 | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 | |
|   SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
 | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
 | |
| </TR>
 | |
| </TABLE>
 | |
| 
 | |
| <!-- =========== END OF NAVBAR =========== -->
 | |
| 
 | |
| <HR>
 | |
| <FONT SIZE="-1">
 | |
| 
 | |
| </FONT>
 | |
| <div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Tue Jan  8 15:45:31 2008</div>
 | |
| </BODY>
 | |
| </HTML>
 |