FileSetCollectionReaderBase (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.api.io.FileSetCollectionReaderBase

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

Direct Known Subclasses:

JCasFileSetCollectionReader_ImplBase, XmlReaderXPath

Deprecated.
use ResourceCollectionReaderBase instead.
```
@Deprecated
public abstract class FileSetCollectionReaderBase
extends org.apache.uima.fit.component.CasCollectionReader_ImplBase
```
Base class for file system collection readers. Uses an Ant FileSet to conveniently walk the file system.
Example of a hypothetic FooReader that should read only files ending in .foo from in the directory foodata or any subdirectory thereof:
```
 CollectionReader reader = createReader(FooReader.class,
     FileSetCollectionReaderBase.PARAM_LANGUAGE, "en",
     FileSetCollectionReaderBase.PARAM_SOURCE_LOCATION, "some/path",
     FileSetCollectionReaderBase.PARAM_PATTERNS, "[+]foodata/**/*.foo" );
 
```
Since:

1.0.6

Author:

Richard Eckart de Castilho

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EXCLUDE_PREFIX` Deprecated.
`static String`	`INCLUDE_PREFIX` Deprecated.
`static String`	`PARAM_CASE_SENSITIVE` Deprecated. States whether the matching is done case sensitive.
`static String`	`PARAM_LANGUAGE` Deprecated. The language.
`static String`	`PARAM_PATH` Deprecated. use `PARAM_SOURCE_LOCATION`
`static String`	`PARAM_PATTERNS` Deprecated. A set of Ant-like include/exclude patterns.
`static String`	`PARAM_SOURCE_LOCATION` Deprecated. Location from which the input is read.
`static String`	`PARAM_USE_DEFAULT_EXCLUDES` Deprecated. Use the default excludes.

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

FileSetCollectionReaderBase()
Deprecated.

Constructors
Constructor and Description
`FileSetCollectionReaderBase()` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`protected Iterator<org.apache.tools.ant.types.resources.FileResource>`	`getFileSetIterator()` Deprecated.
`protected int`	`getIncludedFilesCount()` Deprecated.
`String`	`getLanguage()` Deprecated.
`org.apache.uima.util.Progress[]`	`getProgress()` Deprecated.
`boolean`	`hasNext()` Deprecated.
`protected void`	`initCas(org.apache.uima.cas.CAS aCas, org.apache.tools.ant.types.resources.FileResource aFile, String aQualifier)` Deprecated. Initialize the `DocumentMetaData`.
`void`	`initialize(org.apache.uima.UimaContext aContext)` Deprecated.
`protected org.apache.tools.ant.types.resources.FileResource`	`nextFile()` Deprecated.

Methods inherited from class org.apache.uima.fit.component.CasCollectionReader_ImplBase
close, 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.collection.CollectionReader
getNext

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
  - INCLUDE_PREFIX
```
public static final String INCLUDE_PREFIX
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - EXCLUDE_PREFIX
```
public static final String EXCLUDE_PREFIX
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - PARAM_PATH
```
@Deprecated
public static final String PARAM_PATH
```
    Deprecated. use PARAM_SOURCE_LOCATION
    
    Location from which the input is read.
    
    See Also:
    Constant Field Values
  - PARAM_SOURCE_LOCATION
```
public static final String PARAM_SOURCE_LOCATION
```
    Deprecated.
    
    Location from which the input is read.
    
    See Also:
    Constant Field Values
  - PARAM_PATTERNS
```
public static final String PARAM_PATTERNS
```
    Deprecated.
    
    A set of Ant-like include/exclude patterns. A pattern starts with [+] if it is an include pattern and with [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.
    
    See Also:
    Constant Field Values
  - PARAM_USE_DEFAULT_EXCLUDES
```
public static final String PARAM_USE_DEFAULT_EXCLUDES
```
    Deprecated.
    
    Use the default excludes.
    
    See Also:
    Constant Field Values
  - PARAM_LANGUAGE
```
public static final String PARAM_LANGUAGE
```
    Deprecated.
    
    The language.
    
    See Also:
    Constant Field Values
  - PARAM_CASE_SENSITIVE
```
public static final String PARAM_CASE_SENSITIVE
```
    Deprecated.
    
    States whether the matching is done case sensitive. (default: true)
    
    See Also:
    Constant Field Values
- Constructor Detail
  - FileSetCollectionReaderBase
```
public FileSetCollectionReaderBase()
```
    Deprecated.
- Method Detail
  - initialize
```
public void initialize(org.apache.uima.UimaContext aContext)
                throws org.apache.uima.resource.ResourceInitializationException
```
    Deprecated.
    
    Overrides:
    
    initialize in class org.apache.uima.fit.component.CasCollectionReader_ImplBase
    
    Throws:
    
    org.apache.uima.resource.ResourceInitializationException
  - getIncludedFilesCount
```
protected int getIncludedFilesCount()
```
    Deprecated.
  - getFileSetIterator
```
protected Iterator<org.apache.tools.ant.types.resources.FileResource> getFileSetIterator()
```
    Deprecated.
  - nextFile
```
protected org.apache.tools.ant.types.resources.FileResource nextFile()
```
    Deprecated.
  - getProgress
```
public org.apache.uima.util.Progress[] getProgress()
```
    Deprecated.
  - hasNext
```
public boolean hasNext()
                throws IOException,
                       org.apache.uima.collection.CollectionException
```
    Deprecated.
    
    Throws:
    
    IOException
    
    org.apache.uima.collection.CollectionException
  - initCas
```
protected void initCas(org.apache.uima.cas.CAS aCas,
           org.apache.tools.ant.types.resources.FileResource aFile,
           String aQualifier)
```
    Deprecated.
    
    Initialize the DocumentMetaData. This must be called before setting the document text, otherwise the end feature of this annotation will not be set correctly.
    
    Parameters:
    aCas - the CAS.
    aFile - the file from which the CAS is initialized.
    aQualifier - a qualifier if multiple CASes are generated from the same file.
  - getLanguage
```
public String getLanguage()
```
    Deprecated.

Class FileSetCollectionReaderBase

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.collection.CollectionReader

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

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

Field Detail

INCLUDE_PREFIX

EXCLUDE_PREFIX

PARAM_PATH

PARAM_SOURCE_LOCATION

PARAM_PATTERNS

PARAM_USE_DEFAULT_EXCLUDES

PARAM_LANGUAGE

PARAM_CASE_SENSITIVE

Constructor Detail

FileSetCollectionReaderBase

Method Detail

initialize

getIncludedFilesCount

getFileSetIterator

nextFile

getProgress

hasNext

initCas

getLanguage