de.tudarmstadt.ukp.dkpro.core.api.resources

Class ResourceUtils

java.lang.Object

de.tudarmstadt.ukp.dkpro.core.api.resources.ResourceUtils

public class ResourceUtils
extends Object

Since:

1.1.0

Constructor Summary

Constructors

Constructor and Description
ResourceUtils()

Method Summary

Modifier and Type	Method and Description
static File	getClasspathAsFolder(String aClasspathBase, boolean aCache) Make a given classpath location available as a folder.
static File	getUrlAsExecutable(URL aUrl, boolean aCache) Make the given URL available as an executable file.
static File	getUrlAsFile(URL aUrl, boolean aCache) Make the given URL available as a file.
static File	getUrlAsFile(URL aUrl, boolean aCache, boolean aForceTemp) Make the given URL available as a file.
static InputStream	resolveCompressedInputStream(InputStream is, String filename) Deprecated. Use CompressionUtils.getInputStream(String, InputStream)
static URL	resolveLocation(String aLocation) Resolve a location (which can be many things) to an URL.
static URL	resolveLocation(String aLocation, ClassLoader aClassLoader, org.apache.uima.UimaContext aContext) Resolve a location (which can be many things) to an URL.
static URL	resolveLocation(String aLocation, Object aCaller, org.apache.uima.UimaContext aContext) Resolve a location (which can be many things) to an URL.
static URL	resolveLocation(String aLocation, org.apache.uima.UimaContext aContext) Resolve a location (which can be many things) to an URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceUtils

public ResourceUtils()

Method Detail

getClasspathAsFolder

public static File getClasspathAsFolder(String aClasspathBase,
                                        boolean aCache)
                                 throws IOException

Make a given classpath location available as a folder. A temporary folder is created and deleted upon a regular shutdown of the JVM. This method must not be used for creating executable binaries. For this purpose, getUrlAsExecutable should be used.

Parameters:

aClasspathBase - a classpath location as used by PathMatchingResourcePatternResolver.getResources(String)

aCache - use the cache or not.

Returns:

the temporary location on the file system.

Throws:

IOException - if an I/O error has occurred,

See Also:

PathMatchingResourcePatternResolver

getUrlAsFile

public static File getUrlAsFile(URL aUrl,
                                boolean aCache)
                         throws IOException

Make the given URL available as a file. A temporary file is created and deleted upon a regular shutdown of the JVM. If the parameter aCache is true, the temporary file is remembered in a cache and if a file is requested for the same URL at a later time, the same file is returned again. If the previously created file has been deleted meanwhile, it is recreated from the URL. This method should not be used for creating executable binaries. For this purpose, getUrlAsExecutable should be used.

Parameters:

aUrl - the URL.

aCache - use the cache or not.

Returns:

a file created from the given URL.

Throws:

IOException - if the URL cannot be accessed to (re)create the file.

getUrlAsFile

public static File getUrlAsFile(URL aUrl,
                                boolean aCache,
                                boolean aForceTemp)
                         throws IOException

Make the given URL available as a file. A temporary file is created and deleted upon a regular shutdown of the JVM. If the parameter aCache is true, the temporary file is remembered in a cache and if a file is requested for the same URL at a later time, the same file is returned again. If the previously created file has been deleted meanwhile, it is recreated from the URL. This method should not be used for creating executable binaries. For this purpose, getUrlAsExecutable should be used.

Parameters:

aUrl - the URL.

aCache - use the cache or not.

aForceTemp - always create a temporary file, even if the URL is already a file.

Returns:

a file created from the given URL.

Throws:

IOException - if the URL cannot be accessed to (re)create the file.

getUrlAsExecutable

public static File getUrlAsExecutable(URL aUrl,
                                      boolean aCache)
                               throws IOException

Make the given URL available as an executable file. A temporary file is created and deleted upon a regular shutdown of the JVM. If the parameter aCache is true, the temporary file is remembered in a cache and if a file is requested for the same URL at a later time, the same file is returned again. If the previously created file has been deleted meanwhile, it is recreated from the URL.

Parameters:

aUrl - the URL.

aCache - use the cache or not.

Returns:

an executable file created from the given URL.

Throws:

IOException - if the file has permissions issues.

resolveCompressedInputStream

@Deprecated
public static InputStream resolveCompressedInputStream(InputStream is,
                                                                   String filename)
                                                            throws IOException

Deprecated. Use CompressionUtils.getInputStream(String, InputStream)

Parameters:

is - An InputStream.

filename - The filename this stream was created from.

Returns:

A resolved InputStream

Throws:

IOException - if something went wrong during resolving the input stream

resolveLocation

public static URL resolveLocation(String aLocation)
                           throws IOException

Resolve a location (which can be many things) to an URL. If the location starts with classpath: the location is interpreted as a classpath location. Otherwise it is tried as a URL, file and at last UIMA resource. If the location is treated as a classpath or file location, an URL is only returned if the target exists. If it is an URL, it is possible that the target may not actually exist.

Parameters:

aLocation - a location (classpath, URL, file or UIMA resource location).

Returns:

the resolved URL.

Throws:

IOException - if the target could not be found.

resolveLocation

public static URL resolveLocation(String aLocation,
                                  org.apache.uima.UimaContext aContext)
                           throws IOException

Resolve a location (which can be many things) to an URL. If the location starts with classpath: the location is interpreted as a classpath location. Otherwise it is tried as a URL, file and at last UIMA resource. If the location is treated as a classpath or file location, an URL is only returned if the target exists. If it is an URL, it is possible that the target may not actually exist.

Parameters:

aLocation - a location (classpath, URL, file or UIMA resource location).

aContext - a UIMA context.

Returns:

the resolved URL.

Throws:

IOException - if the target could not be found.

resolveLocation

public static URL resolveLocation(String aLocation,
                                  Object aCaller,
                                  org.apache.uima.UimaContext aContext)
                           throws IOException

Resolve a location (which can be many things) to an URL. If the location starts with classpath: the location is interpreted as a classpath location. Otherwise it is tried as a URL, file and at last UIMA resource. If the location is treated as a classpath or file location, an URL is only returned if the target exists. If it is an URL, it is possible that the target may not actually exist.

Parameters:

aLocation - a location (classpath, URL, file or UIMA resource location).

aCaller - the instance calling this method (for classpath loading).

aContext - a UIMA context.

Returns:

the resolved URL.

Throws:

IOException - if the target could not be found.

resolveLocation

public static URL resolveLocation(String aLocation,
                                  ClassLoader aClassLoader,
                                  org.apache.uima.UimaContext aContext)
                           throws IOException

Resolve a location (which can be many things) to an URL. If the location starts with classpath: the location is interpreted as a classpath location. Otherwise it is tried as a URL, file and at last UIMA resource. If the location is treated as a classpath or file location, an URL is only returned if the target exists. If it is an URL, it is possible that the target may not actually exist.

Parameters:

aLocation - a location (classpath, URL, file or UIMA resource location).

aClassLoader - the class loader to be used for classpath URLs.

aContext - a UIMA context.

Returns:

the resolved URL.

Throws:

IOException - if the target could not be found.