hex

Class ModelMojoWriter<M extends Model<M,P,O>,P extends Model.Parameters,O extends Model.Output>

java.lang.Object

water.api.StreamWriter

hex.ModelMojoWriter<M,P,O>

Type Parameters:

M - model class that your ModelMojoWriter serializes

P - model parameters class that corresponds to your model

O - model output class that corresponds to your model

Direct Known Subclasses:

MultiModelMojoWriter

public abstract class ModelMojoWriter<M extends Model<M,P,O>,P extends Model.Parameters,O extends Model.Output>
extends StreamWriter

Base class for serializing models into the MOJO format.

The function of a MOJO writer is simply to write the model into a Zip archive consisting of several text/binary files. This base class handles serialization of some parameters that are common to all `Model`s, but anything specific to a particular Model should be implemented in that Model's corresponding ModelMojoWriter subclass.

When implementing a subclass, you have to override the single functions writeModelData(). Within this function you can use any of the following:

• writekv(String, Object) to serialize any "simple" values (those that can be represented as a single-line string).
• writeblob(String, byte[]) to add arbitrary blobs of data to the archive.
• startWritingTextFile(String) / writeln(String) / finishWritingTextFile() to add text files to the archive.

After subclassing this class, you should also override the Model.getMojo() method in your model's class to return an instance of your new child class.

Field Summary

Fields

Modifier and Type	Field and Description
protected M	model Reference to the model being written.

Constructor Summary

Constructors

Constructor and Description
ModelMojoWriter()
ModelMojoWriter(M model)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finishWritingTextFile() Finish writing a text file.
abstract java.lang.String	mojoVersion() Version of the mojo file produced.
protected void	startWritingTextFile(java.lang.String filename) Write a text file to the MOJO archive (or rather open such file for writing).
protected void	writeblob(java.lang.String filename, byte[] blob) Write a binary file to the MOJO archive.
protected void	writekv(java.lang.String key, double[] value)
protected void	writekv(java.lang.String key, int[] value)
protected void	writekv(java.lang.String key, java.lang.Object value) Write a simple value to the model.ini/[info] section.
protected void	writeln(java.lang.String s) Write a single line of text to a previously opened text file.
protected void	writeln(java.lang.String s, boolean escapeNewlines) Write a single line of text to a previously opened text file, escape new line characters if enabled.
protected abstract void	writeModelData() Override in subclasses to write the actual model data.
void	writeTo(java.io.OutputStream os) Used from `ModelsHandler.fetchMojo()` to serialize the Mojo into a StreamingSchema.
protected void	writeTo(java.util.zip.ZipOutputStream zos)
void	writeTo(java.util.zip.ZipOutputStream zos, java.lang.String zipDirectory)

Methods inherited from class java.lang.Object

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

Field Detail

model

protected M extends Model<M,P,O> model

Reference to the model being written. Use this in the subclasses to retreive information from your model.

Constructor Detail

ModelMojoWriter

public ModelMojoWriter()

ModelMojoWriter

public ModelMojoWriter(M model)

Method Detail

mojoVersion

public abstract java.lang.String mojoVersion()

Version of the mojo file produced. Follows the major.minor format, where minor is a 2-digit number. For example "1.00", "2.05", "2.13". See README in mojoland repository for more details.

writeModelData

protected abstract void writeModelData()
                                throws java.io.IOException

Override in subclasses to write the actual model data.

Throws:

java.io.IOException

writekv

protected final void writekv(java.lang.String key,
           java.lang.Object value)
                      throws java.io.IOException

Write a simple value to the model.ini/[info] section. Here "simple" means a value that can be stringified with .toString(), and its stringified version does not span multiple lines.

Throws:

java.io.IOException

writekv

protected final void writekv(java.lang.String key,
           int[] value)
                      throws java.io.IOException

Throws:

java.io.IOException

writekv

protected final void writekv(java.lang.String key,
           double[] value)
                      throws java.io.IOException

Throws:

java.io.IOException

writeblob

protected final void writeblob(java.lang.String filename,
             byte[] blob)
                        throws java.io.IOException

Write a binary file to the MOJO archive.

Throws:

java.io.IOException

startWritingTextFile

protected final void startWritingTextFile(java.lang.String filename)

Write a text file to the MOJO archive (or rather open such file for writing).

writeln

protected final void writeln(java.lang.String s,
           boolean escapeNewlines)

Write a single line of text to a previously opened text file, escape new line characters if enabled.

writeln

protected final void writeln(java.lang.String s)

Write a single line of text to a previously opened text file.

finishWritingTextFile

protected final void finishWritingTextFile()
                                    throws java.io.IOException

Finish writing a text file.

Throws:

java.io.IOException

writeTo

public final void writeTo(java.io.OutputStream os)

Used from `ModelsHandler.fetchMojo()` to serialize the Mojo into a StreamingSchema. The structure of the zip will be the following: model.ini domains/ d000.txt d001.txt ... (extra model files written by the subclasses) Each domain file is a plain text file with one line per category (not quoted).

Specified by:

writeTo in class StreamWriter

Parameters:

os - output stream provided by framework

writeTo

protected void writeTo(java.util.zip.ZipOutputStream zos)
                throws java.io.IOException

Throws:

java.io.IOException

writeTo

public final void writeTo(java.util.zip.ZipOutputStream zos,
           java.lang.String zipDirectory)
                   throws java.io.IOException

Throws:

java.io.IOException