org.jooq.LoaderSourceStep Maven / Gradle / Ivy
/*
* 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.io.File;
import java.io.FileNotFoundException;
import java.io.InputStream;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.nio.charset.CharsetDecoder;
import java.util.Iterator;
import java.util.stream.Stream;
import org.xml.sax.InputSource;
/**
* The Loader API is used for configuring data loads.
*
* The step in constructing the {@link Loader} object where you can specify the
* load type and data source.
*
* @author Lukas Eder
* @author Johannes Bühler
*/
public interface LoaderSourceStep {
/**
* Load in-memory data.
*
* Feed a set of array representations of records to the loader API. Each
* array's elements are matched with the subsequent
* {@link LoaderRowsStep#fields(Field...)} specification, by index. The
* values in each array are converted to the matching field's
* {@link DataType} via {@link DataType#convert(Object)}. The matching is
* similar to that of {@link Record#fromArray(Object[], Field...)}.
*/
LoaderRowsStep loadArrays(Object[]... arrays);
/**
* Load in-memory data.
*
* Like {@link #loadArrays(Object[][])}, providing the possibility of lazy
* materialisation of the input arrays.
*
* @see #loadArrays(Object[][])
* @see Record#fromArray(Object[], Field...)
*/
LoaderRowsStep loadArrays(Iterable arrays);
/**
* Load in-memory data.
*
* Like {@link #loadArrays(Object[][])}, providing the possibility of lazy
* materialisation of the input arrays.
*
* @see #loadArrays(Object[][])
* @see Record#fromArray(Object[], Field...)
*/
LoaderRowsStep loadArrays(Iterator arrays);
/**
* Load in-memory data.
*
* Like {@link #loadArrays(Object[][])}, providing the possibility of lazy
* materialisation of the input arrays.
*
* @see #loadArrays(Object[][])
* @see Record#fromArray(Object[], Field...)
*/
LoaderRowsStep loadArrays(Stream arrays);
/**
* Load in-memory data.
*/
LoaderRowsStep loadRecords(Record... records);
/**
* Load in-memory data.
*
* @see #loadRecords(Record...)
*/
LoaderRowsStep loadRecords(Iterable records);
/**
* Load in-memory data.
*
* @see #loadRecords(Record...)
*/
LoaderRowsStep loadRecords(Iterator records);
/**
* Load in-memory data.
*
* @see #loadRecords(Record...)
*/
LoaderRowsStep loadRecords(Stream records);
/**
* Load CSV data.
*/
@Support
LoaderCSVStep loadCSV(File file) throws FileNotFoundException;
/**
* Load CSV data.
*/
@Support
LoaderCSVStep loadCSV(File file, String charsetName) throws FileNotFoundException, UnsupportedEncodingException;
/**
* Load CSV data.
*/
@Support
LoaderCSVStep loadCSV(File file, Charset cs) throws FileNotFoundException;
/**
* Load CSV data.
*/
@Support
LoaderCSVStep loadCSV(File file, CharsetDecoder dec) throws FileNotFoundException;
/**
* Load CSV data.
*/
@Support
LoaderCSVStep loadCSV(String data);
/**
* Load CSV data.
*/
@Support
LoaderCSVStep loadCSV(InputStream stream);
/**
* Load CSV data.
*/
@Support
LoaderCSVStep loadCSV(InputStream stream, String charsetName) throws UnsupportedEncodingException;
/**
* Load CSV data.
*/
@Support
LoaderCSVStep loadCSV(InputStream stream, Charset cs);
/**
* Load CSV data.
*/
@Support
LoaderCSVStep loadCSV(InputStream stream, CharsetDecoder dec);
/**
* Load CSV data.
*/
@Support
LoaderCSVStep loadCSV(Reader reader);
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(File file) throws FileNotFoundException;
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(File file, String charsetName) throws FileNotFoundException, UnsupportedEncodingException;
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(File file, Charset cs) throws FileNotFoundException;
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(File file, CharsetDecoder dec) throws FileNotFoundException;
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(String data);
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(InputStream stream);
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(InputStream stream, String charsetName) throws UnsupportedEncodingException;
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(InputStream stream, Charset cs);
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(InputStream stream, CharsetDecoder dec);
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(Reader reader);
/**
* Load XML data.
*/
@Support
LoaderXMLStep loadXML(InputSource source);
/**
* Load JSON data.
*/
@Support
LoaderJSONStep loadJSON(File file) throws FileNotFoundException;
/**
* Load JSON data.
*/
@Support
LoaderJSONStep loadJSON(File file, String charsetName) throws FileNotFoundException, UnsupportedEncodingException;
/**
* Load JSON data.
*/
@Support
LoaderJSONStep loadJSON(File file, Charset cs) throws FileNotFoundException;
/**
* Load JSON data.
*/
@Support
LoaderJSONStep loadJSON(File file, CharsetDecoder dec) throws FileNotFoundException;
/**
* Load JSON data.
*/
@Support
LoaderJSONStep loadJSON(String data);
/**
* Load JSON data.
*/
@Support
LoaderJSONStep loadJSON(InputStream stream);
/**
* Load JSON data.
*/
@Support
LoaderJSONStep loadJSON(InputStream stream, String charsetName) throws UnsupportedEncodingException;
/**
* Load JSON data.
*/
@Support
LoaderJSONStep loadJSON(InputStream stream, Charset cs);
/**
* Load JSON data.
*/
@Support
LoaderJSONStep loadJSON(InputStream stream, CharsetDecoder dec);
/**
* Load JSON data.
*/
@Support
LoaderJSONStep loadJSON(Reader reader);
}