XmlReader (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.CasCollectionReader_ImplBase
      - de.tudarmstadt.ukp.dkpro.core.io.xml.XmlReader

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 XmlReader
extends org.apache.uima.fit.component.CasCollectionReader_ImplBase
```

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_DOC_ID_TAG` tag which contains the docId
`static String`	`PARAM_EXCLUDE_TAG` optional, tags those should not be worked on.
`static String`	`PARAM_INCLUDE_TAG` optional, tags those should be worked on (if empty, then all tags except those ExcludeTags will be worked on)
`static String`	`PARAM_LANGUAGE` Set this as the language of the produced documents.
`static String`	`PARAM_SOURCE_LOCATION` Location from which the input is read.

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

XmlReader()

Constructors
Constructor and Description
`XmlReader()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`getNext(org.apache.uima.cas.CAS aCAS)`
`org.apache.uima.util.Progress[]`	`getProgress()`
`boolean`	`hasNext()`
`void`	`initialize(org.apache.uima.UimaContext aContext)`

Methods inherited from class org.apache.uima.fit.component.CasCollectionReader_ImplBase
getLogger, 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_SOURCE_LOCATION
```
public static final String PARAM_SOURCE_LOCATION
```
    Location from which the input is read.
    
    See Also:
    Constant Field Values
  - PARAM_LANGUAGE
```
public static final String PARAM_LANGUAGE
```
    Set this as the language of the produced documents.
    
    See Also:
    Constant Field Values
  - PARAM_INCLUDE_TAG
```
public static final String PARAM_INCLUDE_TAG
```
    optional, tags those should be worked on (if empty, then all tags except those ExcludeTags will be worked on)
    
    See Also:
    Constant Field Values
  - PARAM_EXCLUDE_TAG
```
public static final String PARAM_EXCLUDE_TAG
```
    optional, tags those should not be worked on. Out them should no text be extracted and also no Annotations be produced.
    
    See Also:
    Constant Field Values
  - PARAM_DOC_ID_TAG
```
public static final String PARAM_DOC_ID_TAG
```
    tag which contains the docId
    
    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
- Constructor Detail
  - XmlReader
```
public XmlReader()
```
- 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.CasCollectionReader_ImplBase
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - getNext
```
public void getNext(org.apache.uima.cas.CAS aCAS)
             throws IOException,
                    org.apache.uima.collection.CollectionException
```
    Throws:
    
    IOException
    
    org.apache.uima.collection.CollectionException
  - getProgress
```
public org.apache.uima.util.Progress[] getProgress()
```
  - hasNext
```
public boolean hasNext()
                throws IOException,
                       org.apache.uima.collection.CollectionException
```
    Throws:
    
    IOException
    
    org.apache.uima.collection.CollectionException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface org.apache.uima.collection.base_cpm.BaseCollectionReader
    
    Overrides:
    
    close in class org.apache.uima.fit.component.CasCollectionReader_ImplBase
    
    Throws:
    
    IOException

Class XmlReader

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.uima.fit.component.CasCollectionReader_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_SOURCE_LOCATION

PARAM_LANGUAGE

PARAM_INCLUDE_TAG

PARAM_EXCLUDE_TAG

PARAM_DOC_ID_TAG

PARAM_COLLECTION_ID

Constructor Detail

XmlReader

Method Detail

initialize

getNext

getProgress

hasNext

close