water.api
Class TutorialWorkflow

java.lang.Object
  water.Iced
      water.api.Constants
          water.api.RequestStatics
              water.api.RequestArguments
                  water.api.RequestQueries
                      water.api.RequestBuilders
                          water.api.Request
                              water.api.HTMLOnlyRequest
                                  water.api.TutorialWorkflow

All Implemented Interfaces:

java.lang.Cloneable, Freezable

Direct Known Subclasses:

TutorialGLMProstate, TutorialKMeans, TutorialRFIris

public abstract class TutorialWorkflow
extends HTMLOnlyRequest

Basic page introducing tutorial for Random Forest on Iris

Nested Class Summary

protected class	TutorialWorkflow.FileTutorStep Tutorial step stored in file
protected class	TutorialWorkflow.TutorStep Simple tutorial step defined by its title, summary, and content.
protected class	TutorialWorkflow.TutorWorkflow A simple tutorial workflow representation

Nested classes/interfaces inherited from class water.api.Request

Request.API, Request.Default, Request.Filter

Nested classes/interfaces inherited from class water.api.RequestBuilders

RequestBuilders.ArrayBuilder, RequestBuilders.ArrayHeaderRowBuilder, RequestBuilders.ArrayRowBuilder, RequestBuilders.ArrayRowElementBuilder, RequestBuilders.ArrayRowSingleColBuilder, RequestBuilders.BooleanStringBuilder, RequestBuilders.Builder, RequestBuilders.ElementBuilder, RequestBuilders.HideBuilder, RequestBuilders.KeyCellBuilder, RequestBuilders.KeyElementBuilder, RequestBuilders.KeyLinkElementBuilder, RequestBuilders.KeyMinAvgMaxBuilder, RequestBuilders.NoCaptionObjectBuilder, RequestBuilders.ObjectBuilder, RequestBuilders.PaginatedTable, RequestBuilders.PreFormattedBuilder, RequestBuilders.Response, RequestBuilders.ResponseInfo, RequestBuilders.WarningCellBuilder

Nested classes/interfaces inherited from class water.api.RequestArguments

RequestArguments.Argument<T>, RequestArguments.Bool, RequestArguments.CaseModeSelect, RequestArguments.CaseSelect, RequestArguments.ClassifyBool, RequestArguments.EnumArgument<T extends java.lang.Enum<T>>, RequestArguments.ExistingFile, RequestArguments.FrameClassVec, RequestArguments.FrameKeyMultiVec, RequestArguments.FrameKeyVec, RequestArguments.GeneralFile, RequestArguments.H2OCategoryStrata, RequestArguments.H2OCategoryWeights, RequestArguments.H2OExistingKey, RequestArguments.H2OGLMModelKey, RequestArguments.H2OHexKey, RequestArguments.H2OHexKeyCol, RequestArguments.H2OKey, RequestArguments.H2OKey2, RequestArguments.H2OKMeansModelKey, RequestArguments.H2OModelKey<TM extends OldModel,TK extends TypeaheadKeysRequest>, RequestArguments.HexAllColumnSelect, RequestArguments.HexColumnSelect, RequestArguments.HexKeyClassCol, RequestArguments.HexNonClassColumnSelect, RequestArguments.HexNonConstantColumnSelect, RequestArguments.HexPCAColumnSelect, RequestArguments.InputCheckBox, RequestArguments.InputSelect<T>, RequestArguments.InputText<T>, RequestArguments.Int, RequestArguments.LongInt, RequestArguments.MultipleSelect<T>, RequestArguments.MultipleText<T>, RequestArguments.NTree, RequestArguments.NumberSequence, RequestArguments.Real, RequestArguments.Record<T>, RequestArguments.RFModelKey, RequestArguments.RSeq, RequestArguments.Str, RequestArguments.StringList, RequestArguments.TypeaheadInputText<T>

Nested classes/interfaces inherited from class water.api.RequestStatics

RequestStatics.RequestType

Nested classes/interfaces inherited from class water.api.Constants

Constants.Extensions, Constants.Schemes, Constants.Suffixes

Field Summary

protected RequestArguments.Int

_step

Fields inherited from class water.api.Request

_requestHelp, SUPPORTS_ONLY_V1, SUPPORTS_ONLY_V2, SUPPORTS_V1_V2

Fields inherited from class water.api.RequestBuilders

ARRAY_BUILDER, ARRAY_HEADER_ROW_BUILDER, ARRAY_ROW_BUILDER, ARRAY_ROW_ELEMENT_BUILDER, ARRAY_ROW_SINGLECOL_BUILDER, ELEMENT_BUILDER, GSON_BUILDER, OBJECT_BUILDER, ROOT_OBJECT

Fields inherited from class water.api.RequestQueries

_queryHtml

Fields inherited from class water.api.RequestArguments

_arguments

Fields inherited from class water.api.Constants

