ai.h2o.mojos.runtime.frame

Class MojoFrameMeta

java.lang.Object

ai.h2o.mojos.runtime.frame.MojoFrameMeta

All Implemented Interfaces:

java.io.Serializable

public class MojoFrameMeta
extends java.lang.Object
implements java.io.Serializable

MojoFrame meta data

Container for meta data of a MojoFrame. This immutable class is used as a template for constructing MojoFrames in addition to providing names to the columns of an existing MojoFrame.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MojoFrameMeta(java.lang.String[] columnNames, MojoColumn.Type[] columnTypes) Construct a MojoFrameMeta instance with the given column names and types.

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.String columnName) Checks if there exists meta data for a column with a particular name
int	getColumnIndex(java.lang.String columnName) Get the index of a column with the name columnName
java.lang.String	getColumnName(int index) Get the name of a column at a particular index
java.lang.String[]	getColumnNames()
protected java.util.Map<java.lang.String,java.lang.Integer>	getColumnNamesMap()
MojoColumn.Type	getColumnType(int index) Get the type of a column at a particular index
MojoColumn.Type	getColumnType(java.lang.String columnName) Get the type of a column with the name columnName
MojoColumn.Type[]	getColumnTypes()
static MojoFrameMeta	getEmpty() Make a MojoFrameMeta instance with no columns
int	size() Get the number of columns in this instance

Methods inherited from class java.lang.Object

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

Constructor Detail

MojoFrameMeta

public MojoFrameMeta(java.lang.String[] columnNames,
                     MojoColumn.Type[] columnTypes)

Construct a MojoFrameMeta instance with the given column names and types. The length of the two array arguments must be equal.

Parameters:

columnNames - The names of the columns

columnTypes - The types of the columns

Method Detail

getColumnIndex

public int getColumnIndex(java.lang.String columnName)

Get the index of a column with the name columnName

Parameters:

columnName - The name of the column

Returns:

The index of the column

getColumnName

public java.lang.String getColumnName(int index)

Get the name of a column at a particular index

Parameters:

index - The index of the column

Returns:

The name of the column

getColumnType

public MojoColumn.Type getColumnType(int index)

Get the type of a column at a particular index

Parameters:

index - The index of a column

Returns:

The type of the column

getColumnType

public MojoColumn.Type getColumnType(java.lang.String columnName)

Get the type of a column with the name columnName

Parameters:

columnName - The name of the column

Returns:

The type of the column

contains

public boolean contains(java.lang.String columnName)

Checks if there exists meta data for a column with a particular name

Parameters:

columnName - The name of the column

Returns:

true if the name exists in this instance, false otherwise

size

public int size()

Get the number of columns in this instance

Returns:

The number of columns in this instance

getColumnNamesMap

protected java.util.Map<java.lang.String,java.lang.Integer> getColumnNamesMap()

getColumnNames

public java.lang.String[] getColumnNames()

getColumnTypes

public MojoColumn.Type[] getColumnTypes()

getEmpty

public static MojoFrameMeta getEmpty()

Make a MojoFrameMeta instance with no columns

Returns:

A MojoFrameMeta instance with no columns