org.nd4j.resources.strumpf

Class StrumpfResolver

java.lang.Object

org.nd4j.resources.strumpf.StrumpfResolver

All Implemented Interfaces:

Resolver

public class StrumpfResolver
extends java.lang.Object
implements Resolver

Resource resources based on Strumpf resource files, or standard files
https://github.com/deeplearning4j/strumpf
Note that resource files (those with path ending with REF) point to remote files, that will be downloaded, decompressed and cached locally.
The default cache location is DEFAULT_CACHE_DIR; this can be overridden by setting the ND4JSystemProperties#RESOURCES_CACHE_DIR system property.


Two resolution methods are supported:
1. Resolving from the classpath
2. Resolving from one of any specified directories

Resolving from specified directories: You can point this to one or more local directories (rather than relying on classpath) when resolving resources. This can be done by setting the ND4JSystemProperties.RESOURCES_LOCAL_DIRS

Author:

Alex Black

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	cacheDir
static java.lang.String	DEFAULT_CACHE_DIR
protected java.util.List<java.lang.String>	localResourceDirs
static java.lang.String	REF

Constructor Summary

Constructors

Constructor and Description
StrumpfResolver()

Method Summary

Modifier and Type	Method and Description
java.io.File	asFile(java.lang.String resourcePath) Get the specified resources as a standard local file.
protected void	assertExists(java.lang.String resourcePath)
java.io.InputStream	asStream(java.lang.String resourcePath) Get the specified resources as an input stream.
void	copyDirectory(java.lang.String dirPath, java.io.File destinationDir) Copy the directory resource (recursively) to the specified destination directory
boolean	directoryExists(java.lang.String dirPath) Determine if the specified directory resource can be resolved by Resolver.copyDirectory(String, File)
boolean	exists(java.lang.String resourcePath) Determine if the specified file resource can be resolved by Resolver.asFile(String) and Resolver.asStream(String)
boolean	hasLocalCache()
java.io.File	localCacheRoot()
int	priority() Priority of this resolver.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CACHE_DIR

public static final java.lang.String DEFAULT_CACHE_DIR

REF

public static final java.lang.String REF

See Also:

Constant Field Values

localResourceDirs

protected final java.util.List<java.lang.String> localResourceDirs

cacheDir

protected final java.io.File cacheDir

Constructor Detail

StrumpfResolver

public StrumpfResolver()

Method Detail

priority

public int priority()

Description copied from interface: Resolver

Priority of this resolver. 0 is highest priority (check first), larger values are lower priority (check last)

Specified by:

priority in interface Resolver

exists

public boolean exists(@NonNull
                      java.lang.String resourcePath)

Description copied from interface: Resolver

Determine if the specified file resource can be resolved by Resolver.asFile(String) and Resolver.asStream(String)

Specified by:

exists in interface Resolver

Parameters:

resourcePath - Path of the resource to be resolved

Returns:

True if this resolver is able to resolve the resource file - i.e., whether it is a valid path and exists

directoryExists

public boolean directoryExists(java.lang.String dirPath)

Description copied from interface: Resolver

Determine if the specified directory resource can be resolved by Resolver.copyDirectory(String, File)

Specified by:

directoryExists in interface Resolver

Parameters:

dirPath - Path of the directory resource to be resolved

Returns:

True if this resolver is able to resolve the directory - i.e., whether it is a valid path and exists

asFile

public java.io.File asFile(java.lang.String resourcePath)

Description copied from interface: Resolver

Get the specified resources as a standard local file. Note that the resource must exist as determined by Resolver.exists(String)

Specified by:

asFile in interface Resolver

Parameters:

resourcePath - Path of the resource.

Returns:

The local file version of the resource

asStream

public java.io.InputStream asStream(java.lang.String resourcePath)

Description copied from interface: Resolver

Get the specified resources as an input stream. Note that the resource must exist as determined by Resolver.exists(String)

Specified by:

asStream in interface Resolver

Parameters:

resourcePath - Path of the resource.

Returns:

The resource as an input stream

copyDirectory

public void copyDirectory(java.lang.String dirPath,
                          java.io.File destinationDir)

Description copied from interface: Resolver

Copy the directory resource (recursively) to the specified destination directory

Specified by:

copyDirectory in interface Resolver

Parameters:

dirPath - Path of the resource directory to resolve

destinationDir - Where the files should be copied to

hasLocalCache

public boolean hasLocalCache()

Specified by:

hasLocalCache in interface Resolver

Returns:

True if the resolver has a local cache directory, as returned by Resolver.localCacheRoot()

localCacheRoot

public java.io.File localCacheRoot()

Specified by:

localCacheRoot in interface Resolver

Returns:

Root directory of the local cache, or null if Resolver.hasLocalCache() returns false

assertExists

protected void assertExists(java.lang.String resourcePath)