xotcl-doc 1.6.7-2 / usr / share / doc / xotcl-doc / readings / Persistence-xotcl.html

This file is indexed.

/usr/share/doc/xotcl-doc/readings/Persistence-xotcl.html is in xotcl-doc 1.6.7-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/frameset.dtd">

<HTML>
<HEAD>
  <TITLE>XOTcl - Documentation -- ./library/store/Persistence.xotcl</TITLE>
  <LINK REL="StyleSheet" HREF="xotcl-doc.css" TYPE="text/css">
</HEAD>

<BODY BGCOLOR="FFFFFF">
  <h1>
    <IMG SRC="./logo-100.jpg" ALT="./library/store/Persistence.xotcl" ALIGN="MIDDLE">
  ./library/store/Persistence.xotcl</h1>
  <HR>
  <P>
    <h2> Package/File Information </h2>
    <b> No package provided/required </b>
    <BR>
    <BR>
    <b>Defined Objects/Classes: </b>
    <UL>
      <LI>
        <A HREF="#PersistenceMgr">
          <em>PersistenceMgr</em>:
        </A>
        
        <BR>
      </LI>
      <LI>
        <A HREF="#Persistent">
          <em>Persistent</em>:
        </A>
        <a href="#Persistent-makeVarScript">makeVarScript</a>, <a href="#Persistent-persistenceMgr">persistenceMgr</a>, <a href="#Persistent-persistent">persistent</a>, <a href="#Persistent-persistent+init">persistent+init</a>, <a href="#Persistent-persistentVars">persistentVars</a>, <a href="#Persistent-unPersistent">unPersistent</a>.
        <BR>
      </LI>
      <LI>
        <A HREF="#Persistent=Eager">
          <em>Persistent=Eager</em>:
        </A>
        
        <BR>
      </LI>
      <LI>
        <A HREF="#Persistent=Lazy">
          <em>Persistent=Lazy</em>:
        </A>
        
        <BR>
      </LI>
    </UL>
    <BR>
    <b> Filename: </b>
    <A HREF="./library/store/Persistence.xotcl">
      ./library/store/Persistence.xotcl
    </A>
    <BR>
    <BR>
    <TABLE BORDER="0">
      <TR VALIGN="top">
        <TD VALIGN="top">
          <em> Description:</em>
        </TD>
        <TD VALIGN="top">
          
	    Persistent store for XOTcl objects with Eager and Lazy persistence.
	    Take a look at "persistenceExample.xotcl" for exmaple of usage.
	
        </TD>
      </TR>
    </TABLE>
    <BR>
    <HR>
    <P>
      <A NAME="PersistenceMgr">
        
      </A>
      <h2> Class: <em> PersistenceMgr </em> </h2>
      <b>Class</b>: Class
      <BR>
      
      
      <TABLE BORDER="0">
        <TR VALIGN="top">
          <TD VALIGN="top">
            <em> Description:</em>
          </TD>
          <TD VALIGN="top">
            
	    A persistent store requires a persistent manager. The persistent
	    manager implements the Storage interface via storage mixin. With 
	    the parameter "dbPackage" we can specify which storage will be used.
	    The persistent manager than tries to load the package 
	    "xotcl::${dbPackage}Storage". Default is Sdbm.

	    Example:
	    <pre>
	    PersistenceMgr pmgr -persistenceDir . -persistenceFile example-db
	    </pre>

	
          </TD>
        </TR>
      </TABLE>
    </P>
    <HR>
    <P>
      <A NAME="Persistent">
        
      </A>
      <h2> Class: <em> Persistent </em> </h2>
      <b>Class</b>: Class
      <BR>
      <b> Procs/Instprocs: </b> 
      <a href="#Persistent-makeVarScript">makeVarScript</a>, <a href="#Persistent-persistenceMgr">persistenceMgr</a>, <a href="#Persistent-persistent">persistent</a>, <a href="#Persistent-persistent+init">persistent+init</a>, <a href="#Persistent-persistentVars">persistentVars</a>, <a href="#Persistent-unPersistent">unPersistent</a>.
      <TABLE BORDER="0">
        <TR VALIGN="top">
          <TD VALIGN="top">
            <em> Description:</em>
          </TD>
          <TD VALIGN="top">
            
	    Superclass or mixin class for all persistent objects. Normally
	    subclasses are used as mixins or instmixins on object, like:
	    <pre>
	    o mixin Persistent=Eager
	    p mixin Persistent=Lazy
	    </pre>
	
          </TD>
        </TR>
      </TABLE>
      <h3>Instprocs</h3>
      <UL>
        <LI>
          <A NAME="Persistent-persistenceMgr">
            
          </A>
          <b>persistenceMgr </b>
          <em>args</em>
          <TABLE BORDER="0">
                      <TR VALIGN="top">
            <TD VALIGN="top">
              <em>Arguments:</em>
            </TD>
            <TD VALIGN="top">
              <b>args</b>: persistent manager name
            </TD>
          </TR>

            <TR VALIGN="top">
              <TD VALIGN="top">
                <em> Description:</em>
              </TD>
              <TD VALIGN="top">
                
	    Specify which persistence manager to use for [self] object, like:
	    <pre>
	    o persistenceMgr pmgr
	    </pre>
	    Each persistent object must have a persistence manager specified, 
	    before vars can be made persistent.
	
              </TD>
            </TR>
          </TABLE>
        </LI>
        <LI>
          <A NAME="Persistent-persistentVars">
            
          </A>
          <b>persistentVars </b>
          <TABLE BORDER="0">
            
            <TR VALIGN="top">
              <TD VALIGN="top">
                <em> Description:</em>
              </TD>
              <TD VALIGN="top">
                
	    Returns list of persistent vars.
	
              </TD>
            </TR>
          </TABLE>
        </LI>
        <LI>
          <A NAME="Persistent-persistent">
            
          </A>
          <b>persistent </b>
          <em>list</em>
          <TABLE BORDER="0">
                      <TR VALIGN="top">
            <TD VALIGN="top">
              <em>Arguments:</em>
            </TD>
            <TD VALIGN="top">
              <b>list</b>: persistent variables
            </TD>
          </TR>

            <TR VALIGN="top">
              <TD VALIGN="top">
                <em> Description:</em>
              </TD>
              <TD VALIGN="top">
                
	    Make a list of object variables persistent. If a persistent
	    DB exists, the values are read from this DB, overwriting the current value.
	    E.g.:
	    <pre>
	    o persistent {x y}
	    </pre>

	
              </TD>
            </TR>
          </TABLE>
        </LI>
        <LI>
          <A NAME="Persistent-persistent+init">
            
          </A>
          <b>persistent+init </b>
          <em>list</em>
          <TABLE BORDER="0">
                      <TR VALIGN="top">
            <TD VALIGN="top">
              <em>Arguments:</em>
            </TD>
            <TD VALIGN="top">
              <b>list</b>: persistent variables
            </TD>
          </TR>

            <TR VALIGN="top">
              <TD VALIGN="top">
                <em> Description:</em>
              </TD>
              <TD VALIGN="top">
                
	    Initialize all data in the list as empty strings, 
	    if they do not exist yet, and then make them persistent
	    using the 'persistent' method
	
              </TD>
            </TR>
          </TABLE>
        </LI>
        <LI>
          <A NAME="Persistent-unPersistent">
            
          </A>
          <b>unPersistent </b>
          <em>list</em>
          <TABLE BORDER="0">
                      <TR VALIGN="top">
            <TD VALIGN="top">
              <em>Arguments:</em>
            </TD>
            <TD VALIGN="top">
              <b>list</b>: persistent variables
            </TD>
          </TR>

            <TR VALIGN="top">
              <TD VALIGN="top">
                <em> Description:</em>
              </TD>
              <TD VALIGN="top">
                
	    Make a list of object variables not persistent. 
	
              </TD>
            </TR>
          </TABLE>
        </LI>
        <LI>
          <A NAME="Persistent-makeVarScript">
            
          </A>
          <b>makeVarScript </b>
          <TABLE BORDER="0">
            
            <TR VALIGN="top">
              <TD VALIGN="top">
                <em> Description:</em>
              </TD>
              <TD VALIGN="top">
                
	    Build a Tcl script of "set ..." statements reflecting the current situation in the database.
	
              </TD>
            </TR>
          </TABLE>
        </LI>
      </UL>
    </P>
    <HR>
    <P>
      <A NAME="Persistent=Eager">
        
      </A>
      <h2> Class: <em> Persistent=Eager </em> </h2>
      <b>Class</b>: Class
      <BR>
      
      
      <TABLE BORDER="0">
        <TR VALIGN="top">
          <TD VALIGN="top">
            <em> Description:</em>
          </TD>
          <TD VALIGN="top">
            
	    Eager persistence strategy. Store everything at the same moment to the database
	
          </TD>
        </TR>
      </TABLE>
    </P>
    <HR>
    <P>
      <A NAME="Persistent=Lazy">
        
      </A>
      <h2> Class: <em> Persistent=Lazy </em> </h2>
      <b>Class</b>: Class
      <BR>
      
      
      <TABLE BORDER="0">
        <TR VALIGN="top">
          <TD VALIGN="top">
            <em> Description:</em>
          </TD>
          <TD VALIGN="top">
            
	    Lazy persistence strategy. Store everything on object destroy (or program termination).
	
          </TD>
        </TR>
      </TABLE>
    </P>
    <BR>
  </P>
  <HR>
  <P>
  </P>
  <A HREF="./index.html">
    Back to index page.
  </A>
  <BR>
  <HR>
  <P>
  </P>
</BODY>
</HTML>

APT Browse - Built by Thomas Orozco.