TreeIterator (deeplearning4j 1.0.0-beta7 API)

java.lang.Object
- org.deeplearning4j.nlp.uima.corpora.treeparser.TreeIterator

All Implemented Interfaces:

Iterator<List<Tree>>
```
public class TreeIterator
extends Object
implements Iterator<List<Tree>>
```
Tree iterator: iterate over sentences returning trees with labels and everything already preset

Author:

Adam Gibson

Constructor Summary

Constructors
Constructor and Description
`TreeIterator(LabelAwareSentenceIterator sentenceIterator, List<String> labels)`
`TreeIterator(LabelAwareSentenceIterator sentenceIterator, List<String> labels, TreeVectorizer treeVectorizer)`
`TreeIterator(LabelAwareSentenceIterator sentenceIterator, List<String> labels, TreeVectorizer treeVectorizer, int batchSize)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`hasNext()` Returns `true` if the iteration has more elements.
`List<Tree>`	`next()` Returns the next element in the iteration.
`void`	`remove()` Removes from the underlying collection the last element returned by this iterator (optional operation).

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

Methods inherited from interface java.util.Iterator
forEachRemaining

- Constructor Detail
  - TreeIterator
```
public TreeIterator(LabelAwareSentenceIterator sentenceIterator,
                    List<String> labels,
                    TreeVectorizer treeVectorizer,
                    int batchSize)
```
  - TreeIterator
```
public TreeIterator(LabelAwareSentenceIterator sentenceIterator,
                    List<String> labels,
                    TreeVectorizer treeVectorizer)
```
  - TreeIterator
```
public TreeIterator(LabelAwareSentenceIterator sentenceIterator,
                    List<String> labels)
             throws Exception
```
    Throws:
    
    Exception
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Returns true if the iteration has more elements. (In other words, returns true if next() would return an element rather than throwing an exception.)
    
    Specified by:
    
    hasNext in interface Iterator<List<Tree>>
    
    Returns:
    
    true if the iteration has more elements
  - next
```
public List<Tree> next()
```
    Returns the next element in the iteration.
    
    Specified by:
    
    next in interface Iterator<List<Tree>>
    
    Returns:
    
    the next element in the iteration
  - remove
```
public void remove()
```
    Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next(). The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.
    
    Specified by:
    
    remove in interface Iterator<List<Tree>>
    
    Throws:
    
    UnsupportedOperationException - if the remove operation is not supported by this iterator
    
    IllegalStateException - if the next method has not yet been called, or the remove method has already been called after the last call to the next method

Class TreeIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Constructor Detail

TreeIterator

TreeIterator

TreeIterator

Method Detail

hasNext

next

remove