UimaResultSetIterator (deeplearning4j 1.0.0-beta7 API)

java.lang.Object
- org.deeplearning4j.text.sentenceiterator.BasicResultSetIterator
- - org.deeplearning4j.nlp.uima.sentenceiterator.UimaResultSetIterator

All Implemented Interfaces:

SentenceIterator
```
public class UimaResultSetIterator
extends BasicResultSetIterator
```
Iterates over and returns sentences based on the passed in analysis engine Database version of UimaSentenceIterator based off Adam Gibson's UimaSentenceIterator but extends BasicResultSetIterator Please note: for reset functionality, the underlying JDBC ResultSet must not be of TYPE_FORWARD_ONLY To achieve this using postgres you can make your query using: connection.prepareStatement(sql,ResultSet.TYPE_SCROLL_INSENSITIVE,ResultSet.CONCUR_READ_ONLY);

Author:

Brad Heap nzv8fan@gmail.com

Field Summary

Fields
Modifier and Type Field and Description

protected Iterator<String> sentences

Fields
Modifier and Type	Field and Description
`protected Iterator<String>`	`sentences`

Constructor Summary

Constructors
Constructor and Description
`UimaResultSetIterator(ResultSet rs, String columnName)` Constructor which builds a new UimaResource object
`UimaResultSetIterator(ResultSet rs, String columnName, UimaResource resource)` Constructor which takes an existing UimaResource object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`finish()` Allows for any finishing (closing of input streams or the like)
`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.BasicResultSetIterator
getPreProcessor, setPreProcessor

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

- Field Detail
  - sentences
```
protected volatile Iterator<String> sentences
```
- Constructor Detail
  - UimaResultSetIterator
```
public UimaResultSetIterator(ResultSet rs,
                             String columnName)
                      throws org.apache.uima.resource.ResourceInitializationException
```
    Constructor which builds a new UimaResource object
    
    Parameters:
    
    rs - the database result set object to iterate over
    
    columnName - the name of the column containing text
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - UimaResultSetIterator
```
public UimaResultSetIterator(ResultSet rs,
                             String columnName,
                             UimaResource resource)
```
    Constructor which takes an existing UimaResource object
    
    Parameters:
    
    rs - the database result set object to iterate over
    
    columnName - the name of the column containing text
    
    resource -
- 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() )
    
    Specified by:
    
    nextSentence in interface SentenceIterator
    
    Overrides:
    
    nextSentence in class BasicResultSetIterator
    
    Returns:
    
    the next sentence in the iterator
  - hasNext
```
public boolean hasNext()
```
    Description copied from interface: SentenceIterator
    
    Same idea as Iterator
    
    Specified by:
    
    hasNext in interface SentenceIterator
    
    Overrides:
    
    hasNext in class BasicResultSetIterator
    
    Returns:
    
    whether there's anymore sentences left
  - reset
```
public void reset()
```
    Description copied from interface: SentenceIterator
    
    Resets the iterator to the beginning
    
    Specified by:
    
    reset in interface SentenceIterator
    
    Overrides:
    
    reset in class BasicResultSetIterator
  - finish
```
public void finish()
```
    Description copied from interface: SentenceIterator
    
    Allows for any finishing (closing of input streams or the like)
    
    Specified by:
    
    finish in interface SentenceIterator
    
    Overrides:
    
    finish in class BasicResultSetIterator

Class UimaResultSetIterator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.deeplearning4j.text.sentenceiterator.BasicResultSetIterator

Methods inherited from class java.lang.Object

Field Detail

sentences

Constructor Detail

UimaResultSetIterator

UimaResultSetIterator

Method Detail

nextSentence

hasNext

reset

finish