de.tudarmstadt.ukp.dkpro.core.io.bincas

Class BinaryCasReader

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

de.tudarmstadt.ukp.dkpro.core.io.bincas.BinaryCasReader

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 BinaryCasReader
extends ResourceCollectionReaderBase

UIMA Binary CAS formats reader.

Nested Class Summary

Nested classes/interfaces inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase

ResourceCollectionReaderBase.Resource

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_ADD_DOCUMENT_METADATA Add DKPro Core metadata if it is not already present in the document.
static String	PARAM_MERGE_TYPE_SYSTEM Determines whether the type system from a currently read file should be merged with the current type system
static String	PARAM_OVERRIDE_DOCUMENT_METADATA Generate new DKPro Core document metadata (i.e.
static String	PARAM_TYPE_SYSTEM_LOCATION The location from which to obtain the type system when the CAS is stored in form 0.

Fields inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase

EXCLUDE_PREFIX, INCLUDE_PREFIX, JAR_PREFIX, KEY_RESOURCE_RESOLVER, PARAM_INCLUDE_HIDDEN, PARAM_LANGUAGE, PARAM_LOG_FREQ, PARAM_PATH, PARAM_PATTERNS, PARAM_SOURCE_LOCATION, PARAM_USE_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
BinaryCasReader()

Method Summary

Modifier and Type	Method and Description
void	getNext(org.apache.uima.cas.CAS aCAS)
protected org.springframework.core.io.Resource	getTypeSystemResource()
protected Collection<ResourceCollectionReaderBase.Resource>	scan(String aBase, Collection<String> aIncludes, Collection<String> aExcludes) It is possible that the type system overlaps with the scan pattern for files, e.g.
void	typeSystemInit(org.apache.uima.cas.TypeSystem aTypeSystem)

Methods inherited from class de.tudarmstadt.ukp.dkpro.core.api.io.ResourceCollectionReaderBase

getBase, getBase, getDefaultExcludes, getLanguage, getProgress, getResolver, getResourceIterator, getResources, getSourceLocation, hasNext, initCas, initCas, initialize, isSingleLocation, locationToUrl, nextFile

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

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.resource.ConfigurableResource

getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue

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

getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Detail

PARAM_TYPE_SYSTEM_LOCATION

public static final String PARAM_TYPE_SYSTEM_LOCATION

The location from which to obtain the type system when the CAS is stored in form 0.

See Also:

Constant Field Values

PARAM_MERGE_TYPE_SYSTEM

public static final String PARAM_MERGE_TYPE_SYSTEM

Determines whether the type system from a currently read file should be merged with the current type system

See Also:

Constant Field Values

PARAM_ADD_DOCUMENT_METADATA

public static final String PARAM_ADD_DOCUMENT_METADATA

Add DKPro Core metadata if it is not already present in the document.

See Also:

Constant Field Values

PARAM_OVERRIDE_DOCUMENT_METADATA

public static final String PARAM_OVERRIDE_DOCUMENT_METADATA

Generate new DKPro Core document metadata (i.e. title, ID, URI) for the document instead of retaining what is already present in the XMI file.

See Also:

Constant Field Values

Constructor Detail

BinaryCasReader

public BinaryCasReader()

Method Detail

getNext

public void getNext(org.apache.uima.cas.CAS aCAS)
             throws IOException,
                    org.apache.uima.collection.CollectionException

Throws:

IOException

org.apache.uima.collection.CollectionException

typeSystemInit

public void typeSystemInit(org.apache.uima.cas.TypeSystem aTypeSystem)
                    throws org.apache.uima.resource.ResourceInitializationException

Specified by:

typeSystemInit in interface org.apache.uima.collection.CollectionReader

Overrides:

typeSystemInit in class org.apache.uima.collection.CollectionReader_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

scan

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

It is possible that the type system overlaps with the scan pattern for files, e.g. because the type system ends in .ser and the resources also end in .ser. If this is the case, we filter the type system file from the resource files during scanning.

Overrides:

scan in class ResourceCollectionReaderBase

Throws:

IOException

getTypeSystemResource

protected org.springframework.core.io.Resource getTypeSystemResource()
                                                              throws MalformedURLException

Throws:

MalformedURLException