oracle.kv.util.migrator.DataSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oracle-nosql-server Show documentation

NoSQL Database Server - supplies build and runtime support for the server (store) side of the Oracle NoSQL Database.

The newest version!

/*-
 * Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This file was distributed by Oracle as part of a version of Oracle NoSQL
 * Database made available at:
 *
 * http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
 *
 * Please see the LICENSE file included in the top-level directory of the
 * appropriate version of Oracle NoSQL Database for a copy of the license and
 * additional information.
 */

package oracle.kv.util.migrator;

import oracle.kv.util.migrator.data.DataEntry;

/**
 * Represents a data source adapter
 */
public interface DataSource {

    /**
     * Returns the identifier of this data source
     *
     * @return the name
     */
    String getName();

    /**
     * Returns the name of the target table where the data source will be
     * migrated to, the name is full namespace table name
     *
     * @return the target table name
     */
    String getTargetTable();

    /**
     * Returns the next data entry object in the data source, return null if
     * no more entry to read
     *
     * @return the next data entry object in the data source
     */
    DataEntry readNext();

    /**
     * Adds the {@link DataTransform} handler to transform the data entry
     * supplied by the DataSource, it is invoked by {@link DataSource#readNext}
     * before returning the data entry
     */
    void addTransform(DataTransform handler);

    /**
     * Close the data source handle and release resources
     */
    void close();
}