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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:41 PST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>IndexedRepositoryBuilder (Carbonado 1.2.3 API)</title>
<meta name="date" content="2013-12-03">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IndexedRepositoryBuilder (Carbonado 1.2.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IndexedRepositoryBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" target="_top">Frames</a></li>
<li><a href="IndexedRepositoryBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.amazon.carbonado.repo.indexed</div>
<h2 title="Class IndexedRepositoryBuilder" class="title">Class IndexedRepositoryBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">com.amazon.carbonado.spi.AbstractRepositoryBuilder</a></li>
<li>
<ul class="inheritance">
<li>com.amazon.carbonado.repo.indexed.IndexedRepositoryBuilder</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">IndexedRepositoryBuilder</span>
extends <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></pre>
<div class="block">Repository builder for the indexed repository.
<p>
In addition to supporting the capabilities of the wrapped repository, the
following extra capabilities are supported:
<ul>
<li><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a>
<li><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>StorableInfoCapability</code></a>
<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><code>IndexEntryAccessCapability</code></a>
</ul></div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Brian S O'Neill</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#IndexedRepositoryBuilder()">IndexedRepositoryBuilder</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code>
<div class="block">Builds a repository instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code>
<div class="block">This method is called by assertReady, and subclasses must override to
perform custom checks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getIndexRepairThrottle()">getIndexRepairThrottle</a></strong>()</code>
<div class="block">Returns the throttle parameter used when indexes are added, dropped or
bulk repaired.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getName()">getName</a></strong>()</code>
<div class="block">Returns the name of the repository.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getWrappedRepository()">getWrappedRepository</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isAllClustered()">isAllClustered</a></strong>()</code>
<div class="block">Returns true if all indexes should be identified as clustered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isIndexRepairEnabled()">isIndexRepairEnabled</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code>
<div class="block">Returns true if repository should assume the role of master, which is
true by default.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setAllClustered(boolean)">setAllClustered</a></strong>(boolean clustered)</code>
<div class="block">When all indexes are identified as clustered, the query analyzer treats
all indexes as performing equally well.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairDiscardDuplicates(boolean)">setIndexRepairDiscardDuplicates</a></strong>(boolean discardDuplicates)</code>
<div class="block">Set true to skip collisions during index repair, logging each as a
warning.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairEnabled(boolean)">setIndexRepairEnabled</a></strong>(boolean enabled)</code>
<div class="block">By default, index repair is enabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairThrottle(double)">setIndexRepairThrottle</a></strong>(double desiredSpeed)</code>
<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk
repaired.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairVerifyOnly(boolean)">setIndexRepairVerifyOnly</a></strong>(boolean verifyOnly)</code>
<div class="block">Set true to build and verify indexes, but don't apply any changes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean b)</code>
<div class="block">Set to false if repository should not assume the role of master.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code>
<div class="block">Set name for the repository, which is required.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setStrictTriggers(boolean)">setStrictTriggers</a></strong>(boolean strict)</code>
<div class="block">Set to true to require that index maintenance triggers use a "for update" transaction,
avoiding deadlocks and lock upgrade failures.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setWrappedRepository(com.amazon.carbonado.RepositoryBuilder)">setWrappedRepository</a></strong>(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> repoBuilder)</code>
<div class="block">Set the required wrapped respository, which must support the
<a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.spi.AbstractRepositoryBuilder">
<!-- -->
</a>
<h3>Methods inherited from class com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></h3>
<code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="IndexedRepositoryBuilder()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IndexedRepositoryBuilder</h4>
<pre>public IndexedRepositoryBuilder()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="build(java.util.concurrent.atomic.AtomicReference)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)
throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">RepositoryBuilder</a></code></strong></div>
<div class="block">Builds a repository instance.
<p>If the repository is being wrapped by a parent repository, the child
repository will need to know this fact for some operations to work
correctly. Since the parent repository is not built yet, a reference is
used instead.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootRef</code> - reference to root parent repository, to be set by
parent repository upon being built</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd>
<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public java.lang.String getName()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">RepositoryBuilder</a></code></strong></div>
<div class="block">Returns the name of the repository.</div>
</li>
</ul>
<a name="setName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public void setName(java.lang.String name)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">RepositoryBuilder</a></code></strong></div>
<div class="block">Set name for the repository, which is required.</div>
</li>
</ul>
<a name="isMaster()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMaster</h4>
<pre>public boolean isMaster()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">RepositoryBuilder</a></code></strong></div>
<div class="block">Returns true if repository should assume the role of master, which is
true by default. Repositories that link different repositories together
will designate only one as the master.
<p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and
<a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master
repository must set these properties if they are uninitialized. For
updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl>
</li>
</ul>
<a name="setMaster(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaster</h4>
<pre>public void setMaster(boolean b)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">RepositoryBuilder</a></code></strong></div>
<div class="block">Set to false if repository should not assume the role of master. By
default, this option is true. Repositories that link different
repositories together will designate only one as the master.
<p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and
<a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master
repository must set these properties if they are uninitialized. For
updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl>
</li>
</ul>
<a name="getWrappedRepository()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWrappedRepository</h4>
<pre>public <a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> getWrappedRepository()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>wrapped respository</dd></dl>
</li>
</ul>
<a name="setWrappedRepository(com.amazon.carbonado.RepositoryBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWrappedRepository</h4>
<pre>public void setWrappedRepository(<a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a> repoBuilder)</pre>
<div class="block">Set the required wrapped respository, which must support the
<a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a>.</div>
</li>
</ul>
<a name="isIndexRepairEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIndexRepairEnabled</h4>
<pre>public boolean isIndexRepairEnabled()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>true by default</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairEnabled(boolean)"><code>setIndexRepairEnabled(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="setIndexRepairEnabled(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndexRepairEnabled</h4>
<pre>public void setIndexRepairEnabled(boolean enabled)</pre>
<div class="block">By default, index repair is enabled. In this mode, the first time a
Storable type is used, new indexes are populated and old indexes are
removed. Until finished, access to the Storable is blocked.
<p>When index repair is disabled, the Storable is immediately
available. This does have consequences, however. The set of indexes
available for queries is defined by the <i>intersection</i> of the old
and new index sets. The set of indexes that are kept up-to-date is
defined by the <i>union</i> of the old and new index sets.
<p>While index repair is disabled, another process can safely repair the
indexes in the background. When it is complete, index repair can be
enabled for this repository too.</div>
</li>
</ul>
<a name="getIndexRepairThrottle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndexRepairThrottle</h4>
<pre>public double getIndexRepairThrottle()</pre>
<div class="block">Returns the throttle parameter used when indexes are added, dropped or
bulk repaired. By default this value is 1.0, or maximum speed.</div>
</li>
</ul>
<a name="setIndexRepairThrottle(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndexRepairThrottle</h4>
<pre>public void setIndexRepairThrottle(double desiredSpeed)</pre>
<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk
repaired. By default this value is 1.0, or maximum speed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desiredSpeed</code> - 1.0 = perform work at full speed,
0.5 = perform work at half speed, 0.0 = fully suspend work</dd></dl>
</li>
</ul>
<a name="setIndexRepairDiscardDuplicates(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndexRepairDiscardDuplicates</h4>
<pre>public void setIndexRepairDiscardDuplicates(boolean discardDuplicates)</pre>
<div class="block">Set true to skip collisions during index repair, logging each as a
warning.</div>
</li>
</ul>
<a name="setIndexRepairVerifyOnly(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIndexRepairVerifyOnly</h4>
<pre>public void setIndexRepairVerifyOnly(boolean verifyOnly)</pre>
<div class="block">Set true to build and verify indexes, but don't apply any changes.</div>
</li>
</ul>
<a name="isAllClustered()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAllClustered</h4>
<pre>public boolean isAllClustered()</pre>
<div class="block">Returns true if all indexes should be identified as clustered. This
affects how indexes are selected by the query analyzer.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="setAllClustered(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllClustered</h4>
<pre>public void setAllClustered(boolean clustered)</pre>
<div class="block">When all indexes are identified as clustered, the query analyzer treats
all indexes as performing equally well. This is suitable for indexing
repositories that never read from a slow storage medium.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.2</dd></dl>
</li>
</ul>
<a name="setStrictTriggers(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStrictTriggers</h4>
<pre>public void setStrictTriggers(boolean strict)</pre>
<div class="block">Set to true to require that index maintenance triggers use a "for update" transaction,
avoiding deadlocks and lock upgrade failures.</div>
</li>
</ul>
<a name="errorCheck(java.util.Collection)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>errorCheck</h4>
<pre>public void errorCheck(java.util.Collection<java.lang.String> messages)
throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">AbstractRepositoryBuilder</a></code></strong></div>
<div class="block">This method is called by assertReady, and subclasses must override to
perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></code> in class <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused
another exception</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IndexedRepositoryBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" target="_top">Frames</a></li>
<li><a href="IndexedRepositoryBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
</body>
</html>
|
