io.deephaven.engine.table.impl.sources.regioned.MakeRegion Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-engine-table Show documentation

Engine Table: Implementation and closely-coupled utilities

There is a newer version: 0.37.1

Show newest version

/**
 * Copyright (c) 2016-2022 Deephaven Data Labs and Patent Pending
 */
package io.deephaven.engine.table.impl.sources.regioned;

import io.deephaven.chunk.attributes.Values;
import io.deephaven.engine.table.ColumnDefinition;
import io.deephaven.engine.table.impl.locations.ColumnLocation;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

@FunctionalInterface
public interface MakeRegion> {

    /**
     * Get a new or re-usable column region appropriate for this source.
     *
     * @param columnDefinition The {@link ColumnDefinition}
     * @param columnLocation The {@link ColumnLocation}
     * @param regionIndex The index of the region to add.
     *
     * @return A new or re-usable column region appropriate for this source and the supplied parameters. A null value
     *         may be returned, which should be interpreted to mean use a special null column, which has size() 0 and is
     *         full of the appropriate "null" value for the column's type.
     */
    @Nullable
    REGION_TYPE makeRegion(@NotNull ColumnDefinition columnDefinition,
            @NotNull ColumnLocation columnLocation,
            int regionIndex);
}