io.fury.format.row.Row Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fury-format Show documentation

The newest version!

/*
 * Copyright 2023 The Fury Authors
 *
 * Licensed 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 io.fury.format.row;

import org.apache.arrow.vector.types.pojo.Schema;

/**
 * Interface for row in row format. Row is inspired by Apache Spark tungsten, the differences are
 * Use arrow schema to describe meta.
 * 
String support latin/utf16/utf8 encoding.
 * 
Decimal use arrow decimal format.
 * 
Variable-size field can be inline in fixed-size region if small enough.
 * 
Allow skip padding bye generate Row using aot to put offsets in generated code.
 * 
The implementation support java/C++/python/golang/javascript/rust/etc..
 * Support adding fields without breaking compatibility in the future.
 */
public interface Row extends Getters, Setters {

  Schema getSchema();

  int numFields();

  Row copy();

  default boolean anyNull() {
    for (int i = 0; i < numFields(); i++) {
      if (isNullAt(i)) {
        return true;
      }
    }
    return false;
  }
}