diff options
author | Tor Brede Vekterli <vekterli@yahooinc.com> | 2022-01-31 14:10:17 +0100 |
---|---|---|
committer | Tor Brede Vekterli <vekterli@yahooinc.com> | 2022-01-31 16:26:15 +0100 |
commit | 5f9293d65ad97f0625384a3b9a7fee7960be0bb5 (patch) | |
tree | 25f36147a165b2921823d2e7d3b786c9e97d9ad6 /vdslib | |
parent | 80853693f1798728b2b3e2b218642cc7854244ef (diff) |
Deprecate remnants of two-phase visiting APIs and usage
This has not been relevant since "orderdoc" was a thing, and it
was never really a thing in the first place.
Unfortunately, due to an oversight in how the backend propagates visitor
statistics, the internal usage of 2nd pass statistics cannot be fully
removed before Vespa 8 (where the backend is known to not set the
deprecated statistics fields).
Diffstat (limited to 'vdslib')
-rw-r--r-- | vdslib/src/main/java/com/yahoo/vdslib/VisitorStatistics.java | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/vdslib/src/main/java/com/yahoo/vdslib/VisitorStatistics.java b/vdslib/src/main/java/com/yahoo/vdslib/VisitorStatistics.java index f3bf6f4ed38..a79f3d5fb6d 100644 --- a/vdslib/src/main/java/com/yahoo/vdslib/VisitorStatistics.java +++ b/vdslib/src/main/java/com/yahoo/vdslib/VisitorStatistics.java @@ -23,22 +23,47 @@ public class VisitorStatistics { 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() { |