summaryrefslogtreecommitdiffstats
path: root/vdslib/src/main/java/com/yahoo/vdslib/VisitorStatistics.java
blob: a79f3d5fb6da2beb9afb9e731686b1da198e920f (plain) (blame)
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vdslib;

public class VisitorStatistics {
    int bucketsVisited = 0;
    long documentsVisited = 0;
    long bytesVisited = 0;
    long documentsReturned = 0;
    long bytesReturned = 0;
    long secondPassDocumentsReturned = 0;
    long secondPassBytesReturned = 0;

    public void add(VisitorStatistics other) {
        bucketsVisited += other.bucketsVisited;
        documentsVisited += other.documentsVisited;
        bytesVisited += other.bytesVisited;
        documentsReturned += other.documentsReturned;
        bytesReturned += other.bytesReturned;
        secondPassDocumentsReturned += other.secondPassDocumentsReturned;
        secondPassBytesReturned += other.secondPassBytesReturned;
    }

    public int getBucketsVisited() { return bucketsVisited; }
    public void setBucketsVisited(int bucketsVisited) { this.bucketsVisited = bucketsVisited; }

    /**
     * @return the number of documents matching the document selection in the backend and that
     *   has been passed to the client-specified visitor instance (dumpvisitor, searchvisitor etc).
     */
    public long getDocumentsVisited() { return documentsVisited; }
    public void setDocumentsVisited(long documentsVisited) { this.documentsVisited = documentsVisited; }

    public long getBytesVisited() { return bytesVisited; }
    public void setBytesVisited(long bytesVisited) { this.bytesVisited = bytesVisited; }

    /**
     * @return Number of documents returned to the visitor client by the backend. This number may
     *   be lower than that returned by getDocumentsVisited() since the client-specified visitor
     *   instance may further have filtered the set of documents returned by the backend.
     */
    public long getDocumentsReturned() { return documentsReturned; }
    public void setDocumentsReturned(long documentsReturned) { this.documentsReturned = documentsReturned; }

    public long getBytesReturned() { return bytesReturned; }
    public void setBytesReturned(long bytesReturned) { this.bytesReturned = bytesReturned; }

    /**
     * @deprecated Use getDocumentsReturned() instead
     */
    @Deprecated(since = "7", forRemoval = true) // TODO: Vespa 8: remove
    public long getSecondPassDocumentsReturned() { return secondPassDocumentsReturned; }
    /**
     * @deprecated only applies for deprecated "orderdoc" ID scheme
     */
    @Deprecated(since = "7", forRemoval = true)// TODO: Vespa 8: remove
    public void setSecondPassDocumentsReturned(long secondPassDocumentsReturned) { this.secondPassDocumentsReturned = secondPassDocumentsReturned; }

    /**
     * @deprecated Use getBytesReturned() instead
     */
    @Deprecated(since = "7", forRemoval = true) // TODO: Vespa 8: remove
    public long getSecondPassBytesReturned() { return secondPassBytesReturned; }
    /**
     * @deprecated only applies for deprecated "orderdoc" ID scheme
     */
    @Deprecated(since = "7", forRemoval = true) // TODO: Vespa 8: remove
    public void setSecondPassBytesReturned(long secondPassBytesReturned) { this.secondPassBytesReturned = secondPassBytesReturned; }

    public String toString() {
        String out =
            "Buckets visited: " + bucketsVisited + "\n" +
            "Documents visited: " + documentsVisited + "\n" +
            "Bytes visited: " + bytesVisited + "\n" +
            "Documents returned: " + documentsReturned + "\n" +
            "Bytes returned: " + bytesReturned + "\n" +
            "Documents returned (2nd pass): " + secondPassDocumentsReturned + "\n" +
            "Bytes returned (2nd pass): " + secondPassBytesReturned + "\n";

        return out;
    }

}