com.simplifiedlogic.nitro.jshell.json.help

Class JLJsonFamilyTableHelp

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.help.JLJsonCommandHelp

com.simplifiedlogic.nitro.jshell.json.help.JLJsonFamilyTableHelp

All Implemented Interfaces:

JLFamilyTableRequestParams, JLFamilyTableResponseParams

public class JLJsonFamilyTableHelp
extends JLJsonCommandHelp
implements JLFamilyTableRequestParams, JLFamilyTableResponseParams

Generate help doc for "familytable" functions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OBJ_FAM_TABLE_INSTANCE
static java.lang.String	OBJ_FAM_TABLE_ROW_COLUMN

Fields inherited from interface com.simplifiedlogic.nitro.jshell.json.request.JLFamilyTableRequestParams

COMMAND, FUNC_ADD_INST, FUNC_CREATE_INST, FUNC_DELETE, FUNC_DELETE_INST, FUNC_EXISTS, FUNC_GET_CELL, FUNC_GET_HEADER, FUNC_GET_PARENTS, FUNC_GET_ROW, FUNC_LIST, FUNC_LIST_TREE, FUNC_REPLACE, FUNC_SET_CELL, PARAM_COLID, PARAM_CURINST, PARAM_CURMODEL, PARAM_ERASE, PARAM_INSTANCE, PARAM_MODEL, PARAM_NEWINST, PARAM_PATH, PARAM_VALUE

Fields inherited from interface com.simplifiedlogic.nitro.jshell.json.response.JLFamilyTableResponseParams

OUTPUT_CHILDREN, OUTPUT_COLID, OUTPUT_COLTYPE, OUTPUT_COLUMNS, OUTPUT_DATATYPE, OUTPUT_EXISTS, OUTPUT_INSTANCE, OUTPUT_INSTANCES, OUTPUT_NAME, OUTPUT_PARENTS, OUTPUT_TOTAL, OUTPUT_VALUE

Constructor Summary

Constructors

Constructor and Description
JLJsonFamilyTableHelp()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCommand() Get the command for this family of functions
java.util.List<FunctionTemplate>	getHelp() Get a list of function templates for this family of functions.
java.util.List<FunctionObject>	getHelpObjects() Get a list of data objects used in function templates for this family of functions.

Methods inherited from class com.simplifiedlogic.nitro.jshell.json.help.JLJsonCommandHelp

makeInertia, makePoint, makeTransform, makeTransform

Methods inherited from class java.lang.Object

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

Field Detail

OBJ_FAM_TABLE_INSTANCE

public static final java.lang.String OBJ_FAM_TABLE_INSTANCE

See Also:

Constant Field Values

OBJ_FAM_TABLE_ROW_COLUMN

public static final java.lang.String OBJ_FAM_TABLE_ROW_COLUMN

See Also:

Constant Field Values

Constructor Detail

JLJsonFamilyTableHelp

public JLJsonFamilyTableHelp()

Method Detail

getCommand

public java.lang.String getCommand()

Description copied from class: JLJsonCommandHelp

Get the command for this family of functions

Specified by:

getCommand in class JLJsonCommandHelp

Returns:

The command (function family) name

getHelp

public java.util.List<FunctionTemplate> getHelp()

Description copied from class: JLJsonCommandHelp

Get a list of function templates for this family of functions.

Specified by:

getHelp in class JLJsonCommandHelp

Returns:

A list of function templates

getHelpObjects

public java.util.List<FunctionObject> getHelpObjects()

Description copied from class: JLJsonCommandHelp

Get a list of data objects used in function templates for this family of functions.

Specified by:

getHelpObjects in class JLJsonCommandHelp

Returns:

A list of data objects