ALPHA, ARGUMENTS, AUC, BASE, BEST_THRESHOLD, BETA_EPS, BIN_LIMIT, BROWSE, BUCKET, BUILT_IN_KEY_JOBS, CANCELLED, CASE, CASE_MODE, CHUNK, CLASS, CLOUD_NAME, CLOUD_SIZE, CLUSTERS, COEFFICIENTS, COLS, COLUMNS_DISPLAY, CONSENSUS, CONTENTS, COUNT, DATA_KEY, DEPTH, DESCRIPTION, DEST_KEY, DTHRESHOLDS, END_TIME, ENUM_DOMAIN_SIZE, ERROR, ESCAPE_NAN, EXCLUSIVE_SPLIT_LIMIT, EXPRESSION, FAILED, FAMILY, FEATURES, FILE, FILES, FILTER, FIRST_CHUNK, FJ_QUEUE_HI, FJ_QUEUE_LO, FJ_THREADS_HI, FJ_THREADS_LO, FREE_DISK, FREE_MEM, HEADER, HEIGHT, HELP, IGNORE, ITEMS, ITERATIVE_CM, JOB, JOB_KEY, JOBS, JSON_H2O, KEY, KEYS, LAMBDA, LAST_CONTACT, LIMIT, LINK, LOCKED, MAX, MAX_DISK, MAX_ITER, MAX_MEM, MAX_ROWS, MEAN, MIN, MODEL_KEY, MODELS, MORE, MTRY, MTRY_NODES, NAME, NEG_X, NO_CM, NODE, NODE_NAME, NODES, NORMALIZE, NUM_COLS, NUM_CPUS, NUM_FAILED, NUM_KEYS, NUM_MISSING_VALUES, NUM_ROWS, NUM_SUCCEEDED, NUM_TREES, OBJECT, OFFSET, OOBEE, PARALLEL, PARSER_TYPE, PATH, PREVIEW, PREVIOUS_MODEL_KEY, PROGRESS, PROGRESS_KEY, PROGRESS_TOTAL, REDIRECT, REDIRECT_ARGS, REPLICATION_FACTOR, REQUEST_TIME, RESPONSE, RHO, ROW, ROW_SIZE, ROWS, RPCS, SAMPLE, SAMPLING_STRATEGY, SCALE, SEED, SENT_ROWS, SEPARATOR, SIZE, SOURCE_KEY, STACK_TRACES, START_TIME, STAT_TYPE, STATUS, STEP, STRATA_SAMPLES, SUCCEEDED, SYSTEM_LOAD, TASK_KEY, TCPS_ACTIVE, TCPS_DUTY, TIME, TOT_MEM, TREE_COUNT, TREE_DEPTH, TREE_LEAVES, TREE_NUM, TREES, TWEEDIE_POWER, TYPE, URL, USE_NON_LOCAL_DATA, VALUE, VALUE_SIZE, VALUE_TYPE, VARIANCE, VERSION, VIEW, WARNINGS, WEIGHT, WEIGHTS, WIDTH, X, XVAL, Y

Constructor Summary

TutorialWorkflow()

Method Summary

protected java.lang.String	build(RequestBuilders.Response response) Builds the HTML for the given response.
protected void	decorateActiveStep(TutorialWorkflow.TutorStep step, java.lang.StringBuilder sb) Shows the active workflow step
protected void	decorateWorkflow(TutorialWorkflow.TutorWorkflow twf, java.lang.StringBuilder sb, int activeStepNum)
protected abstract TutorialWorkflow.TutorWorkflow	getWorkflow() Returns a workflow to show

Methods inherited from class water.api.HTMLOnlyRequest

serve, serve

Methods inherited from class water.api.Request

addToNavbar, addToNavbar, create, DocExampleFail, DocExampleSucc, href, href, hrefType, HTMLHelp, htmlTemplate, initializeNavBar, initializeNavBar, log, mapTypeahead, registered, ReSTHelp, serveGrid, supportedVersions, toDocGET, toHTML, wrap, wrap, wrap, writeJSONFields

Methods inherited from class water.api.RequestBuilders

buildJSONResponseBox, buildResponseHeader, name

Methods inherited from class water.api.RequestQueries

buildQuery, checkArguments, queryArgumentValueSet

Methods inherited from class water.api.RequestArguments

arguments, argumentsToJson, frameColumnNameToIndex, vaCategoryNames, vaCategoryNames, vaColumnNameToIndex

Methods inherited from class water.api.RequestStatics

checkJsonName, encodeRedirectArgs, JSON2HTML, jsonError, requestName, Str2JSON

Methods inherited from class water.Iced

clone, frozenType, init, newInstance, read, toDocField, write, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

_step

protected final RequestArguments.Int _step

Constructor Detail

TutorialWorkflow

public TutorialWorkflow()

Method Detail

getWorkflow

protected abstract TutorialWorkflow.TutorWorkflow getWorkflow()

Returns a workflow to show

build

protected java.lang.String build(RequestBuilders.Response response)

Description copied from class: RequestBuilders

Builds the HTML for the given response. This is the root of the HTML. Should display all what is needed, including the status, timing, etc. Then call the recursive builders for the response's JSON.

Overrides:

build in class RequestBuilders

decorateActiveStep

protected void decorateActiveStep(TutorialWorkflow.TutorStep step,
                                  java.lang.StringBuilder sb)

Shows the active workflow step

decorateWorkflow

protected void decorateWorkflow(TutorialWorkflow.TutorWorkflow twf,
                                java.lang.StringBuilder sb,
                                int activeStepNum)