opennlp.maxent.DataStream Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 opennlp.maxent;
/**
* A interface for objects which can deliver a stream of training data to be
* supplied to an EventStream. It is not necessary to use a DataStream in a
* Maxent application, but it can be used to support a wider variety of formats
* in which your training data can be held.
*/
public interface DataStream {
/**
* Returns the next slice of data held in this DataStream.
*
* @return the Object representing the data which is next in this DataStream
*/
public Object nextToken();
/**
* Test whether there are any Events remaining in this EventStream.
*
* @return true if this DataStream has more data tokens
*/
public boolean hasNext();
}