ceph/src/arrow/java/vector/src/main/java/org/apache/arrow/vector/complex/RepeatedValueVector.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *    http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package org.apache.arrow.vector.complex;
  19
  20 import org.apache.arrow.vector.DensityAwareVector;
  21 import org.apache.arrow.vector.UInt4Vector;
  22 import org.apache.arrow.vector.ValueVector;
  23
  24 /**
  25  * An abstraction representing repeated value vectors.
  26  *
  27  * <p>A repeated vector contains values that may either be flat or nested. A value consists of zero or more
  28  * cells(inner values). Current design maintains data and offsets vectors. Each cell is stored in the data vector.
  29  * Repeated vector uses the offset vector to determine the sequence of cells pertaining to an individual value.
  30  */
  31 public interface RepeatedValueVector extends ValueVector, DensityAwareVector {
  32
  33   int DEFAULT_REPEAT_PER_RECORD = 5;
  34
  35   /**
  36    * Get the offset vector.
  37    * @deprecated This API will be removed, as the current implementations no longer hold inner offset vectors.
  38    *
  39    * @return the underlying offset vector or null if none exists.
  40    */
  41   @Deprecated
  42   UInt4Vector getOffsetVector();
  43
  44   /**
  45    * Get the data vector.
  46    * @return the underlying data vector or null if none exists.
  47    */
  48   ValueVector getDataVector();
  49 }