FileListPipesIterator (Apache Tika 2.5.0 API)

java.lang.Object
- org.apache.tika.config.ConfigBase
- - org.apache.tika.pipes.pipesiterator.PipesIterator
  - - org.apache.tika.pipes.pipesiterator.filelist.FileListPipesIterator

All Implemented Interfaces:

Iterable<FetchEmitTuple>, Callable<Integer>, Initializable
```
public class FileListPipesIterator
extends PipesIterator
implements Initializable
```
Reads a list of file names/relative paths from a UTF-8 file. One file name/relative path per line. This path is used for the fetch key, the id and the emit key. If you need more customized control of the keys/ids, consider using the jdbc pipes iterator or the csv pipes iterator. Skips empty lines and lines starting with '#'

Field Summary
- Fields inherited from class org.apache.tika.pipes.pipesiterator.PipesIterator
  COMPLETED_SEMAPHORE, DEFAULT_MAX_WAIT_MS, DEFAULT_QUEUE_SIZE

Constructor Summary

Constructors
Constructor Description

FileListPipesIterator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`checkInitialization(InitializableProblemHandler problemHandler)`
`protected void`	`enqueue()`
`void`	`setFileList(String path)`
`void`	`setHasHeader(boolean hasHeader)`

Methods inherited from class org.apache.tika.pipes.pipesiterator.PipesIterator
build, call, getEmitterName, getFetcherName, getHandlerConfig, getOnParseException, initialize, iterator, setEmitterName, setFetcherName, setHandlerType, setMaxEmbeddedResources, setMaxWaitMs, setOnParseException, setOnParseException, setParseMode, setParseMode, setQueueSize, setWriteLimit, tryToAdd

Methods inherited from class org.apache.tika.config.ConfigBase
buildComposite, buildComposite, buildSingle, buildSingle, configure, handleSettings

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.tika.config.Initializable
initialize

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - FileListPipesIterator
```
public FileListPipesIterator()
```
- Method Detail
  - enqueue
```
protected void enqueue()
                throws IOException,
                       TimeoutException,
                       InterruptedException
```
    Specified by:
    
    enqueue in class PipesIterator
    
    Throws:
    
    IOException
    
    TimeoutException
    
    InterruptedException
  - setFileList
```
@Field
public void setFileList(String path)
```
  - setHasHeader
```
@Field
public void setHasHeader(boolean hasHeader)
```
  - checkInitialization
```
public void checkInitialization(InitializableProblemHandler problemHandler)
                         throws TikaConfigException
```
    Specified by:
    
    checkInitialization in interface Initializable
    
    Overrides:
    
    checkInitialization in class PipesIterator
    
    Parameters:
    
    problemHandler - if there is a problem and no custom initializableProblemHandler has been configured via Initializable parameters, this is called to respond.
    
    Throws:
    
    TikaConfigException