lucene/core/src/java/org/apache/lucene/util/bkd/PointValue.java

/*
 * 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.util.bkd;

import org.apache.lucene.util.BytesRef;

/** Represents a dimensional point value written in the BKD tree.
 *
 * @lucene.internal
 **/
public interface PointValue {

  /** Returns the packed values for the dimensions */
  BytesRef packedValue();

  /** Returns the docID */
  int docID();

  /** Returns the byte representation of the packed value
   * together with the docID */
  BytesRef packedValueDocIDBytes();

}