thredds.util.filesource

Class BasicDescendantFileSource

java.lang.Object

thredds.util.filesource.BasicDescendantFileSource

All Implemented Interfaces:

DescendantFileSource, FileSource

public class BasicDescendantFileSource
extends java.lang.Object
implements DescendantFileSource

_more_

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
BasicDescendantFileSource(java.io.File rootDirectory)
BasicDescendantFileSource(java.lang.String rootDirectoryPath)

Method Summary

Modifier and Type	Method and Description
DescendantFileSource	getDescendant(java.lang.String relativePath) Return a DescendantFileSource representing the descendant directory specified by the relative path.
java.io.File	getFile(java.lang.String path) This implementation requires the path to be relative to the root directory and a descendant of the root directory.
java.lang.String	getRelativePath(java.io.File file) Return the path relative to the root directory that represents the given descendant file.
java.lang.String	getRelativePath(java.lang.String filePath) Return the path relative to the root directory that represents the given descendant file path.
java.io.File	getRootDirectory() Return the root directory represented by this FileLocator as a java.io.File.
java.lang.String	getRootDirectoryPath() Return the path of the root directory represented by this FileLocator.
boolean	isDescendant(java.io.File file) Return true if the given File is an existing descendant of the root directory, false otherwise.
boolean	isDescendant(java.lang.String filePath) Return true if the given file path is an existing descendant of the root directory, false otherwise.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicDescendantFileSource

public BasicDescendantFileSource(java.io.File rootDirectory)

BasicDescendantFileSource

public BasicDescendantFileSource(java.lang.String rootDirectoryPath)

Method Detail

getFile

public java.io.File getFile(java.lang.String path)

This implementation requires the path to be relative to the root directory and a descendant of the root directory. It also requires the relative path at each path segment to be a descendant of the root directory, i.e., it cannot start with "../" or contain "../" path segments such that once "normalized" it would start with "../" (e.g., "dir1/../../dir2" once normalized would be "../dir2").

Specified by:

getFile in interface FileSource

Parameters:

path - the relative path to the descendant File.

Returns:

the descendant File represented by the given relative path or null if the path is null, not relative to the root, not a descendant, or the File doesn't exist.

getDescendant

public DescendantFileSource getDescendant(java.lang.String relativePath)

Description copied from interface: DescendantFileSource

Return a DescendantFileSource representing the descendant directory specified by the relative path.

Specified by:

getDescendant in interface DescendantFileSource

Parameters:

relativePath - the relative path to the descendant directory.

Returns:

a FileLocator representing the descendant root directory or null if the path is null or the descendant directory doesn't exist or isn't a directory (or isn't a descendant).

getRootDirectory

public java.io.File getRootDirectory()

Description copied from interface: DescendantFileSource

Return the root directory represented by this FileLocator as a java.io.File.

Specified by:

getRootDirectory in interface DescendantFileSource

Returns:

the root directory represented by this FileLocator.

getRootDirectoryPath

public java.lang.String getRootDirectoryPath()

Description copied from interface: DescendantFileSource

Return the path of the root directory represented by this FileLocator.

Specified by:

getRootDirectoryPath in interface DescendantFileSource

Returns:

the path of the root directory represented by this FileLocator.

isDescendant

public boolean isDescendant(java.io.File file)

Description copied from interface: DescendantFileSource

Return true if the given File is an existing descendant of the root directory, false otherwise.

Specified by:

isDescendant in interface DescendantFileSource

Parameters:

file - the File to be checked if it is a descendant.

Returns:

true if the given file is an existing descendant, false otherwise.

isDescendant

public boolean isDescendant(java.lang.String filePath)

Description copied from interface: DescendantFileSource

Return true if the given file path is an existing descendant of the root directory, false otherwise.

Specified by:

isDescendant in interface DescendantFileSource

Parameters:

filePath - the file path to be checked if it is a descendant.

Returns:

true if the given file path represents an existing descendant, false otherwise.

getRelativePath

public java.lang.String getRelativePath(java.io.File file)

Description copied from interface: DescendantFileSource

Return the path relative to the root directory that represents the given descendant file.

Specified by:

getRelativePath in interface DescendantFileSource

Parameters:

file - the File for which the relative path is to be determined.

Returns:

the path relative to the root directory that represents the given descendant file or null if the given file is null or not a descendant.

getRelativePath

public java.lang.String getRelativePath(java.lang.String filePath)

Description copied from interface: DescendantFileSource

Return the path relative to the root directory that represents the given descendant file path.

Specified by:

getRelativePath in interface DescendantFileSource

Parameters:

filePath - the file path for which the relative path is to be determined.

Returns:

the path relative to the root directory that represents the given descendant file path or null if the given file path is null or not a descendant.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object