Interface RelativePathResolver

  • All Known Implementing Classes:
    RelativePathResolver_impl

    public interface RelativePathResolver
    Used by the resource manager to resolve relative URLs to absolute URLs.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String UIMA_DATAPATH_PROP  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDataPath()
      Gets the data path used to resolve relative paths.
      java.net.URL resolveRelativePath​(java.net.URL aRelativeUrl)
      Resolves a relative URL to an absolute URL.
      void setDataPath​(java.lang.String aPath)
      Sets the data path used to resolve relative paths.
      void setPathResolverClassLoader​(java.lang.ClassLoader aClassLoader)
      Sets the ClassLoader that should be used to resolve the resources.
    • Field Detail

    • Method Detail

      • getDataPath

        java.lang.String getDataPath()
        Gets the data path used to resolve relative paths. More than one directory may be specified by separating them with the System path.separator character (; on windows, : on UNIX). Elements of this path may be absolute or relative file paths.
        Returns:
        the data path
      • setDataPath

        void setDataPath​(java.lang.String aPath)
                  throws java.net.MalformedURLException
        Sets the data path used to resolve relative paths. More than one directory may be specified by separating them with the System path.separator character (; on windows, : on UNIX). Elements of this path may be absolute or relative file paths.
        Parameters:
        aPath - the data path
        Throws:
        java.net.MalformedURLException - if a file path could not be converted to a URL
      • resolveRelativePath

        java.net.URL resolveRelativePath​(java.net.URL aRelativeUrl)
        Resolves a relative URL to an absolute URL. This will attempt to resolve the URL relative to each element of the data path, sequentially starting with the first element. If this results in an absolute URL at which a file actually exists, that absolute URL is returned. If no file could be found, null is returned.
        Parameters:
        aRelativeUrl - the relative URL to be resolved (if an absolute URL is specified, it will be returned unmodified if a file actually exists at the URL; otherwise null will be returned).
        Returns:
        the absolute URL at which the file exists, null it none could be found.
      • setPathResolverClassLoader

        void setPathResolverClassLoader​(java.lang.ClassLoader aClassLoader)
        Sets the ClassLoader that should be used to resolve the resources.
        Parameters:
        aClassLoader - the ClassLoader that should be used to resolve the resources.