001/*
002 * Copyright (c) 2015-2020, Oracle and/or its affiliates. All rights reserved.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.tribuo;
018
019import com.oracle.labs.mlrg.olcut.provenance.Provenancable;
020import org.tribuo.provenance.DataSourceProvenance;
021
022/**
023 * A interface for things that can be given to a Dataset's constructor.
024 * <p>
025 * Has a provenance method and a method to get the appropriate {@link OutputFactory}
026 * for the {@link Output} subclass in these examples.
027 * <p>
028 * DataSources are used to do inbound ETL of data on disk or held externally.
029 */
030public interface DataSource<T extends Output<T>> extends Provenancable<DataSourceProvenance>, Iterable<Example<T>> {
031
032    /**
033     * Returns the OutputFactory associated with this Output subclass.
034     * @return The output factory.
035     */
036    public OutputFactory<T> getOutputFactory();
037
038}