jpountz commented on a change in pull request #680: LUCENE-8803: Provide a FieldComparator to allow sorting by a feature from a FeatureField URL: https://github.com/apache/lucene-solr/pull/680#discussion_r286093601
########## File path: lucene/core/src/java/org/apache/lucene/document/FeatureSortField.java ########## @@ -0,0 +1,170 @@ +/* + * 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; + +import java.io.IOException; + +import org.apache.lucene.index.LeafReaderContext; +import org.apache.lucene.index.PostingsEnum; +import org.apache.lucene.index.Terms; +import org.apache.lucene.index.TermsEnum; +import org.apache.lucene.search.FieldComparator; +import org.apache.lucene.search.SimpleFieldComparator; +import org.apache.lucene.search.SortField; +import org.apache.lucene.util.BytesRef; +import org.carrot2.shaded.guava.common.base.Objects; + +/** + * Sorts using the value of a specified feature name from a {@link FeatureField}. + */ +final class FeatureSortField extends SortField { + + private final BytesRef featureName; + + /** + * Creates a {@link FeatureSortField} that can be used to sort hits by + * the value of a particular feature in a {@link FeatureField}. + * + * @param featureName The name of the feature to use for the sort value + */ + public FeatureSortField(String field, BytesRef featureName) { + super(field, SortField.Type.CUSTOM); + if (field == null) { + throw new IllegalArgumentException("field must not be null"); + } + if (featureName == null) { + throw new IllegalArgumentException("featureName must not be null"); + } Review comment: nit: we'd more likely use Objects#requireNonNull nowadays (which means the javadocs of the factory method should be updated too since it'd throw a NPE instead of an IAE) ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
