StringReader (DKPro Core - Master Aggregator 1.7.0 API)

java.lang.Object
- org.apache.uima.resource.Resource_ImplBase
- - org.apache.uima.resource.ConfigurableResource_ImplBase
  - - org.apache.uima.collection.CollectionReader_ImplBase
    - - org.apache.uima.fit.component.JCasCollectionReader_ImplBase
      - de.tudarmstadt.ukp.dkpro.core.io.text.StringReader

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.BaseCollectionReader, org.apache.uima.collection.CollectionReader, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource
```
public class StringReader
extends org.apache.uima.fit.component.JCasCollectionReader_ImplBase
```
Simple reader that generates a CAS from a String. This can be useful in situations where a reader is preferred over manually crafting a CAS using JCasFactory.createJCas().

Author:

Erik-Lân Do Dinh, Richard Eckart de Castilho

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PARAM_COLLECTION_ID` The collection ID to set in the `DocumentMetaData`.
`static String`	`PARAM_DOCUMENT_BASE_URI` The document base URI to set in the `DocumentMetaData`.
`static String`	`PARAM_DOCUMENT_ID` The document ID to set in the `DocumentMetaData`.
`static String`	`PARAM_DOCUMENT_TEXT` The document text.
`static String`	`PARAM_DOCUMENT_URI` The document URI to set in the `DocumentMetaData`.
`static String`	`PARAM_LANGUAGE` Set this as the language of the produced documents.

Fields inherited from interface org.apache.uima.resource.Resource
PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

Constructors
Constructor and Description

StringReader()

Constructors
Constructor and Description
`StringReader()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`getNext(org.apache.uima.jcas.JCas sJCas)`
`org.apache.uima.util.Progress[]`	`getProgress()`
`boolean`	`hasNext()`
`void`	`initialize(org.apache.uima.UimaContext aContext)`

Methods inherited from class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
close, getLogger, getNext, initialize

Methods inherited from class org.apache.uima.collection.CollectionReader_ImplBase
destroy, getCasInitializer, getProcessingResourceMetaData, initialize, isConsuming, reconfigure, setCasInitializer, typeSystemInit

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from class org.apache.uima.resource.Resource_ImplBase
getCasManager, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData

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

Methods inherited from interface org.apache.uima.resource.ConfigurableResource
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

Methods inherited from interface org.apache.uima.resource.Resource
getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

- Field Detail
  - PARAM_LANGUAGE
```
public static final String PARAM_LANGUAGE
```
    Set this as the language of the produced documents.
    
    See Also:
    Constant Field Values
  - PARAM_DOCUMENT_TEXT
```
public static final String PARAM_DOCUMENT_TEXT
```
    The document text.
    
    See Also:
    Constant Field Values
  - PARAM_COLLECTION_ID
```
public static final String PARAM_COLLECTION_ID
```
    The collection ID to set in the DocumentMetaData.
    
    See Also:
    Constant Field Values
  - PARAM_DOCUMENT_ID
```
public static final String PARAM_DOCUMENT_ID
```
    The document ID to set in the DocumentMetaData.
    
    See Also:
    Constant Field Values
  - PARAM_DOCUMENT_BASE_URI
```
public static final String PARAM_DOCUMENT_BASE_URI
```
    The document base URI to set in the DocumentMetaData.
    
    See Also:
    Constant Field Values
  - PARAM_DOCUMENT_URI
```
public static final String PARAM_DOCUMENT_URI
```
    The document URI to set in the DocumentMetaData.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - StringReader
```
public StringReader()
```
- Method Detail
  - initialize
```
public void initialize(org.apache.uima.UimaContext aContext)
                throws org.apache.uima.resource.ResourceInitializationException
```
    Overrides:
    
    initialize in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - getNext
```
public void getNext(org.apache.uima.jcas.JCas sJCas)
             throws IOException
```
    Specified by:
    
    getNext in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
    
    Throws:
    
    IOException
  - hasNext
```
public boolean hasNext()
                throws IOException,
                       org.apache.uima.collection.CollectionException
```
    Throws:
    
    IOException
    
    org.apache.uima.collection.CollectionException
  - getProgress
```
public org.apache.uima.util.Progress[] getProgress()
```

Class StringReader

Field Summary

Fields inherited from interface org.apache.uima.resource.Resource

Constructor Summary

Method Summary

Methods inherited from class org.apache.uima.fit.component.JCasCollectionReader_ImplBase

Methods inherited from class org.apache.uima.collection.CollectionReader_ImplBase

Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.uima.resource.ConfigurableResource

Methods inherited from interface org.apache.uima.resource.Resource

Field Detail

PARAM_LANGUAGE

PARAM_DOCUMENT_TEXT

PARAM_COLLECTION_ID

PARAM_DOCUMENT_ID

PARAM_DOCUMENT_BASE_URI

PARAM_DOCUMENT_URI

Constructor Detail

StringReader

Method Detail

initialize

getNext

hasNext

getProgress