ai.h2o.mojos.runtime.frame

Class MojoFrameBuilder

java.lang.Object

ai.h2o.mojos.runtime.frame.MojoFrameBuilder

public class MojoFrameBuilder
extends java.lang.Object

The builder is used for constructing a MojoFrame. A frame is constructed by the following procedure:

1. Get a MojoRowBuilder instance from the frame builder
2. Construct a row from the MojoRowBuilder
3. Append the resulting row to the frame builder
4. Repeat steps 1-3 until all rows are constructed
5. Construct the MojoFrame

See MojoRowBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static StringConverter	DEFAULT_CONVERTER

Constructor Summary

Constructors

Constructor and Description
MojoFrameBuilder(MojoFrameMeta frameMeta) Constructor for a MojoFrameBuilder.
MojoFrameBuilder(MojoFrameMeta frameMeta, java.util.Collection<java.lang.String> missingValues) Constructor for a MojoFrameBuilder.
MojoFrameBuilder(MojoFrameMeta frameMeta, java.util.Collection<java.lang.String> missingValues, java.util.Map<java.lang.String,StringConverter> stringConverters) Constructor for a MojoFrameBuilder.

Method Summary

Modifier and Type	Method and Description
MojoRowBuilder	addRow(MojoRowBuilder rowBuilder) Append a row from the current state of a MojoRowBuilder.
static MojoFrame	fromColumns(MojoFrameMeta meta, MojoColumn[] columns) Create a MojoFrame from an array of MojoColumns as specified by the provided meta data.
static MojoFrame	fromFrames(MojoFrameMeta meta, MojoFrame... frames) Create a MojoFrame in accordance to a MojoFrameMeta by concatenating a series of existing MojoFrames.
static MojoFrame	getEmpty(MojoFrameMeta meta, int nrows) Create a MojoFrame with nrows rows based on the meta data provided.
MojoRowBuilder	getMojoRowBuilder() Get an instance of a MojoRowBuilder that can be used to construct a row for this builder.
MojoRowBuilder	getMojoRowBuilder(boolean strictMode) Get an instance of a MojoRowBuilder that can be used to construct a row for this builder.
MojoFrame	toMojoFrame() Create a MojoFrame from the current state of this builder

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONVERTER

public static final StringConverter DEFAULT_CONVERTER

Constructor Detail

MojoFrameBuilder

public MojoFrameBuilder(MojoFrameMeta frameMeta,
                        java.util.Collection<java.lang.String> missingValues)

Constructor for a MojoFrameBuilder.

Parameters:

frameMeta - The meta data for the resulting frame (see MojoFrameMeta)

missingValues - List of string values which are interpreted as missing value.

MojoFrameBuilder

public MojoFrameBuilder(MojoFrameMeta frameMeta,
                        java.util.Collection<java.lang.String> missingValues,
                        java.util.Map<java.lang.String,StringConverter> stringConverters)

Constructor for a MojoFrameBuilder.

Parameters:

frameMeta - The meta data for the resulting frame (see MojoFrameMeta)

missingValues - List of string values which are interpreted as missing value.

stringConverters - A Map that associates column names to their respective StringConverter. DEFAULT_CONVERTER is used if a column’s name is not found in the Map

MojoFrameBuilder

public MojoFrameBuilder(MojoFrameMeta frameMeta)

Constructor for a MojoFrameBuilder.

Parameters:

frameMeta - The meta data for the resulting frame (see MojoFrameMeta)

Method Detail

addRow

public MojoRowBuilder addRow(MojoRowBuilder rowBuilder)

Append a row from the current state of a MojoRowBuilder. The MojoRowBuilder will subsequently be reset.

Parameters:

rowBuilder - The MojoRowBuilder containing the row to be constructed and appended

Returns:

The given MojoRowBuilder instance with its state reset

getMojoRowBuilder

public MojoRowBuilder getMojoRowBuilder()

Get an instance of a MojoRowBuilder that can be used to construct a row for this builder. Each call to this method creates a new MojoRowBuilder instance

Returns:

A MojoRowBuilder for constructing rows for this frame builder

getMojoRowBuilder

public MojoRowBuilder getMojoRowBuilder(boolean strictMode)

Get an instance of a MojoRowBuilder that can be used to construct a row for this builder. Each call to this method creates a new MojoRowBuilder instance

Parameters:

strictMode - flag to determine if the created MojoRowBuilder should be in “strict” mode (see MojoRowBuilder).

Returns:

A MojoRowBuilder for constructing rows for this frame builder

toMojoFrame

public MojoFrame toMojoFrame()

Create a MojoFrame from the current state of this builder

Returns:

The constructed MojoFrame

getEmpty

public static MojoFrame getEmpty(MojoFrameMeta meta,
                                 int nrows)

Create a MojoFrame with nrows rows based on the meta data provided. The values in this frame will all be NA.

Parameters:

meta - The meta data of the frame to be constructed

nrows - The number of rows

Returns:

A new MojoFrame filled with NA values

fromFrames

public static MojoFrame fromFrames(MojoFrameMeta meta,
                                   MojoFrame... frames)

Create a MojoFrame in accordance to a MojoFrameMeta by concatenating a series of existing MojoFrames. This means that columns are added to the return frame based on position and not by name. The total number of columns across all of the argument frames must match the size of the meta data, and each argument frame must have the same number of rows. The resulting frame contains references to the same column instances

Parameters:

meta - The meta data to use as a template for the return frame

frames - The frame(s) to be used to construct the return frame

Returns:

A MojoFrame containg references to the columns in the argument frames

fromColumns

public static MojoFrame fromColumns(MojoFrameMeta meta,
                                    MojoColumn[] columns)

Create a MojoFrame from an array of MojoColumns as specified by the provided meta data.

Parameters:

meta - The meta data to be used as a template

columns - The columns to be used in the resulting frame

Returns:

A new MojoFrame