org.apache.tika.batch.fs

Class FSUtil

java.lang.Object

org.apache.tika.batch.fs.FSUtil

public class FSUtil
extends Object

Utility class to handle some common issues when reading from and writing to a file system (FS).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FSUtil.HANDLE_EXISTING

Constructor Summary

Constructors

Constructor and Description
FSUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkThisIsAncestorOfOrSameAsThat(File ancestor, File child)
static boolean	checkThisIsAncestorOfThat(File ancestor, File child)
static File	getOutputFile(File outputRoot, String initialRelativePath, FSUtil.HANDLE_EXISTING handleExisting, String suffix) Given an output root and an initial relative path, return the output file according to the HANDLE_EXISTING strategy In the most basic use case, given a root directory "input", a file's relative path "dir1/dir2/fileA.docx", and an output directory "output", the output file would be "output/dir1/dir2/fileA.docx." If HANDLE_EXISTING is set to OVERWRITE, this will not check to see if the output already exists, and the returned file could overwrite an existing file!!! If HANDLE_EXISTING is set to RENAME, this will try to increment a counter at the end of the file name (fileA(2).docx) until there is a file name that doesn't exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

FSUtil

public FSUtil()

Method Detail

checkThisIsAncestorOfThat

public static boolean checkThisIsAncestorOfThat(File ancestor,
                                File child)

checkThisIsAncestorOfOrSameAsThat

public static boolean checkThisIsAncestorOfOrSameAsThat(File ancestor,
                                        File child)

getOutputFile

public static File getOutputFile(File outputRoot,
                 String initialRelativePath,
                 FSUtil.HANDLE_EXISTING handleExisting,
                 String suffix)
                          throws IOException

Given an output root and an initial relative path, return the output file according to the HANDLE_EXISTING strategy

In the most basic use case, given a root directory "input", a file's relative path "dir1/dir2/fileA.docx", and an output directory "output", the output file would be "output/dir1/dir2/fileA.docx."

If HANDLE_EXISTING is set to OVERWRITE, this will not check to see if the output already exists, and the returned file could overwrite an existing file!!!

If HANDLE_EXISTING is set to RENAME, this will try to increment a counter at the end of the file name (fileA(2).docx) until there is a file name that doesn't exist.

This will return null if handleExisting == HANDLE_EXISTING.SKIP and the candidate file already exists.

This will throw an IOException if HANDLE_EXISTING is set to RENAME, and a candidate cannot output file cannot be found after trying to increment the file count (e.g. fileA(2).docx) 10000 times and then after trying 20,000 UUIDs.

Parameters:

outputRoot - directory root for output

initialRelativePath - initial relative path (including file name, which may be renamed)

handleExisting - what to do if the output file exists

suffix - suffix to add to files, can be null

Returns:

output file or null if no output file should be created

Throws:

IOException