hex

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

java.lang.Object

hex.genmodel.AbstractMojoWriter

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

All Implemented Interfaces:

StreamWriter

Direct Known Subclasses:

MultiModelMojoWriter

public abstract class ModelMojoWriter<M extends Model<M,P,O>,P extends Model.Parameters,O extends Model.Output>
extends hex.genmodel.AbstractMojoWriter
implements 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:

• AbstractMojoWriter.writekv(String, Object) to serialize any "simple" values (those that can be represented as a single-line string).
• AbstractMojoWriter.writeblob(String, byte[]) to add arbitrary blobs of data to the archive.
• AbstractMojoWriter.startWritingTextFile(String) / AbstractMojoWriter.writeln(String) / AbstractMojoWriter.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

Constructor Summary

Constructors

Constructor and Description
ModelMojoWriter()
ModelMojoWriter(M model)

Method Summary

Modifier and Type	Method and Description
void	write2DArray(double[][] array, java.lang.String title)
void	write2DStringArrays(java.lang.String[][] sArrays, java.lang.String title)
void	write3DArray(double[][][] array, java.lang.String title)
void	write3DIntArray(int[][][] array, java.lang.String title)
void	writeDoubleArray(double[][] array, java.lang.String title)
protected void	writeExtraInfo()
protected abstract void	writeModelData()
void	writeRectangularDoubleArray(double[][] array, java.lang.String title)
void	writeStringArrays(java.lang.String[] sArrays, java.lang.String title)
void	writeTo(java.io.OutputStream os, StreamWriteOption... option) Used from `ModelsHandler.fetchMojo()` to serialize the Mojo into a StreamingSchema.

Methods inherited from class hex.genmodel.AbstractMojoWriter

finishWritingTextFile, mojoVersion, startWritingTextFile, write, writeblob, writeDomains, writekv, writekv, writekv, writekv, writeln, writeln, writelnkv, writeStringArray, writeTo, writeTo

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

Constructor Detail

ModelMojoWriter

public ModelMojoWriter()

ModelMojoWriter

public ModelMojoWriter(M model)

Method Detail

writeTo

public void writeTo(java.io.OutputStream os,
                    StreamWriteOption... option)

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 interface StreamWriter

Parameters:

os - output stream provided by framework

writeModelData

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

Specified by:

writeModelData in class hex.genmodel.AbstractMojoWriter

Throws:

java.io.IOException

writeExtraInfo

protected void writeExtraInfo()
                       throws java.io.IOException

Overrides:

writeExtraInfo in class hex.genmodel.AbstractMojoWriter

Throws:

java.io.IOException

writeStringArrays

public void writeStringArrays(java.lang.String[] sArrays,
                              java.lang.String title)
                       throws java.io.IOException

Throws:

java.io.IOException

writeRectangularDoubleArray

public void writeRectangularDoubleArray(double[][] array,
                                        java.lang.String title)
                                 throws java.io.IOException

Throws:

java.io.IOException

writeDoubleArray

public void writeDoubleArray(double[][] array,
                             java.lang.String title)
                      throws java.io.IOException

Throws:

java.io.IOException

write2DStringArrays

public void write2DStringArrays(java.lang.String[][] sArrays,
                                java.lang.String title)
                         throws java.io.IOException

Throws:

java.io.IOException

write2DArray

public void write2DArray(double[][] array,
                         java.lang.String title)
                  throws java.io.IOException

Throws:

java.io.IOException

write3DIntArray

public void write3DIntArray(int[][][] array,
                            java.lang.String title)
                     throws java.io.IOException

Throws:

java.io.IOException

write3DArray

public void write3DArray(double[][][] array,
                         java.lang.String title)
                  throws java.io.IOException

Throws:

java.io.IOException