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.util.List<ai.h2o.mojos.runtime.api.MojoColumnMeta> columns)
MojoFrameMeta(java.util.List<ai.h2o.mojos.runtime.api.MojoColumnMeta> columns, java.util.Collection<java.lang.Integer> indices) With this constructor, the full set of columns is used but only some of them can be retrieved by name.
MojoFrameMeta(java.lang.String[] names, MojoColumn.Type[] types) Deprecated. use MojoFrameMeta(List), optionally with help of MojoColumnMeta.toColumns(String[], MojoColumn.Type[], MojoColumn.Kind) instead.

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
java.lang.String	debugIndicesToNames(int[] indices)
static java.lang.String	debugIndicesToNames(java.util.List<ai.h2o.mojos.runtime.api.MojoColumnMeta> columns, java.util.Collection<java.lang.Integer> indices)
static java.lang.String	debugIndicesToNames(java.util.List<ai.h2o.mojos.runtime.api.MojoColumnMeta> columns, int[] indices)
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() Deprecated. use getColumns() instead
protected java.util.Map<java.lang.String,java.lang.Integer>	getColumnNamesMap()
java.util.List<ai.h2o.mojos.runtime.api.MojoColumnMeta>	getColumns()
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() Deprecated. use getColumns() instead
static MojoFrameMeta	getEmpty() Make a MojoFrameMeta instance with no columns
java.lang.Integer	indexOf(ai.h2o.mojos.runtime.api.MojoColumnMeta column)
java.lang.Integer	indexOf(java.lang.String columnName) Deprecated. Lookup by name is dangerous, as names are not unique. Use indexOf(MojoColumnMeta) instead.
int[]	namesToIndices(java.lang.String[] exposedColumnNames)
int	size() Get the number of columns in this instance
MojoFrameMeta	subFrame(int[] indices)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MojoFrameMeta

@Deprecated
public MojoFrameMeta(java.lang.String[] names,
                                 MojoColumn.Type[] types)

Deprecated. use MojoFrameMeta(List), optionally with help of MojoColumnMeta.toColumns(String[], MojoColumn.Type[], MojoColumn.Kind) instead.

MojoFrameMeta

public MojoFrameMeta(java.util.List<ai.h2o.mojos.runtime.api.MojoColumnMeta> columns)

MojoFrameMeta

public MojoFrameMeta(java.util.List<ai.h2o.mojos.runtime.api.MojoColumnMeta> columns,
                     java.util.Collection<java.lang.Integer> indices)

With this constructor, the full set of columns is used but only some of them can be retrieved by name.

Parameters:

columns - -

indices - -

Method Detail

namesToIndices

public int[] namesToIndices(java.lang.String[] exposedColumnNames)

Parameters:

exposedColumnNames - column names to convert

Returns:

indices

subFrame

public MojoFrameMeta subFrame(int[] indices)

Returns:

frame containing only selected indices

getEmpty

public static MojoFrameMeta getEmpty()

Make a MojoFrameMeta instance with no columns

Returns:

A MojoFrameMeta instance with no columns

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

indexOf

@Deprecated
public java.lang.Integer indexOf(java.lang.String columnName)

Deprecated. Lookup by name is dangerous, as names are not unique. Use indexOf(MojoColumnMeta) instead.

indexOf

public java.lang.Integer indexOf(ai.h2o.mojos.runtime.api.MojoColumnMeta 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

@Deprecated
public java.lang.String[] getColumnNames()

Deprecated. use getColumns() instead

getColumnTypes

@Deprecated
public MojoColumn.Type[] getColumnTypes()

Deprecated. use getColumns() instead

getColumns

public java.util.List<ai.h2o.mojos.runtime.api.MojoColumnMeta> getColumns()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

debugIndicesToNames

public static java.lang.String debugIndicesToNames(java.util.List<ai.h2o.mojos.runtime.api.MojoColumnMeta> columns,
                                                   int[] indices)

debugIndicesToNames

public static java.lang.String debugIndicesToNames(java.util.List<ai.h2o.mojos.runtime.api.MojoColumnMeta> columns,
                                                   java.util.Collection<java.lang.Integer> indices)

debugIndicesToNames

public java.lang.String debugIndicesToNames(int[] indices)