org.jooq.LoaderJSONStep Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hello-world-plugin Show documentation
Kill Bill Hello World plugin
The newest version!
/*
 * Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
 * All rights reserved.
 *
 * 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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
 * database integrations.
 *
 * For more information, please visit: http://www.jooq.org/licenses
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import java.util.Collection;

import org.jooq.LoaderFieldMapper.LoaderFieldContext;

/**
 * The Loader API is used for configuring data loads.
 * 
 * The step in constructing the {@link org.jooq.Loader} object where you can set
 * the mandatory JSON loader options.
 *
 * @author Lukas Eder
 * @author Johannes Bühler
 */
public interface LoaderJSONStep {

    /**
     * Specify the the fields to be loaded into the table in the correct order.
     * 

     * The JSON column at index i is inserted into the table field
     * at index i. If fields[i] == null or
     * fields.length <= i, then the JSON
     * column is skipped.
     */
    @Support
    LoaderJSONOptionsStep fields(Field... fields);

    /**
     * Specify the the fields to be loaded into the table in the correct order.
     * 

     * The JSON column at index i is inserted into the table field
     * at index i. If
     * new ArrayList(fields).get(i) == null or
     * new ArrayList(fields).size() <= i, then the JSON column
     * is skipped.
     */
    @Support
    LoaderJSONOptionsStep fields(Collection> fields);

    /**
     * Specify a function to apply on each input field to receive the target
     * table's field.
     * 
     * The input field obtained from {@link LoaderFieldContext#field()} wraps
     * the JSON column name if any, or an unspecified field enumeration is used.
     * The {@link LoaderFieldContext#index()} property corresponds to the JSON
     * column index in enumeration order.
     */
    @Support
    LoaderListenerStep fields(LoaderFieldMapper mapper);
}