hex.createframe.columns

Class StringColumnCfcm

java.lang.Object

water.Iced<CreateFrameColumnMaker>

hex.createframe.CreateFrameColumnMaker

hex.createframe.columns.StringColumnCfcm

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<CreateFrameColumnMaker>

public class StringColumnCfcm
extends CreateFrameColumnMaker

Random string column.

See Also:

Serialized Form

Field Summary

Fields inherited from class hex.createframe.CreateFrameColumnMaker

index

Constructor Summary

Constructors

Constructor and Description
StringColumnCfcm()
StringColumnCfcm(java.lang.String colName, int length)

Method Summary

Modifier and Type	Method and Description
float	byteSizePerRow() Estimated byte size of a single row created by this column maker.
java.lang.String[]	columnNames() Names of the columns produces by this column maker.
byte[]	columnTypes() Types of the columns produced by the column maker.
void	exec(int nrows, NewChunk[] ncs, java.util.Random rng) Implement this method in a subclass to actually build the columns.
int	workAmount() Relative amount of work this column maker performs to fill a chunk.

Methods inherited from class hex.createframe.CreateFrameColumnMaker

columnDomains, numColumns, setIndex

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Constructor Detail

StringColumnCfcm

public StringColumnCfcm()

StringColumnCfcm

public StringColumnCfcm(java.lang.String colName,
                        int length)

Method Detail

exec

public void exec(int nrows,
                 NewChunk[] ncs,
                 java.util.Random rng)

Description copied from class: CreateFrameColumnMaker

Implement this method in a subclass to actually build the columns.

Specified by:

exec in class CreateFrameColumnMaker

Parameters:

nrows - Number of rows in the current chunk. If method is creating new columns, then it is supposed to add this many rows.

ncs - The `NewChunk`s array passed down from the `map()` method in `MRTask`. A subclass is expected to know which NewChunks it is allowed to touch, usually with the help of the CreateFrameColumnMaker.index variable.

rng - Random number generator that the subclass may use to fill the columns randomly. Do NOT use any other random generator as doing so will break the reproducibility promise of the CreateFrame service.

columnNames

public java.lang.String[] columnNames()

Description copied from class: CreateFrameColumnMaker

Names of the columns produces by this column maker. Should also have the same number of elements as given by CreateFrameColumnMaker.numColumns().

Specified by:

columnNames in class CreateFrameColumnMaker

columnTypes

public byte[] columnTypes()

Description copied from class: CreateFrameColumnMaker

Types of the columns produced by the column maker. The returned array should have exactly the same number of elements as given by CreateFrameColumnMaker.numColumns().

Specified by:

columnTypes in class CreateFrameColumnMaker

byteSizePerRow

public float byteSizePerRow()

Description copied from class: CreateFrameColumnMaker

Estimated byte size of a single row created by this column maker. This estimate is later used to determine optimal chunk size for the produced frame, thus it doesn't have to be very precise.

Overrides:

byteSizePerRow in class CreateFrameColumnMaker

workAmount

public int workAmount()

Description copied from class: CreateFrameColumnMaker

Relative amount of work this column maker performs to fill a chunk. The base amount of 100 corresponds to a method that draws a single random number per row and then uses simple arithmetic before adding a value to the NewChunk.

The output will be used to inform te Job about progress being made. It needn't be very precise.

Overrides:

workAmount in class CreateFrameColumnMaker