HtmlReader (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.html.HtmlReader

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 HtmlReader
extends org.apache.uima.fit.component.JCasCollectionReader_ImplBase
```
Reads the contents of a given URL and strips the HTML. Returns only the textual contents.

Author:

zesch

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ENCODING_AUTO` Automatically detect encoding.
`static String`	`PARAM_ENCODING` Name of configuration parameter that contains the character encoding used by the input files.
`static String`	`PARAM_LANGUAGE` Set this as the language of the produced documents.
`static String`	`PARAM_SOURCE_LOCATION` URL 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

HtmlReader()

Constructors
Constructor and Description
`HtmlReader()`

Method Summary

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

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
  - ENCODING_AUTO
```
public static final String ENCODING_AUTO
```
    Automatically detect encoding.
    
    See Also:
    CharsetDetector, Constant Field Values
  - PARAM_ENCODING
```
public static final String PARAM_ENCODING
```
    Name of configuration parameter that contains the character encoding used by the input files.
    
    See Also:
    Constant Field Values
  - PARAM_SOURCE_LOCATION
```
public static final String PARAM_SOURCE_LOCATION
```
    URL 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
- Constructor Detail
  - HtmlReader
```
public HtmlReader()
```
- Method Detail
  - initialize
```
public void initialize(org.apache.uima.UimaContext context)
                throws org.apache.uima.resource.ResourceInitializationException
```
    Overrides:
    
    initialize in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - 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()
```
  - getNext
```
public void getNext(org.apache.uima.jcas.JCas jcas)
             throws IOException,
                    org.apache.uima.collection.CollectionException
```
    Specified by:
    
    getNext in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
    
    Throws:
    
    IOException
    
    org.apache.uima.collection.CollectionException

Class HtmlReader

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

ENCODING_AUTO

PARAM_ENCODING

PARAM_SOURCE_LOCATION

PARAM_LANGUAGE

Constructor Detail

HtmlReader

Method Detail

initialize

hasNext

getProgress

getNext