FileSentenceIterator (deeplearning4j-nlp 1.0.0-M2.1 API)

java.lang.Object
- org.deeplearning4j.text.sentenceiterator.BaseSentenceIterator
- - org.deeplearning4j.text.sentenceiterator.FileSentenceIterator

All Implemented Interfaces:

SentenceIterator

Direct Known Subclasses:

LabelAwareFileSentenceIterator
```
public class FileSentenceIterator
extends BaseSentenceIterator
```

Field Summary

Fields
Modifier and Type	Field	Description
`protected Queue<String>`	`cache`
`protected File`	`currentFile`
`protected org.apache.commons.io.LineIterator`	`currLineIterator`
`protected File`	`file`
`protected Iterator<File>`	`fileIterator`

Fields inherited from class org.deeplearning4j.text.sentenceiterator.BaseSentenceIterator
preProcessor

Constructor Summary

Constructors
Constructor	Description
`FileSentenceIterator(File dir)`
`FileSentenceIterator(SentencePreProcessor preProcessor, File file)`	Takes a single file or directory

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`hasNext()`	Same idea as `Iterator`
`String`	`nextSentence()`	Gets the next sentence or null if there's nothing left (Do yourself a favor and check hasNext() )
`void`	`reset()`	Resets the iterator to the beginning

Methods inherited from class org.deeplearning4j.text.sentenceiterator.BaseSentenceIterator
finish, getPreProcessor, setPreProcessor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - fileIterator
```
protected volatile Iterator<File> fileIterator
```
  - cache
```
protected volatile Queue<String> cache
```
  - currLineIterator
```
protected volatile org.apache.commons.io.LineIterator currLineIterator
```
  - file
```
protected volatile File file
```
  - currentFile
```
protected volatile File currentFile
```
- Constructor Detail
  - FileSentenceIterator
```
public FileSentenceIterator(SentencePreProcessor preProcessor,
                            File file)
```
    Takes a single file or directory
    
    Parameters:
    
    preProcessor - the sentence pre processor
    
    file - the file or folder to iterate over
  - FileSentenceIterator
```
public FileSentenceIterator(File dir)
```
- Method Detail
  - nextSentence
```
public String nextSentence()
```
    Description copied from interface: SentenceIterator
    
    Gets the next sentence or null if there's nothing left (Do yourself a favor and check hasNext() )
    
    Returns:
    
    the next sentence in the iterator
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: SentenceIterator
    
    Same idea as Iterator
    
    Returns:
    
    whether there's anymore sentences left
  - reset
```
public void reset()
```
    Description copied from interface: SentenceIterator
    
    Resets the iterator to the beginning