org.finos.tracdap.common.codec.ICodec Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tracdap-lib-data Show documentation

TRAC D.A.P. data library, interfaces and core functionality for working with primary data

The newest version!

/*
 * Licensed to the Fintech Open Source Foundation (FINOS) under one or
 * more contributor license agreements. See the NOTICE file distributed
 * with this work for additional information regarding copyright ownership.
 * FINOS 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.finos.tracdap.common.codec;

import org.finos.tracdap.common.data.DataPipeline;

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

import java.util.List;
import java.util.Map;

public interface ICodec {

    interface Encoder >
        extends
            DataPipeline.DataConsumer,
            DataPipeline.DataProducer {}

    interface Decoder >
        extends
            DataPipeline.DataConsumer,
            DataPipeline.DataProducer {}

    List options();

    String defaultFileExtension();

    Encoder getEncoder(
            BufferAllocator arrowAllocator,
            Schema schema,
            Map options);

    Decoder getDecoder(
            BufferAllocator arrowAllocator,
            Schema schema,
            Map options);
}