edu.illinois.ncsa.datawolf.executor.hpc.util

Class PathUtils

java.lang.Object

edu.illinois.ncsa.datawolf.executor.hpc.util.PathUtils

public class PathUtils
extends Object

Management of file paths. These methods attempt to guarantee consistency by going through the URI and File (for local paths) objects.

Author:

Albert L. Rossi

Method Summary

Methods

Modifier and Type	Method and Description
static URI	changePath(URI base, String newPath) Changes the path in base to newPath.
static URI	concatenate(URI base, String subPath) If the sub path is null, the base is returned; else a new URI with the concatenated path is returned.
static String	duplicateName(String path, int dupNum) Constructs a duplicate file name from original plus given number tag.
static URI[]	enumerateAncestorsExcludeSelf(URI uri)
static String	extractSymlink(String listLine) Presumes listLine follows standard UNIX formatting, with 'l' as first character on line, and symlink indicated by '->'.
static String[]	findCommonPrefix(URI u0, URI u1) Tries to determine the path from root to the nearest common ancestor of the two uri paths, if any.
static String	getName(URI uri) Derives name from uri.
static String	getNormalizedPath(URI uri)
static URI	getParent(URI uri) Derives parent uri from uri.
static String	getRelativePath(URI base, URI full) Determines the relative path of the second URI with respect to the first.
static String	getRelativePath(URI base, URI full, boolean strict) Determines the relative path of the second URI with respect to the first.
static String	getURIName(String forwardSlashPath) Path is parsed using '/' as separator.
static String	getURIName(URI uri) Derives name from uri; calls overloaded method.
static String	getURIParent(String forwardSlashPath)
static String	nextDuplicateName(String name, Map duplicatePaths) Retrieves the next duplicate id number from the map and modifies the name accordingly.

Methods inherited from class java.lang.Object

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

Method Detail

changePath

public static URI changePath(URI base,
             String newPath)
                      throws URISyntaxException

Changes the path in base to newPath.

Parameters:

base - uri to which to concatenate the subpath.

newPath - to replace the base path.

Returns:

URI with changed path.

Throws:

URISyntaxException

concatenate

public static URI concatenate(URI base,
              String subPath)
                       throws URISyntaxException

If the sub path is null, the base is returned; else a new URI with the concatenated path is returned.

All backslashes (\) will be replaced by forward slashes (/) in the subpath before the path is given to the URI constructor.

Parameters:

base - uri to which to concatenate the subpath.

subPath - to affix to the base.

Returns:

URI with concatenated path.

Throws:

URISyntaxException

duplicateName

public static String duplicateName(String path,
                   int dupNum)
                            throws URISyntaxException

Constructs a duplicate file name from original plus given number tag.

Parameters:

path - for which to find the tag.

dupNum - tag to add.

Returns:

modified name with numbered tag.

Throws:

URISyntaxException

enumerateAncestorsExcludeSelf

public static URI[] enumerateAncestorsExcludeSelf(URI uri)
                                           throws URISyntaxException

Throws:

URISyntaxException

extractSymlink

public static String extractSymlink(String listLine)

Presumes listLine follows standard UNIX formatting, with 'l' as first character on line, and symlink indicated by '->'. Composes relative symlink into the apparent parent.

findCommonPrefix

public static String[] findCommonPrefix(URI u0,
                        URI u1)

Tries to determine the path from root to the nearest common ancestor of the two uri paths, if any. URIs are assumed to be absolute. Returned paths are consistent with URI.getPath().

Parameters:

u0 - file or directory uri.

u1 - file or directory uri.

Returns:

an array of three strings representing: 0: the common path from root to nearest common ancestor; 1: the remainder of the path in u0 from ancestor to end; 2: the remainder of the path in u1 from ancestor to end; if there is no common ancestor, ["", path0, path1] is returned; if the shared path coincides with either u0 or u1, that value will be "" in the returned array.

getName

public static String getName(URI uri)

Derives name from uri. If the uri is local, this is done through the File interface; else calls getURIName.

Parameters:

uri - whose path to get name of.

Returns:

name of file or directory.

getNormalizedPath

public static String getNormalizedPath(URI uri)

Returns:

File.getAbsolutePath(), if the uri is local; else uri.getPath().

getParent

public static URI getParent(URI uri)
                     throws URISyntaxException

Derives parent uri from uri. If the uri is local, this is done through the File interface; else the uri path is parsed using '/' as separator.

Parameters:

uri - to get parent of.

Returns:

parent, if one exists; else null.

Throws:

URISyntaxException

getRelativePath

public static String getRelativePath(URI base,
                     URI full)
                              throws URISyntaxException

Determines the relative path of the second URI with respect to the first. This path is always consistent with URI.getPath().

Parameters:

base - to which the returned path is relative.

full - of which to find path relative to base.

Returns:

path of file or directory relative to base.

Throws:

URISyntaxException

getRelativePath

public static String getRelativePath(URI base,
                     URI full,
                     boolean strict)
                              throws URISyntaxException

Determines the relative path of the second URI with respect to the first. This path is always consistent with URI.getPath().

Parameters:

base - to which the returned path is relative.

full - of which to find path relative to base.

strict - if true, schema, host and ports of the two uris must match.

Returns:

path of file or directory relative to base.

Throws:

URISyntaxException

getURIName

public static String getURIName(String forwardSlashPath)

Path is parsed using '/' as separator.

Parameters:

forwardSlashPath - whose path to get name of.

Returns:

name of file or directory.

getURIName

public static String getURIName(URI uri)

Derives name from uri; calls overloaded method. the uri path is parsed using '/' as separator.

Parameters:

uri - whose path to get name of.

Returns:

name of file or directory.

getURIParent

public static String getURIParent(String forwardSlashPath)

nextDuplicateName

public static String nextDuplicateName(String name,
                       Map duplicatePaths)

Retrieves the next duplicate id number from the map and modifies the name accordingly.

Parameters:

name - for which to find the tag.

duplicatePaths - in which to search for duplicate paths.

Returns:

modified name with next numbered tag.