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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.docproc;
import com.yahoo.document.DocumentOperation;
import com.yahoo.document.DocumentPut;
import com.yahoo.document.DocumentRemove;
import com.yahoo.document.DocumentUpdate;
import java.util.logging.Level;
/**
* <p>Simple layer on top of {@link DocumentProcessor}, in order to make docproc
* development more user friendly and to the point.</p>
*
* <p>This simply iterates over the {@link DocumentOperation}s in {@link Processing#getDocumentOperations}, and calls
* the appropriate process() method given by this class.</p>
*
* <p>Note that more sophisticated use cases should subclass {@link DocumentProcessor} instead. Specifically,
* it is not possible to return a {@link DocumentProcessor.LaterProgress} from any of the process() methods that SimpleDocumentProcessor
* provides - since their return type is void.</p>
*
* <p>SimpleDocumentProcessor is for the <em>simple</em> cases. For complete control over document processing,
* like returning instances of {@link DocumentProcessor.LaterProgress}, subclass {@link DocumentProcessor} instead.</p>
*
* @author Einar M R Rosenvinge
* @author havardpe
*/
public class SimpleDocumentProcessor extends DocumentProcessor {
/**
* Override this to process DocumentPuts. If this method is not overridden, the implementation in this class
* will ignore DocumentPuts (passing them through un-processed). If processing of this DocumentPut fails, the
* implementation must throw a {@link RuntimeException}.
*
* @param put the DocumentPut to process.
*/
public void process(DocumentPut put) {
if (log.isLoggable(Level.FINE)) {
log.log(Level.FINE, "Ignored " + put);
}
}
/**
* Override this to process DocumentUpdates. If this method is not overridden, the implementation in this class
* will ignore DocumentUpdates (passing them through un-processed). If processing of this DocumentUpdate fails, the
* implementation must throw a {@link RuntimeException}.
*
* @param update the DocumentUpdate to process.
*/
public void process(DocumentUpdate update) {
if (log.isLoggable(Level.FINE)) {
log.log(Level.FINE, "Ignored " + update);
}
}
/**
* Override this to process DocumentRemoves. If this method is not overridden, the implementation in this class
* will ignore DocumentRemoves (passing them through un-processed). If processing of this DocumentRemove fails, the
* implementation must throw a {@link RuntimeException}.
*
* @param remove the DocumentRemove to process.
*/
public void process(DocumentRemove remove) {
if (log.isLoggable(Level.FINE)) {
log.log(Level.FINE, "Ignored " + remove);
}
}
/**
* Simple process() that follows the official guidelines for
* looping over {@link DocumentOperation}s, and then calls the appropriate,
* overloaded process() depending on the type of base.
* <p>
* Declared as final, so if you want to handle everything yourself
* you should of course extend DocumentProcessor instead of
* SimpleDocumentProcessor and just go about as usual.
* <p>
* It is important to note that when iterating over the {@link DocumentOperation}s in
* {@link com.yahoo.docproc.Processing#getDocumentOperations()}, an exception thrown
* from any of the process() methods provided by this class will be thrown straight
* out of this here. This means that failing one document will fail the
* entire batch.
*
* @param processing the Processing to process.
* @return Progress.DONE, unless a subclass decides to throw an exception
*/
@Override
public final Progress process(Processing processing) {
int initialSize = processing.getDocumentOperations().size();
for (DocumentOperation op : processing.getDocumentOperations()) {
try {
if (op instanceof DocumentPut) {
process((DocumentPut) op);
} else if (op instanceof DocumentUpdate) {
process((DocumentUpdate) op);
} else if (op instanceof DocumentRemove) {
process((DocumentRemove) op);
}
} catch (RuntimeException e) {
if (log.isLoggable(Level.FINE) && initialSize != 1) {
log.log(Level.FINE,
"Processing of document failed, from processing.getDocumentOperations() containing " +
initialSize + " DocumentOperation(s).", e);
}
throw e;
}
}
return Progress.DONE;
}
}
|
