UriCollectionReader (ClearTK TimeML 2.0.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
      - org.cleartk.util.cr.UriCollectionReader

All Implemented Interfaces:

BaseCollectionReader, CollectionReader, ConfigurableResource, Resource
```
public class UriCollectionReader
extends org.apache.uima.fit.component.JCasCollectionReader_ImplBase
```
Copyright (c) 2012, Regents of the University of Colorado
All rights reserved.
A CollectionReader that populates the default sofa with URI. This can accept a Collection of Files, Collection of URIs or a single directory. If given a directory it will create a jCas for each file within the directory. Recursion is controlled using the directoryFilter parameter. By default this will reject system files and recurse into subdirectories.
This should be used in conjunction with UriToDocumentTextAnnotator or UriToXmiCasAnnotator

Author:

Lee Becker

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UriCollectionReader.RejectSystemDirectories

static class UriCollectionReader.RejectSystemFiles

Nested Classes
Modifier and Type	Class and Description
`static class`	`UriCollectionReader.RejectSystemDirectories`
`static class`	`UriCollectionReader.RejectSystemFiles`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Function<File,URI>`	`fileToUri`
`protected int`	`numUrisCompleted`
`static String`	`PARAM_DIRECTORY`
`static String`	`PARAM_DIRECTORY_FILTER_CLASS`
`static String`	`PARAM_FILE_FILTER_CLASS`
`static String`	`PARAM_FILES`
`static String`	`PARAM_URIS`
`protected Function<String,URI>`	`stringToUri`
`protected int`	`uriCount`
`protected Iterator<URI>`	`uriIter`

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

UriCollectionReader()

Constructors
Constructor and Description
`UriCollectionReader()`

Method Summary

Methods
Modifier and Type	Method and Description
`static CollectionReader`	`getCollectionReaderFromDirectory(File directory)`
`static CollectionReader`	`getCollectionReaderFromDirectory(File directory, Class<? extends IOFileFilter> fileFilterClass, Class<? extends IOFileFilter> dirFilterClass)`
`static CollectionReader`	`getCollectionReaderFromFiles(Collection<File> files)`
`static CollectionReader`	`getCollectionReaderFromUris(Collection<URI> uris)`
`static CollectionReaderDescription`	`getDescriptionFromDirectory(File directory)`
`static CollectionReaderDescription`	`getDescriptionFromDirectory(File directory, Class<? extends IOFileFilter> fileFilterClass, Class<? extends IOFileFilter> dirFilterClass)`
`static CollectionReaderDescription`	`getDescriptionFromFiles(Collection<File> files)`
`static CollectionReaderDescription`	`getDescriptionFromUris(Collection<URI> uris)`
`void`	`getNext(JCas jCas)`
`Progress[]`	`getProgress()`
`boolean`	`hasNext()`
`void`	`initialize(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

fileToUri
```
protected Function<File,URI> fileToUri
```

numUrisCompleted
```
protected int numUrisCompleted
```

PARAM_DIRECTORY

public static final String PARAM_DIRECTORY

See Also:: Constant Field Values

PARAM_DIRECTORY_FILTER_CLASS

public static final String PARAM_DIRECTORY_FILTER_CLASS

See Also:: Constant Field Values

PARAM_FILE_FILTER_CLASS

public static final String PARAM_FILE_FILTER_CLASS

See Also:: Constant Field Values

PARAM_FILES
```
public static final String PARAM_FILES
```
See Also:
Constant Field Values

PARAM_URIS
```
public static final String PARAM_URIS
```
See Also:
Constant Field Values

stringToUri

protected Function<String,URI> stringToUri

uriCount
```
protected int uriCount
```

uriIter
```
protected Iterator<URI> uriIter
```

Constructor Detail
- UriCollectionReader
```
public UriCollectionReader()
```

Method Detail

getCollectionReaderFromDirectory

public static CollectionReader getCollectionReaderFromDirectory(File directory)
                                                         throws ResourceInitializationException

Throws:: ResourceInitializationException

getCollectionReaderFromDirectory

public static CollectionReader getCollectionReaderFromDirectory(File directory,
                                                Class<? extends IOFileFilter> fileFilterClass,
                                                Class<? extends IOFileFilter> dirFilterClass)
                                                         throws ResourceInitializationException

Throws:: ResourceInitializationException

getCollectionReaderFromFiles

public static CollectionReader getCollectionReaderFromFiles(Collection<File> files)
                                                     throws ResourceInitializationException

Throws:: ResourceInitializationException

getCollectionReaderFromUris

public static CollectionReader getCollectionReaderFromUris(Collection<URI> uris)
                                                    throws ResourceInitializationException

Throws:: ResourceInitializationException

getDescriptionFromDirectory

public static CollectionReaderDescription getDescriptionFromDirectory(File directory)
                                                               throws ResourceInitializationException

Throws:: ResourceInitializationException

getDescriptionFromDirectory

public static CollectionReaderDescription getDescriptionFromDirectory(File directory,
                                                      Class<? extends IOFileFilter> fileFilterClass,
                                                      Class<? extends IOFileFilter> dirFilterClass)
                                                               throws ResourceInitializationException

Throws:: ResourceInitializationException

getDescriptionFromFiles

public static CollectionReaderDescription getDescriptionFromFiles(Collection<File> files)
                                                           throws ResourceInitializationException

Throws:: ResourceInitializationException

getDescriptionFromUris

public static CollectionReaderDescription getDescriptionFromUris(Collection<URI> uris)
                                                          throws ResourceInitializationException

Throws:: ResourceInitializationException

getNext

public void getNext(JCas jCas)
             throws IOException,
                    CollectionException

Specified by:: getNext in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
Throws:: IOException; CollectionException

getProgress
```
public Progress[] getProgress()
```

hasNext

public boolean hasNext()
                throws IOException,
                       CollectionException

Throws:: IOException; CollectionException

initialize
```
public void initialize(UimaContext context)
                throws ResourceInitializationException
```
Overrides:

initialize in class org.apache.uima.fit.component.JCasCollectionReader_ImplBase

Throws:

ResourceInitializationException

Class UriCollectionReader

Nested Class Summary

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

fileToUri

numUrisCompleted

PARAM_DIRECTORY

PARAM_DIRECTORY_FILTER_CLASS

PARAM_FILE_FILTER_CLASS

PARAM_FILES

PARAM_URIS

stringToUri

uriCount

uriIter

Constructor Detail

UriCollectionReader

Method Detail

getCollectionReaderFromDirectory

getCollectionReaderFromDirectory

getCollectionReaderFromFiles

getCollectionReaderFromUris

getDescriptionFromDirectory

getDescriptionFromDirectory

getDescriptionFromFiles

getDescriptionFromUris

getNext

getProgress

hasNext

initialize