FilesCollectionReader (ClearTK 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.FilesCollectionReader

All Implemented Interfaces:

BaseCollectionReader, CollectionReader, ConfigurableResource, Resource

Direct Known Subclasses:

XReader
```
public class FilesCollectionReader
extends org.apache.uima.fit.component.JCasCollectionReader_ImplBase
```
Copyright (c) 2007-2008, Regents of the University of Colorado
All rights reserved.
A CollectionReader that loads all files in a directory tree. Files are loaded as plain text and stored in the JCas view selected by the user. ClearTK Document objects are added to the same JCas view to record the file IDs and paths.

Author:

Steven Bethard, Philip Ogren

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`completed`
`protected File`	`currentFile`
`protected Iterator<File>`	`files`
`protected int`	`filesCount`
`static String`	`PARAM_ENCODING`
`static String`	`PARAM_FILE_NAMES`
`static String`	`PARAM_IGNORE_SYSTEM_FILES`
`static String`	`PARAM_LANGUAGE`
`static String`	`PARAM_NAME_FILES_FILE_NAMES`
`static String`	`PARAM_PATTERNS`
`static String`	`PARAM_ROOT_FILE`
`static String`	`PARAM_SUFFIXES`
`static String`	`PARAM_VIEW_NAME`
`protected File`	`rootFile`

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

FilesCollectionReader()

Constructors
Constructor and Description
`FilesCollectionReader()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected int`	`countFiles(Iterator<File> tempFiles)`
`protected Iterator<File>`	`createFileIterator()`
`static CollectionReader`	`getCollectionReader(String fileOrDir)`
`static CollectionReader`	`getCollectionReaderWithPatterns(String dir, String viewName, String... patterns)`
`static CollectionReader`	`getCollectionReaderWithSuffixes(String dir, String viewName, String... suffixes)`
`static CollectionReader`	`getCollectionReaderWithView(String dir, String viewName)`
`static CollectionReaderDescription`	`getDescription(String fileOrDir)`
`static CollectionReaderDescription`	`getDescriptionWithPatterns(String dir, String viewName, String... patterns)`
`static CollectionReaderDescription`	`getDescriptionWithSuffixes(String dir, String viewName, String... suffixes)`
`static CollectionReaderDescription`	`getDescriptionWithView(String dir, String viewName)`
`void`	`getNext(JCas jCas)`
`Progress[]`	`getProgress()`
`boolean`	`hasNext()`
`void`	`initialize(UimaContext context)`

Methods inherited from class org.apache.uima.fit.component.JCasCollectionReader_ImplBase
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

completed
```
protected int completed
```

currentFile
```
protected File currentFile
```

files
```
protected Iterator<File> files
```

filesCount
```
protected int filesCount
```

PARAM_ENCODING

public static final String PARAM_ENCODING

See Also:: Constant Field Values

PARAM_FILE_NAMES

public static final String PARAM_FILE_NAMES

See Also:: Constant Field Values

PARAM_IGNORE_SYSTEM_FILES

public static final String PARAM_IGNORE_SYSTEM_FILES

See Also:: Constant Field Values

PARAM_LANGUAGE

public static final String PARAM_LANGUAGE

See Also:: Constant Field Values

PARAM_NAME_FILES_FILE_NAMES

public static final String PARAM_NAME_FILES_FILE_NAMES

See Also:: Constant Field Values

PARAM_PATTERNS

public static final String PARAM_PATTERNS

See Also:: Constant Field Values

PARAM_ROOT_FILE

public static final String PARAM_ROOT_FILE

See Also:: Constant Field Values

PARAM_SUFFIXES

public static final String PARAM_SUFFIXES

See Also:: Constant Field Values

PARAM_VIEW_NAME

public static final String PARAM_VIEW_NAME

See Also:: Constant Field Values

rootFile
```
protected File rootFile
```

Constructor Detail
- FilesCollectionReader
```
public FilesCollectionReader()
```

Method Detail

close
```
public void close()
           throws IOException
```
Specified by:

close in interface BaseCollectionReader

Overrides:

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

Throws:

IOException

countFiles

protected int countFiles(Iterator<File> tempFiles)

createFileIterator

protected Iterator<File> createFileIterator()
                                     throws ResourceInitializationException

Throws:: ResourceInitializationException

getCollectionReader

public static CollectionReader getCollectionReader(String fileOrDir)
                                            throws ResourceInitializationException

Throws:: ResourceInitializationException

getCollectionReaderWithPatterns

public static CollectionReader getCollectionReaderWithPatterns(String dir,
                                               String viewName,
                                               String... patterns)
                                                        throws ResourceInitializationException

Throws:: ResourceInitializationException

getCollectionReaderWithSuffixes

public static CollectionReader getCollectionReaderWithSuffixes(String dir,
                                               String viewName,
                                               String... suffixes)
                                                        throws ResourceInitializationException

Throws:: ResourceInitializationException

getCollectionReaderWithView

public static CollectionReader getCollectionReaderWithView(String dir,
                                           String viewName)
                                                    throws ResourceInitializationException

Throws:: ResourceInitializationException

getDescription

public static CollectionReaderDescription getDescription(String fileOrDir)
                                                  throws ResourceInitializationException

Throws:: ResourceInitializationException

getDescriptionWithPatterns

public static CollectionReaderDescription getDescriptionWithPatterns(String dir,
                                                     String viewName,
                                                     String... patterns)
                                                              throws ResourceInitializationException

Throws:: ResourceInitializationException

getDescriptionWithSuffixes

public static CollectionReaderDescription getDescriptionWithSuffixes(String dir,
                                                     String viewName,
                                                     String... suffixes)
                                                              throws ResourceInitializationException

Throws:: ResourceInitializationException

getDescriptionWithView

public static CollectionReaderDescription getDescriptionWithView(String dir,
                                                 String viewName)
                                                          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 FilesCollectionReader

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

completed

currentFile

files

filesCount

PARAM_ENCODING

PARAM_FILE_NAMES

PARAM_IGNORE_SYSTEM_FILES

PARAM_LANGUAGE

PARAM_NAME_FILES_FILE_NAMES

PARAM_PATTERNS

PARAM_ROOT_FILE

PARAM_SUFFIXES

PARAM_VIEW_NAME

rootFile

Constructor Detail

FilesCollectionReader

Method Detail

close

countFiles

createFileIterator

getCollectionReader

getCollectionReaderWithPatterns

getCollectionReaderWithSuffixes

getCollectionReaderWithView

getDescription

getDescriptionWithPatterns

getDescriptionWithSuffixes

getDescriptionWithView

getNext

getProgress

hasNext

initialize