Package de.dlr.proseo.storagemgr.utils

Class PathConverter

java.lang.Object
de.dlr.proseo.storagemgr.utils.PathConverter
public class PathConverter extends Object
A set of methods to convert and manipulate file paths based on different conventions and requirements. It handles Windows paths, Linux paths, and S3 paths, and offers functionality to work with base paths and relative paths.
Author:
Denys Chaykovskiy

  • Constructor Details

    • PathConverter

      public PathConverter(String path)
      Simple constructor with a path
      Parameters:
      path - The path

    • PathConverter

      public PathConverter(String beginPath, String endPath)
      Constructor to merge two paths
      Parameters:
      beginPath - The beginning of the path
      endPath - The end of the path

    • PathConverter

      public PathConverter(String beginPath, String middlePath, String endPath)
      Constructor to merge three paths
      Parameters:
      beginPath - The beginning of the path
      middlePath - The middle of the path
      endPath - The end of the path

    • PathConverter

      public PathConverter(String path, List<String> basePaths)
      Constructor with path and base paths, which will be used to create relative path
      Parameters:
      path - The path
      basePaths - The base paths used for relative paths

    • PathConverter

      public PathConverter(PathConverter pathConverter)
      Copy constructor
      Parameters:
      pathConverter - The PathConverter object to be copied

  • Method Details

    • getPath

      public String getPath()
      Gets the current path.
      Returns:
      The path

    • convertToSlash

      public PathConverter convertToSlash()
      Converts backslashes to slashes in the path.
      Returns:
      A new PathConverter object with the converted path

    • getFirstFolder

      public PathConverter getFirstFolder()
      Gets the first folder from the path.
      Returns:
      A new PathConverter object representing the first folder

    • removeFirstFolder

      public PathConverter removeFirstFolder()
      Removes the first folder from the path.
      Returns:
      A new PathConverter object without the first folder

    • isS3Path

      public boolean isS3Path()
      Checks if the path is an S3 path.
      Returns:
      true if the path is an S3 path, false otherwise

    • removeFsPrefix

      public PathConverter removeFsPrefix()
      Removes the file system prefixes from the path.
      Returns:
      A new PathConverter object without the file system prefixes

    • removeBasePaths

      public PathConverter removeBasePaths()
      Removes the base paths from the path.
      Returns:
      A new PathConverter object without the base paths

    • hasBasePaths

      public boolean hasBasePaths()
      Checks if the path has any base paths.
      Returns:
      true if the path has any base paths, false otherwise

    • removeBucket

      public PathConverter removeBucket()
      Removes the bucket as the first folder from the path.
      Returns:
      A new PathConverter object without the bucket as the first folder

    • removeLeftSlash

      public PathConverter removeLeftSlash()
      Removes the leading slash from the path.
      Returns:
      A new PathConverter object without the leading slash

    • startsWithSlash

      public boolean startsWithSlash()
      Checks if the path starts with a slash (absolute path).
      Returns:
      true if the path starts with a slash, false otherwise

    • addSlashAtEnd

      public PathConverter addSlashAtEnd()
      Adds a slash at the end of the path.
      Returns:
      A new PathConverter object with a slash at the end of the path

    • fixAbsolutePath

      public PathConverter fixAbsolutePath()
      Fixes the absolute path by adding a slash at the end for directories and a slash at the beginning for Linux paths.
      Returns:
      A new PathConverter object with the fixed absolute path

    • isDirectory

      public boolean isDirectory()
      Checks if the path is a directory.
      Returns:
      true if the path is a directory, false otherwise

    • addSlashAtBegin

      public PathConverter addSlashAtBegin()
      Adds a slash at the beginning of the path.
      Returns:
      A new PathConverter object with a slash at the beginning of the path

    • isWindowsPath

      public boolean isWindowsPath()
      Checks if the path is a Windows path.
      Returns:
      true if the path is a Windows path, false otherwise

    • isLinuxPath

      public boolean isLinuxPath()
      Checks if the path is a Linux path.
      Returns:
      true if the path is a Linux path, false otherwise

    • posixToS3Path

      public PathConverter posixToS3Path()
      Converts the path to a compatible S3 path by replacing ":" in Windows paths.
      Returns:
      A new PathConverter object with the S3-compatible path

    • s3ToPosixPath

      public PathConverter s3ToPosixPath()
      Converts the S3 path to a compatible POSIX path by restoring ":" in Windows paths.
      Returns:
      A new PathConverter object with the POSIX-compatible path

    • getRelativePath

      public PathConverter getRelativePath()
      Gets the relative path from the path using the base path list.
      Returns:
      The relative path from the path using the base path list

    • addS3Prefix

      public PathConverter addS3Prefix()
      Adds the S3 prefix to the path.
      Returns:
      The path with the S3 prefix

    • getFileName

      public String getFileName()
      Gets the file name from the path.
      Returns:
      The file name

    • getStorageType

      public StorageType getStorageType()
      Gets the storage type (S3 or POSIX) from the path.
      Returns:
      The storage type

    • normalizeWindowsPath

      public PathConverter normalizeWindowsPath()
      Normalizes the Windows path by removing the leading slash.
      Returns:
      The normalized Windows path