de.tudarmstadt.ukp.dkpro.core.api.io

Class ResourceCollectionReaderBase

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.ResourceCollectionReaderBase

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:

AclAnthologyReader, BinaryCasReader, ImsCwbReader, JCasResourceCollectionReader_ImplBase, PdfReader, RTFReader, SerializedCasReader, TeiReader, TextReader, TikaReader, XmiReader, XmlTextReader

public abstract class ResourceCollectionReaderBase
extends org.apache.uima.fit.component.CasCollectionReader_ImplBase

Base class for collection readers that plan to access resources on the file system or in the classpath or basically anywhere where Spring can resolve them. ANT-style patterns are supported to include or exclude particular resources.

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,
         FooReader.PARAM_LANGUAGE, "en",
         FooReader.PARAM_SOURCE_LOCATION, "some/path",
         FooReader.PARAM_PATTERNS, "[+]foodata/**/*.foo");
 

The list of resources returned is sorted, so for the same set of resources, they are always returned in the same order.

Since:

1.0.6

See Also:

Documentation of ant patterns

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceCollectionReaderBase.Resource

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXCLUDE_PREFIX
static String	INCLUDE_PREFIX
protected static String	JAR_PREFIX
static String	KEY_RESOURCE_RESOLVER Name of optional external (UIMA) resource that contains the Locator for a (Spring) ResourcePatternResolver implementation for locating (spring) resources.
static String	PARAM_INCLUDE_HIDDEN Include hidden files and directories.
static String	PARAM_LANGUAGE Name of optional configuration parameter that contains the language of the documents in the input directory.
static String	PARAM_LOG_FREQ The frequency with which read documents are logged.
static String	PARAM_PATH Deprecated. use PARAM_SOURCE_LOCATION
static String	PARAM_PATTERNS A set of Ant-like include/exclude patterns.
static String	PARAM_SOURCE_LOCATION Location from which the input is read.
static String	PARAM_USE_DEFAULT_EXCLUDES 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
ResourceCollectionReaderBase()

Method Summary

Modifier and Type	Method and Description
protected String	getBase() Get the base location used by the reader.
protected String	getBase(String aBase)
protected List<String>	getDefaultExcludes()
String	getLanguage()
org.apache.uima.util.Progress[]	getProgress()
protected org.springframework.core.io.support.ResourcePatternResolver	getResolver()
protected Iterator<ResourceCollectionReaderBase.Resource>	getResourceIterator()
protected Collection<ResourceCollectionReaderBase.Resource>	getResources()
protected String	getSourceLocation()
boolean	hasNext()
protected void	initCas(org.apache.uima.cas.CAS aCas, ResourceCollectionReaderBase.Resource aResource) Initialize the DocumentMetaData.
protected void	initCas(org.apache.uima.cas.CAS aCas, ResourceCollectionReaderBase.Resource aResource, String aQualifier) Initialize the DocumentMetaData.
void	initialize(org.apache.uima.UimaContext aContext)
protected boolean	isSingleLocation()
protected String	locationToUrl(String aLocation) Make sure the given location is an URL.
protected ResourceCollectionReaderBase.Resource	nextFile()
protected Collection<ResourceCollectionReaderBase.Resource>	scan(String aBase, Collection<String> aIncludes, Collection<String> aExcludes)

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, getRelativePathResolver, 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

JAR_PREFIX

protected static final String JAR_PREFIX

See Also:

Constant Field Values

INCLUDE_PREFIX

public static final String INCLUDE_PREFIX

See Also:

Constant Field Values

EXCLUDE_PREFIX

public static final String EXCLUDE_PREFIX

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

Location from which the input is read.

See Also:

Constant Field Values

PARAM_PATTERNS

public static final String PARAM_PATTERNS

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

Use the default excludes.

See Also:

Constant Field Values

PARAM_INCLUDE_HIDDEN

public static final String PARAM_INCLUDE_HIDDEN

Include hidden files and directories.

See Also:

Constant Field Values

PARAM_LANGUAGE

public static final String PARAM_LANGUAGE

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

See Also:

Constant Field Values

KEY_RESOURCE_RESOLVER

public static final String KEY_RESOURCE_RESOLVER

Name of optional external (UIMA) resource that contains the Locator for a (Spring) ResourcePatternResolver implementation for locating (spring) resources.

See Also:

Constant Field Values

PARAM_LOG_FREQ

public static final String PARAM_LOG_FREQ

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

See Also:

Constant Field Values

Constructor Detail

ResourceCollectionReaderBase

public ResourceCollectionReaderBase()

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

getDefaultExcludes

protected List<String> getDefaultExcludes()

locationToUrl

protected String locationToUrl(String aLocation)
                        throws MalformedURLException

Make sure the given location is an URL. E.g. adds "file:" if necessary.

Parameters:

aLocation - the location.

Returns:

an URL.

Throws:

MalformedURLException - if the location cannot be converted to a valid URL.

getResources

protected Collection<ResourceCollectionReaderBase.Resource> getResources()

getResourceIterator

protected Iterator<ResourceCollectionReaderBase.Resource> getResourceIterator()

nextFile

protected ResourceCollectionReaderBase.Resource nextFile()

getSourceLocation

protected String getSourceLocation()

isSingleLocation

protected boolean isSingleLocation()

getBase

protected String getBase()

Get the base location used by the reader. This location always ends in a / if it is set at all. If there is no base, an empty string is returned.

Returns:

the base location used by the reader.

getBase

protected String getBase(String aBase)

getProgress

public org.apache.uima.util.Progress[] getProgress()

getResolver

protected org.springframework.core.io.support.ResourcePatternResolver getResolver()

hasNext

public boolean hasNext()
                throws IOException,
                       org.apache.uima.collection.CollectionException

Throws:

IOException

org.apache.uima.collection.CollectionException

scan

protected Collection<ResourceCollectionReaderBase.Resource> scan(String aBase,
                                                                 Collection<String> aIncludes,
                                                                 Collection<String> aExcludes)
                                                          throws IOException

Throws:

IOException

initCas

protected void initCas(org.apache.uima.cas.CAS aCas,
                       ResourceCollectionReaderBase.Resource aResource)

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.

aResource - the resource from which the CAS is initialized.

initCas

protected void initCas(org.apache.uima.cas.CAS aCas,
                       ResourceCollectionReaderBase.Resource aResource,
                       String aQualifier)

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.

aResource - the resource from which the CAS is initialized.

aQualifier - a qualifier if multiple CASes are generated from the same file.

getLanguage

public String getLanguage()