org.apache.tika.batch.fs

Class FSOutputStreamFactory

java.lang.Object

org.apache.tika.batch.fs.FSOutputStreamFactory

All Implemented Interfaces:

OutputStreamFactory

public class FSOutputStreamFactory
extends java.lang.Object
implements OutputStreamFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FSOutputStreamFactory.COMPRESSION

Field Summary

Fields

Modifier and Type	Field and Description
private FSOutputStreamFactory.COMPRESSION	compression
private FSUtil.HANDLE_EXISTING	handleExisting
private java.nio.file.Path	outputRoot
private java.lang.String	suffix

Constructor Summary

Constructors

Constructor and Description
FSOutputStreamFactory(java.io.File outputRoot, FSUtil.HANDLE_EXISTING handleExisting, FSOutputStreamFactory.COMPRESSION compression, java.lang.String suffix) Deprecated.
FSOutputStreamFactory(java.nio.file.Path outputRoot, FSUtil.HANDLE_EXISTING handleExisting, FSOutputStreamFactory.COMPRESSION compression, java.lang.String suffix)

Method Summary

Modifier and Type	Method and Description
java.io.OutputStream	getOutputStream(Metadata metadata) This tries to create a file based on the FSUtil.HANDLE_EXISTING value that was passed in during initialization.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

handleExisting

private final FSUtil.HANDLE_EXISTING handleExisting

outputRoot

private final java.nio.file.Path outputRoot

suffix

private final java.lang.String suffix

compression

private final FSOutputStreamFactory.COMPRESSION compression

Constructor Detail

FSOutputStreamFactory

@Deprecated
public FSOutputStreamFactory(java.io.File outputRoot,
                                         FSUtil.HANDLE_EXISTING handleExisting,
                                         FSOutputStreamFactory.COMPRESSION compression,
                                         java.lang.String suffix)

Deprecated.

Parameters:

outputRoot -

handleExisting -

compression -

suffix -

See Also:

FSOutputStreamFactory(Path, FSUtil.HANDLE_EXISTING, COMPRESSION, String)

FSOutputStreamFactory

public FSOutputStreamFactory(java.nio.file.Path outputRoot,
                             FSUtil.HANDLE_EXISTING handleExisting,
                             FSOutputStreamFactory.COMPRESSION compression,
                             java.lang.String suffix)

Method Detail

getOutputStream

public java.io.OutputStream getOutputStream(Metadata metadata)
                                     throws java.io.IOException

This tries to create a file based on the FSUtil.HANDLE_EXISTING value that was passed in during initialization.

If handleExisting is set to "SKIP" and the output file already exists, this will return null.

If an output file can be found, this will try to mkdirs for that output file. If mkdirs() fails, this will throw an IOException.

Finally, this will open an output stream for the appropriate output file.

Specified by:

getOutputStream in interface OutputStreamFactory

Parameters:

metadata - must have a value set for FSMetadataProperties.FS_ABSOLUTE_PATH or else NullPointerException will be thrown!

Returns:

OutputStream

Throws:

java.io.IOException, - NullPointerException

java.io.IOException