ai.djl.repository

Class AbstractRepository

java.lang.Object

ai.djl.repository.AbstractRepository

All Implemented Interfaces:

Repository

Direct Known Subclasses:

LocalRepository, RemoteRepository, SimpleRepository

public abstract class AbstractRepository
extends java.lang.Object
implements Repository

The AbstractRepository is the shared base for implementers of the Repository interface.

See Also:

Repository

Field Summary

Fields inherited from interface ai.djl.repository.Repository

GSON

Constructor Summary

Constructors

Constructor and Description
AbstractRepository()

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	getCacheDirectory() Returns the cache directory for the repository.
java.nio.file.Path	getFile(Artifact.Item item, java.lang.String path) Returns the path to a file for the item.
java.lang.String[]	listDirectory(Artifact.Item item, java.lang.String path) Returns the list of files directly within a specified directory in a zipped directory item.
java.io.InputStream	openStream(Artifact.Item item, java.lang.String path) Returns an InputStream for an item in a repository.
void	prepare(Artifact artifact, ai.djl.util.Progress progress) Prepares the artifact for use with progress tracking.
protected java.net.URI	resolvePath(Artifact.Item item, java.lang.String path)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.repository.Repository

getBaseUri, getName, isRemote, locate, newInstance, prepare, resolve

Constructor Detail

AbstractRepository

public AbstractRepository()

Method Detail

openStream

public java.io.InputStream openStream(Artifact.Item item,
                                      java.lang.String path)
                               throws java.io.IOException

Returns an InputStream for an item in a repository.

Specified by:

openStream in interface Repository

Parameters:

item - the item to open

path - the path to a file if the item is a zipped directory. Otherwise, pass null

Returns:

the file stream

Throws:

java.io.IOException - if it failed to open the stream

listDirectory

public java.lang.String[] listDirectory(Artifact.Item item,
                                        java.lang.String path)
                                 throws java.io.IOException

Returns the list of files directly within a specified directory in a zipped directory item.

Specified by:

listDirectory in interface Repository

Parameters:

item - the zipped directory item

path - the path within the zip directory

Returns:

the list of files/directories

Throws:

java.io.IOException - if it failed to list the directory

getFile

public java.nio.file.Path getFile(Artifact.Item item,
                                  java.lang.String path)
                           throws java.io.IOException

Returns the path to a file for the item.

Specified by:

getFile in interface Repository

Parameters:

item - the item to find the path for

path - the path to a file if the item is a zipped directory. Otherwise, pass null

Returns:

the file path

Throws:

java.io.IOException - if it failed to find the path

resolvePath

protected java.net.URI resolvePath(Artifact.Item item,
                                   java.lang.String path)
                            throws java.io.IOException

Throws:

java.io.IOException

prepare

public void prepare(Artifact artifact,
                    ai.djl.util.Progress progress)
             throws java.io.IOException

Prepares the artifact for use with progress tracking.

Specified by:

prepare in interface Repository

Parameters:

artifact - the artifact to prepare

progress - the progress tracker

Throws:

java.io.IOException - if it failed to prepare

getCacheDirectory

public java.nio.file.Path getCacheDirectory()
                                     throws java.io.IOException

Returns the cache directory for the repository.

Specified by:

getCacheDirectory in interface Repository

Returns:

the cache directory path

Throws:

java.io.IOException - if it failed to ensure the creation of the cache directory