ome.services.blitz.repo.path

Class ClientFilePathTransformer

java.lang.Object

ome.services.blitz.repo.path.ClientFilePathTransformer

public class ClientFilePathTransformer
extends Object

Transform client-local File to repository FsFile path. Wholly thread-safe.

Since:

5.0

Author:

m.t.b.carroll@dundee.ac.uk

Constructor Summary

Constructors

Constructor and Description
ClientFilePathTransformer(com.google.common.base.Function<String,String> pathSanitizer) Construct a new client-side file path transformer.

Method Summary

Modifier and Type	Method and Description
FsFile	getFsFileFromClientFile(File clientFile, int depth) Given a client-local File, and a path component depth, returns the corresponding repository path.
int	getMinimumDepth(Collection<File> files) Get the smallest path component depth that allows the given set of Files to be disambiguated.
Set<Collection<File>>	getTooSimilarFiles(Set<File> files) Get the files that are too similarly named.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientFilePathTransformer

public ClientFilePathTransformer(com.google.common.base.Function<String,String> pathSanitizer)

Construct a new client-side file path transformer.

Parameters:

pathSanitizer - a file-path component string transformer whose behavior corresponds to that passed to ServerFilePathTransformer.setPathSanitizer(com.google.common.base.Function<java.lang.String, java.lang.String>) server-side.

Method Detail

getFsFileFromClientFile

public FsFile getFsFileFromClientFile(File clientFile,
                                      int depth)
                               throws IOException

Given a client-local File, and a path component depth, returns the corresponding repository path. Must be executed client-side.

Parameters:

clientFile - a client-local File

depth - the path component depth (including filename)

Returns:

the corresponding repository path, intended to be safe cross-platform

Throws:

IOException - if the absolute path of the File could not be found

getMinimumDepth

public int getMinimumDepth(Collection<File> files)
                    throws IOException

Get the smallest path component depth that allows the given set of Files to be disambiguated. Must be executed client-side.

Parameters:

files - a set of Files

Returns:

the minimum depth for disambiguating the Files, no less than 1

Throws:

IOException - if the absolute path of any of the Files could not be found

getTooSimilarFiles

public Set<Collection<File>> getTooSimilarFiles(Set<File> files)
                                         throws IOException

Get the files that are too similarly named.

Parameters:

files - a set of files

Returns:

the files grouped by those to which they are too similar, or null if all the files are named sufficiently distinctly

Throws:

IOException - if the absolute path of any of the Files could not be found