001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.io.data.loading.api;
020
021import org.apache.reef.annotations.audience.TaskSide;
022import org.apache.reef.io.network.util.Pair;
023
024/**
025 * A view of the data set to be loaded
026 * at an evaluator as an iterable of
027 * key value pairs.
028 * <p>
029 * Implementations need not materialize
030 * and clients should not assume that the
031 * data is materialized. Any such thing
032 * is left as a post-processing step.
033 * <p>
034 * Client also can't assume that the iterator
035 * returned here can be restarted
036 *
037 * @param <K>
038 * @param <V>
039 */
040@TaskSide
041public interface DataSet<K, V> extends Iterable<Pair<K, V>> {
042
043}