//
// Copyright 2008, 2015 Daniël de Kok
//
// 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.
//

package eu.danieldk.nlp.jitar.corpus;

import java.io.Closeable;
import java.io.IOException;
import java.util.List;

/**
 * A corpus reader reads tagged tokens from a corpus.
 */
public interface CorpusReader extends Closeable {
    @Override
    public void close() throws IOException;

    /**
     * Read a sentence.
     *
     * @return A list of tokens with tags, or <tt>null</tt> if the reader is exhausted.
     * @throws IOException A problem occured while reading the sentence.
     */
    public List<TaggedToken> readSentence() throws IOException;
}
