water.api.schemas3

Class InteractionV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<Interaction,InteractionV3>

water.api.schemas3.InteractionV3

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

public class InteractionV3
extends SchemaV3<Interaction,InteractionV3>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class water.api.schemas3.SchemaV3

SchemaV3.Meta

Field Summary

Fields

Modifier and Type	Field and Description
KeyV3.FrameKeyV3	dest
java.lang.String[]	factor_columns
int	max_factors
int	min_occurrence
static java.lang.String[]	own_fields
boolean	pairwise
KeyV3.FrameKeyV3	source_frame

Fields inherited from class water.api.schemas3.SchemaV3

__meta, _exclude_fields

Constructor Summary

Constructors

Constructor and Description
InteractionV3()

Method Summary

Methods

Modifier and Type	Method and Description
Interaction	createImpl() Create an appropriate implementation object and any child objects but does not fill them.

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, extractVersionFromSchemaName, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillImpl, fillImpl, getImplClass, getImplClass, getSchemaName, getSchemaType, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, setField, setSchemaType_doNotCall

Methods inherited from class water.Iced

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

Methods inherited from class java.lang.Object

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

Field Detail

own_fields

public static java.lang.String[] own_fields

dest

@API(help="destination key",
     direction=INOUT)
public KeyV3.FrameKeyV3 dest

source_frame

@API(help="Input data frame",
     direction=INOUT)
public KeyV3.FrameKeyV3 source_frame

factor_columns

@API(help="Factor columns",
     is_member_of_frames="source_frame",
     direction=INOUT)
public java.lang.String[] factor_columns

pairwise

@API(help="Whether to create pairwise quadratic interactions between factors (otherwise create one higher-order interaction). Only applicable if there are 3 or more factors.",
     required=false,
     direction=INOUT)
public boolean pairwise

max_factors

@API(help="Max. number of factor levels in pair-wise interaction terms (if enforced, one extra catch-all factor will be made)",
     required=true,
     direction=INOUT)
public int max_factors

min_occurrence

@API(help="Min. occurrence threshold for factor levels in pair-wise interaction terms",
     direction=INOUT)
public int min_occurrence

Constructor Detail

InteractionV3

public InteractionV3()

Method Detail

createImpl

public Interaction createImpl()

Description copied from class: Schema

Create an appropriate implementation object and any child objects but does not fill them. The standard purpose of a createImpl without a fillImpl is to be able to get the default values for all the impl's fields.

For objects without children this method does all the required work. For objects with children the subclass will need to override, e.g. by calling super.createImpl() and then calling createImpl() on its children.

Note that impl objects for schemas which override this method don't need to have a default constructor (e.g., a Keyed object constructor can still create and set the Key), but they must not fill any fields which can be filled later from the schema.

TODO: We could handle the common case of children with the same field names here by finding all of our fields that are themselves Schemas.

Overrides:

createImpl in class Schema<Interaction,InteractionV3>