water.fvec

Class TestFrameBuilder

java.lang.Object

water.fvec.TestFrameBuilder

public class TestFrameBuilder
extends java.lang.Object

Class used for creating simple test frames using builder pattern

Example usage:

 final Frame builder = new TestFrameBuilder()
   .withName("testFrame")
   .withColNames("ColA", "ColB", "ColC")
   .withVecTypes(Vec.T_NUM, Vec.T_STR, Vec.T_CAT)
   .withDataForCol(0, ard(Double.NaN, 1, 2, 3, 4, 5.6, 7))
   .withDataForCol(1, ar("A", "B", "C", "E", "F", "I", "J"))
   .withDataForCol(2, ar("A", "B,", "A", "C", "A", "B", "A"))
   .withChunkLayout(2, 2, 2, 1)
   .build();
 
 

Data for categorical column are set in the same way as for string column and leves are created automatically.
All methods in this builder are optional:

• Frame name is created it not provided.
• Column names are created automatically if not provided.
• Vector types are initialized to all T_NUMs when not provided. For example, creating empty frame ( no data, co columns) can be created as Frame fr = new TestFrameBuilder().build().
• Column data are initialized to empty array when not provided. The following example creates frames with 2 columns, but no data. Frame fr = new TestFrameBuilder().withVecTypes(Vec.T_NUM).build().
• Only one chunk is created when chunk layout is not provided.

The frame created will be automatically tracked in the currently active Scope.

Constructor Summary

Constructors

Constructor and Description
TestFrameBuilder()

Method Summary

Modifier and Type	Method and Description
water.fvec.Frame	build()
TestFrameBuilder	withChunkLayout(long... chunkLayout)
TestFrameBuilder	withColNames(java.lang.String... colNames) Sets the names for the columns.
TestFrameBuilder	withDataForCol(int column, double[] data) Sets data for a particular column
TestFrameBuilder	withDataForCol(int column, int[] data) Sets data for a particular column
TestFrameBuilder	withDataForCol(int column, long[] data) Sets data for a particular column
TestFrameBuilder	withDataForCol(int column, java.lang.String[] data) Sets data for a particular column
TestFrameBuilder	withDomain(int column, java.lang.String[] domain)
TestFrameBuilder	withName(java.lang.String frameName) Sets the name for the frame.
TestFrameBuilder	withName(java.lang.String frameName, water.rapids.Session session)
TestFrameBuilder	withRandomBinaryDataForCol(int column, int size, long seed) Genarate random binary data for a particular column
TestFrameBuilder	withRandomDoubleDataForCol(int column, int size, int min, int max, long seed) Genarate random double data for a particular column
TestFrameBuilder	withRandomIntDataForCol(int column, int size, int min, int max, long seed) Genarate random double data for a particular column
TestFrameBuilder	withSequenceIntDataForCol(int column, int from, int to) Generate sequence of integer data
TestFrameBuilder	withUniformVecTypes(int nvecs, byte vecType) Sets the vectors types to a single, uniform value for each vector
TestFrameBuilder	withVecTypes(byte... vecTypes) Sets the vector types.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestFrameBuilder

public TestFrameBuilder()

Method Detail

withName

public TestFrameBuilder withName(java.lang.String frameName)

Sets the name for the frame. Default name is created if this method is not called.

withName

public TestFrameBuilder withName(java.lang.String frameName,
                                 water.rapids.Session session)

withColNames

public TestFrameBuilder withColNames(java.lang.String... colNames)

Sets the names for the columns. Default names are created if this method is not called.

withVecTypes

public TestFrameBuilder withVecTypes(byte... vecTypes)

Sets the vector types. Vector types are initialized to empty array if this method is not called.

withUniformVecTypes

public TestFrameBuilder withUniformVecTypes(int nvecs,
                                            byte vecType)

Sets the vectors types to a single, uniform value for each vector

Parameters:

nvecs - Number of vectors in the frame

vecType - Uniform type of the vectors

withSequenceIntDataForCol

public TestFrameBuilder withSequenceIntDataForCol(int column,
                                                  int from,
                                                  int to)

Generate sequence of integer data

Parameters:

column - for which to set data

from - minimal value to generate (included)

to - maximum value to generate (excluded)

withRandomIntDataForCol

public TestFrameBuilder withRandomIntDataForCol(int column,
                                                int size,
                                                int min,
                                                int max,
                                                long seed)

Genarate random double data for a particular column

Parameters:

column - for which to set data

size - size of randomly generated column

min - minimal value to generate

max - maximum value to generate

withRandomDoubleDataForCol

public TestFrameBuilder withRandomDoubleDataForCol(int column,
                                                   int size,
                                                   int min,
                                                   int max,
                                                   long seed)

Genarate random double data for a particular column

Parameters:

column - for which to set data

size - size of randomly generated column

min - minimal value to generate

max - maximum value to generate

withRandomBinaryDataForCol

public TestFrameBuilder withRandomBinaryDataForCol(int column,
                                                   int size,
                                                   long seed)

Genarate random binary data for a particular column

Parameters:

column - for which to set data

withDataForCol

public TestFrameBuilder withDataForCol(int column,
                                       java.lang.String[] data)

Sets data for a particular column

Parameters:

column - for which to set data

data - array of string data

withDataForCol

public TestFrameBuilder withDataForCol(int column,
                                       double[] data)

Sets data for a particular column

Parameters:

column - for which to set data

data - array of double data

withDataForCol

public TestFrameBuilder withDataForCol(int column,
                                       long[] data)

Sets data for a particular column

Parameters:

column - for which to set data

data - array of long data

withDataForCol

public TestFrameBuilder withDataForCol(int column,
                                       int[] data)

Sets data for a particular column

Parameters:

column - for which to set data

data - array of long data

withDomain

public TestFrameBuilder withDomain(int column,
                                   java.lang.String[] domain)

withChunkLayout

public TestFrameBuilder withChunkLayout(long... chunkLayout)

build

public water.fvec.Frame build()