org.researchstack.backbone

Class ResourcePathManager

java.lang.Object

org.researchstack.backbone.ResourcePathManager

public abstract class ResourcePathManager
extends java.lang.Object

This class is responsible for returning paths of resources defined in the assets folder. You should call init(ResourcePathManager) at the start of your application and pass in your implementation of this class. Wihtin there you will have to implement generatePath(int, String) method and return the relative path based on what file type it is.

The necessity of defining a file type is needed to keep compatibility with assets define in ResearchKit™ applications

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourcePathManager.Resource Class represents one asset within the assets folder.

Constructor Summary

Constructors

Constructor and Description
ResourcePathManager()

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateAbsolutePath(int type, java.lang.String name) Generates an absolute string file path
abstract java.lang.String	generatePath(int type, java.lang.String name) The genereatePath method is abstract as the Framework does not know what the parent directory of a file is.
java.lang.String	getFileExtension(int type)
static ResourcePathManager	getInstance() Returns the singleton instance of this class.
static java.io.InputStream	getResouceAsInputStream(android.content.Context context, java.lang.String filePath) Load resource from a file-path and turns contents to a InputStream for consumption
static byte[]	getResourceAsBytes(android.content.Context context, java.lang.String filePath) Load resource from a file-path and turns contents to a byte[] for consumption
static <T> T	getResourceAsClass(android.content.Context context, java.lang.Class<T> clazz, java.lang.String filePath) Load resource from a file-path and turns contents to a objects, of type T, for consumption
static java.lang.String	getResourceAsString(android.content.Context context, java.lang.String filePath) Load resource from a file-path and turns contents to a String for consumption
static void	init(ResourcePathManager manager) Initializes the ResourcePathManager singleton.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourcePathManager

public ResourcePathManager()

Method Detail

init

public static void init(ResourcePathManager manager)

Initializes the ResourcePathManager singleton. It is best to call this method inside your Application.onCreate() method.

Parameters:

manager - an implementation of ResourcePathManager

getInstance

public static ResourcePathManager getInstance()

Returns the singleton instance of this class.

Returns:

the singleton instance of this class

generatePath

public abstract java.lang.String generatePath(int type,
                                              java.lang.String name)

The genereatePath method is abstract as the Framework does not know what the parent directory of a file is. While it is possible to open a file using only the fileName, there are many instances where we need the path of a file instead (like for WebView). This method is used for that purpose and is used to get the path of a resource when the framework only knows the name of the file and what type of file it is.

Parameters:

type - the type of file. This will be used for appending the file extension.

name - the name of the file

Returns:

a path relative to the asset folder

generateAbsolutePath

public java.lang.String generateAbsolutePath(int type,
                                             java.lang.String name)

Generates an absolute string file path

Parameters:

type - the type of file. This will be used for appending the file extension.

name - the name of the file

Returns:

an absolute path for a file

getFileExtension

public java.lang.String getFileExtension(int type)

Parameters:

type - the type of file. Supported file types are defined within the ResourcePathManager.Resource class. You may override this method in your implementation and implement your own cases

Returns:

file extension of a file type

getResourceAsString

public static java.lang.String getResourceAsString(android.content.Context context,
                                                   java.lang.String filePath)

Load resource from a file-path and turns contents to a String for consumption

Parameters:

context - android context

filePath - relative file path

Returns:

String representation of the file

getResourceAsBytes

public static byte[] getResourceAsBytes(android.content.Context context,
                                        java.lang.String filePath)

Load resource from a file-path and turns contents to a byte[] for consumption

Parameters:

context - android context

filePath - relative file path

Returns:

byte [] representation of the asset

getResouceAsInputStream

public static java.io.InputStream getResouceAsInputStream(android.content.Context context,
                                                          java.lang.String filePath)

Load resource from a file-path and turns contents to a InputStream for consumption

Parameters:

context - android context

filePath - relative file path

Returns:

InputStream representation of the asset

getResourceAsClass

public static <T> T getResourceAsClass(android.content.Context context,
                                       java.lang.Class<T> clazz,
                                       java.lang.String filePath)

Load resource from a file-path and turns contents to a objects, of type T, for consumption

Parameters:

context - android context

clazz - the class of T

filePath - relative file path

Returns:

Class representation of the asset