ai.h2o.mojos.runtime.readers

Class MojoReaderBackend

java.lang.Object

ai.h2o.mojos.runtime.readers.MojoReaderBackend

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

FolderMojoReaderBackend, InMemoryMojoReaderBackend, MojofileMojoReaderBackend

Deprecated.

@Deprecated
public abstract class MojoReaderBackend
extends java.lang.Object
implements java.io.Closeable

Interface representing a class capable of reading mojos. Usually the class implementing this interface will have a constructor taking an “address” of the mojo file that should be read. The class would then have to implement the logic for reading the referred mojo from the source.

For example, a hypothetical MysqlMojoReaderBackend may have a constructor taking the URL of the server, connection credentials, and a SQL query for retrieving the mojo record. The class would then implement the logic for connecting to the database and fetching the mojo (whole or in parts). It would also throw an IOException if anything fails.

The actual interface that the class needs to implement is for reading either text or binary fragments from within the mojo. This is because a .mojo file is actually a zip archive, and hence it contains several “files” inside. The user may decide to repackage the mojo contents into a different container: a plain directory for easier access, a .7z file for better compression, an encrypted Zip file for better security, etc. If the reader doesn’t wish to re-package the mojo contents and only retrieve it from non-filesystem source, then it may create a temporary .mojo file and pass it to the MojofileMojoReaderBackend reader.

Field Summary

Fields

Modifier and Type	Field and Description
protected ai.h2o.mojos.runtime.api.backend.ReaderBackend	backend Deprecated.
static java.lang.String	DEFAULT_BASE_DIR Deprecated. Default top-level directory, where mojo content is stored.
static java.lang.String	DEFAULT_PROTO_PIPELINE_FILE_PATH Deprecated. Default file path for proto-based pipeline
static java.lang.String	DEFAULT_PROTO_PIPELINE_FILENAME Deprecated.
static java.lang.String	DEFAULT_TOML_PIPELINE_FILE_PATH Deprecated. Default file path for toml-based pipeline
static java.lang.String	DEFAULT_TOML_PIPELINE_FILENAME Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MojoReaderBackend(ai.h2o.mojos.runtime.api.backend.ReaderBackend backend, java.lang.String baseDir, java.lang.String ignored, java.lang.String pipelineFileName) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
static boolean	endsWithSeparator(java.lang.String path) Deprecated. This is very safe way to check if a path ends with separator character, no matter which platform was used to produce the path and which platform we use it on.
boolean	exists(java.lang.String filename) Deprecated.
java.lang.String	getBaseDir() Deprecated.
byte[]	getBinaryFile(java.lang.String filename) Deprecated. Retrieve binary content inside the mojo, as a byte[] array.
java.io.InputStream	getFile(java.lang.String filename) Deprecated. Retrieve content inside the mojo, as a InputStream.
java.lang.String	getPipelineFileName() Deprecated. Get pipeline file path relative to baseDir.
java.lang.String	getSeparator() Deprecated. use just slash (/) instead, it is supported on all systems equally well, or use File.separator if that makes you feel better
java.io.BufferedReader	getTextFile(java.lang.String filename) Deprecated. Retrieve text content inside the mojo, as a BufferedReader.
ai.h2o.mojos.runtime.api.backend.ReaderBackend	internalGetReaderBackend() Deprecated. Do not use.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BASE_DIR

public static java.lang.String DEFAULT_BASE_DIR

Deprecated.

Default top-level directory, where mojo content is stored.

DEFAULT_PROTO_PIPELINE_FILENAME

public static java.lang.String DEFAULT_PROTO_PIPELINE_FILENAME

Deprecated.

DEFAULT_TOML_PIPELINE_FILENAME

public static java.lang.String DEFAULT_TOML_PIPELINE_FILENAME

Deprecated.

DEFAULT_PROTO_PIPELINE_FILE_PATH

public static java.lang.String DEFAULT_PROTO_PIPELINE_FILE_PATH

Deprecated.

Default file path for proto-based pipeline

DEFAULT_TOML_PIPELINE_FILE_PATH

public static java.lang.String DEFAULT_TOML_PIPELINE_FILE_PATH

Deprecated.

Default file path for toml-based pipeline

backend

protected final ai.h2o.mojos.runtime.api.backend.ReaderBackend backend

Deprecated.

Constructor Detail

MojoReaderBackend

protected MojoReaderBackend(ai.h2o.mojos.runtime.api.backend.ReaderBackend backend,
                            java.lang.String baseDir,
                            java.lang.String ignored,
                            java.lang.String pipelineFileName)

Deprecated.

Method Detail

close

public final void close()
                 throws java.io.IOException

Deprecated.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getFile

public final java.io.InputStream getFile(java.lang.String filename)
                                  throws java.io.IOException

Deprecated.

Retrieve content inside the mojo, as a InputStream.

Throws:

java.io.IOException

getTextFile

public final java.io.BufferedReader getTextFile(java.lang.String filename)
                                         throws java.io.IOException

Deprecated.

Retrieve text content inside the mojo, as a BufferedReader.

Throws:

java.io.IOException

getBinaryFile

public final byte[] getBinaryFile(java.lang.String filename)
                           throws java.io.IOException

Deprecated.

Retrieve binary content inside the mojo, as a byte[] array.

Throws:

java.io.IOException

exists

public final boolean exists(java.lang.String filename)

Deprecated.

internalGetReaderBackend

public ai.h2o.mojos.runtime.api.backend.ReaderBackend internalGetReaderBackend()

Deprecated.

Do not use. Not useful outside mojo2 project.
Exists only for retaining API compatibility inside mojo2 classes, and will be removed in future versions, without notice, deprecation phase and replacement.

getPipelineFileName

public java.lang.String getPipelineFileName()

Deprecated.

Get pipeline file path relative to baseDir.

getBaseDir

public java.lang.String getBaseDir()

Deprecated.

getSeparator

@Deprecated
public java.lang.String getSeparator()

Deprecated. use just slash (/) instead, it is supported on all systems equally well, or use File.separator if that makes you feel better

endsWithSeparator

public static boolean endsWithSeparator(java.lang.String path)

Deprecated.

This is very safe way to check if a path ends with separator character, no matter which platform was used to produce the path and which platform we use it on.

Parameters:

path - -

Returns:

true if the last character is separator