ChrisHegarty commented on code in PR #15990: URL: https://github.com/apache/lucene/pull/15990#discussion_r3217227352
########## lucene/core/src/java/org/apache/lucene/document/column/LongTupleCursor.java: ########## @@ -0,0 +1,42 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.lucene.document.column; + +import org.apache.lucene.search.DocIdSetIterator; + +/** + * A tuple cursor over a {@link LongColumn}. Yields {@code (docID, longValue)} pairs. Batch-local + * doc-ids are returned in non-decreasing order; the same doc-id may repeat for multi-valued fields + * (e.g. {@link org.apache.lucene.index.DocValuesType#SORTED_NUMERIC SORTED_NUMERIC}). + * + * @lucene.experimental + */ +public abstract class LongTupleCursor { + + /** + * Advances to the next doc-id that has a value and returns it, or {@link + * DocIdSetIterator#NO_MORE_DOCS} if exhausted. Doc-ids are batch-local (0 to {@code numDocs - + * 1}). + */ Review Comment: /** * Advances to the next tuple and returns its doc-id, or {@link * DocIdSetIterator#NO_MORE_DOCS} if exhausted. * * <p>Returned doc-ids are batch-local (0 to {@code numDocs - 1}) and are emitted in * non-decreasing order. The same doc-id may be returned multiple times when a document * has multiple values. */ -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
