Package org.apache.tika.pipes.emitter.fs
Class FileSystemEmitter
- java.lang.Object
-
- org.apache.tika.pipes.emitter.AbstractEmitter
-
- org.apache.tika.pipes.emitter.fs.FileSystemEmitter
-
- All Implemented Interfaces:
Emitter
,StreamEmitter
public class FileSystemEmitter extends AbstractEmitter implements StreamEmitter
Emitter to write to a file system.This calculates the path to write to based on the
basePath
and the value of theTikaCoreProperties.SOURCE_PATH
value.<properties> <emitters> <emitter class="org.apache.tika.pipes.emitter.fs.FileSystemEmitter> <params> <!-- required --> <param name="name" type="string">fs</param> <!-- required --> <param name="basePath" type="string">/path/to/output</param> <!-- optional; default is 'json' --> <param name="fileExtension" type="string">json</param> <!-- optional; if the file already exists, options ('skip', 'replace', 'exception') default is 'exception' --> <param name="onExists" type="string">skip</param> </params> </emitter> </emitters> </properties>
-
-
Constructor Summary
Constructors Constructor Description FileSystemEmitter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
emit(String path, InputStream inputStream, Metadata userMetadata)
void
emit(String emitKey, List<Metadata> metadataList)
void
setBasePath(String basePath)
void
setFileExtension(String fileExtension)
If you want to customize the output file's file extension.void
setOnExists(String onExists)
What to do if the target file already exists.-
Methods inherited from class org.apache.tika.pipes.emitter.AbstractEmitter
emit, getName, setName
-
-
-
-
Method Detail
-
emit
public void emit(String emitKey, List<Metadata> metadataList) throws IOException, TikaEmitterException
- Specified by:
emit
in interfaceEmitter
- Throws:
IOException
TikaEmitterException
-
setFileExtension
@Field public void setFileExtension(String fileExtension)
If you want to customize the output file's file extension. Do not include the "."- Parameters:
fileExtension
-
-
setOnExists
@Field public void setOnExists(String onExists)
What to do if the target file already exists. NOTE: if more than one thread is trying write to the same file andFileSystemEmitter.ON_EXISTS.REPLACE
is chosen, you still might get aFileAlreadyExistsException
.- Parameters:
onExists
-
-
emit
public void emit(String path, InputStream inputStream, Metadata userMetadata) throws IOException, TikaEmitterException
- Specified by:
emit
in interfaceStreamEmitter
- Throws:
IOException
TikaEmitterException
-
-