org.apache.gobblin.util

Class PathUtils

java.lang.Object

org.apache.gobblin.util.PathUtils

public class PathUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	GLOB_TOKENS

Constructor Summary

Constructors

Constructor and Description
PathUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.hadoop.fs.Path	addExtension(org.apache.hadoop.fs.Path path, String... extensions) Suffix all extensions to path.
static org.apache.hadoop.fs.Path	combinePaths(String... paths)
static boolean	compareWithoutSchemeAndAuthority(org.apache.hadoop.fs.Path path1, org.apache.hadoop.fs.Path path2) Compare two path without shedme and authority (the prefix)
static org.apache.hadoop.fs.Path	deepestNonGlobPath(org.apache.hadoop.fs.Path input) Finds the deepest ancestor of input that is not a glob.
static void	deleteEmptyParentDirectories(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path limitPath, org.apache.hadoop.fs.Path startPath) Deletes empty directories starting with startPath and all ancestors up to but not including limitPath.
static org.apache.hadoop.fs.Path	getPathWithoutSchemeAndAuthority(org.apache.hadoop.fs.Path path) Removes the Scheme and Authority from a Path.
static org.apache.hadoop.fs.Path	getRootPath(org.apache.hadoop.fs.Path path) Returns the root path for the specified path.
static boolean	isAbsoluteAndSchemeAuthorityNull(org.apache.hadoop.fs.Path path) Is an absolute path (ie a slash relative path part) AND a scheme is null AND authority is null.
static boolean	isAncestor(org.apache.hadoop.fs.Path possibleAncestor, org.apache.hadoop.fs.Path fullPath) Checks whether possibleAncestor is an ancestor of fullPath.
static boolean	isGlob(org.apache.hadoop.fs.Path path)
static org.apache.hadoop.fs.Path	mergePaths(org.apache.hadoop.fs.Path path1, org.apache.hadoop.fs.Path path2)
static org.apache.hadoop.fs.Path	relativizePath(org.apache.hadoop.fs.Path fullPath, org.apache.hadoop.fs.Path pathPrefix)
static org.apache.hadoop.fs.Path	removeExtension(org.apache.hadoop.fs.Path path, String... extensions) Removes all extensions from path if they exist.
static org.apache.hadoop.fs.Path	withoutLeadingSeparator(org.apache.hadoop.fs.Path path) Removes the leading slash if present.

Methods inherited from class java.lang.Object

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

Field Detail

GLOB_TOKENS

public static final Pattern GLOB_TOKENS

Constructor Detail

PathUtils

public PathUtils()

Method Detail

mergePaths

public static org.apache.hadoop.fs.Path mergePaths(org.apache.hadoop.fs.Path path1,
                                                   org.apache.hadoop.fs.Path path2)

relativizePath

public static org.apache.hadoop.fs.Path relativizePath(org.apache.hadoop.fs.Path fullPath,
                                                       org.apache.hadoop.fs.Path pathPrefix)

isAncestor

public static boolean isAncestor(org.apache.hadoop.fs.Path possibleAncestor,
                                 org.apache.hadoop.fs.Path fullPath)

Checks whether possibleAncestor is an ancestor of fullPath.

Parameters:

possibleAncestor - Possible ancestor of fullPath.

fullPath - path to check.

Returns:

true if possibleAncestor is an ancestor of fullPath.

getPathWithoutSchemeAndAuthority

public static org.apache.hadoop.fs.Path getPathWithoutSchemeAndAuthority(org.apache.hadoop.fs.Path path)

Removes the Scheme and Authority from a Path.

See Also:

Path, URI

getRootPath

public static org.apache.hadoop.fs.Path getRootPath(org.apache.hadoop.fs.Path path)

Returns the root path for the specified path.

See Also:

Path

withoutLeadingSeparator

public static org.apache.hadoop.fs.Path withoutLeadingSeparator(org.apache.hadoop.fs.Path path)

Removes the leading slash if present.

deepestNonGlobPath

public static org.apache.hadoop.fs.Path deepestNonGlobPath(org.apache.hadoop.fs.Path input)

Finds the deepest ancestor of input that is not a glob.

isGlob

public static boolean isGlob(org.apache.hadoop.fs.Path path)

Returns:

true if path has glob tokens (e.g. *, {, \, }, etc.)

removeExtension

public static org.apache.hadoop.fs.Path removeExtension(org.apache.hadoop.fs.Path path,
                                                        String... extensions)

Removes all extensions from path if they exist.

 PathUtils.removeExtention("file.txt", ".txt")                      = file
 PathUtils.removeExtention("file.txt.gpg", ".txt", ".gpg")          = file
 PathUtils.removeExtention("file", ".txt")                          = file
 PathUtils.removeExtention("file.txt", ".tar.gz")                   = file.txt
 PathUtils.removeExtention("file.txt.gpg", ".txt")                  = file.gpg
 PathUtils.removeExtention("file.txt.gpg", ".gpg")                  = file.txt
 

Parameters:

path - in which the extensions need to be removed

extensions - to be removed

Returns:

a new Path without extensions

addExtension

public static org.apache.hadoop.fs.Path addExtension(org.apache.hadoop.fs.Path path,
                                                     String... extensions)

Suffix all extensions to path.

 PathUtils.addExtension("/tmp/data/file", ".txt")                          = file.txt
 PathUtils.addExtension("/tmp/data/file.txt.gpg", ".zip")                  = file.txt.gpg.zip
 PathUtils.addExtension("/tmp/data/file.txt", ".tar", ".gz")               = file.txt.tar.gz
 PathUtils.addExtension("/tmp/data/file.txt.gpg", ".tar.txt")              = file.txt.gpg.tar.txt
 

Parameters:

path - to which the extensions need to be added

extensions - to be added

Returns:

a new Path with extensions

combinePaths

public static org.apache.hadoop.fs.Path combinePaths(String... paths)

isAbsoluteAndSchemeAuthorityNull

public static boolean isAbsoluteAndSchemeAuthorityNull(org.apache.hadoop.fs.Path path)

Is an absolute path (ie a slash relative path part) AND a scheme is null AND authority is null.

deleteEmptyParentDirectories

public static void deleteEmptyParentDirectories(org.apache.hadoop.fs.FileSystem fs,
                                                org.apache.hadoop.fs.Path limitPath,
                                                org.apache.hadoop.fs.Path startPath)
                                         throws IOException

Deletes empty directories starting with startPath and all ancestors up to but not including limitPath.

Parameters:

fs - FileSystem where paths are located.

limitPath - only Paths that are strict descendants of this path will be deleted.

startPath - first Path to delete. Afterwards empty ancestors will be deleted.

Throws:

IOException

compareWithoutSchemeAndAuthority

public static boolean compareWithoutSchemeAndAuthority(org.apache.hadoop.fs.Path path1,
                                                       org.apache.hadoop.fs.Path path2)

Compare two path without shedme and authority (the prefix)

Parameters:

path1 -

path2 -

Returns: