com.simplifiedlogic.nitro.jshell.json.handler

Class JLJsonCommandHandler

java.lang.Object

com.simplifiedlogic.nitro.jshell.json.handler.JLJsonCommandHandler

Direct Known Subclasses:

JLJsonBomHandler, JLJsonConnectionHandler, JLJsonCreoHandler, JLJsonDimensionHandler, JLJsonDrawingHandler, JLJsonFamilyTableHandler, JLJsonFeatureHandler, JLJsonFileHandler, JLJsonGeometryHandler, JLJsonInterfaceHandler, JLJsonLayerHandler, JLJsonNoteHandler, JLJsonParameterHandler, JLJsonViewHandler, JLJsonWindchillHandler

public abstract class JLJsonCommandHandler
extends java.lang.Object

Parent class for any handler of JSON function calls for a family of functions.

Constructor Summary

Constructors

Constructor and Description
JLJsonCommandHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Double	checkDoubleParameter(java.util.Map<java.lang.String,java.lang.Object> input, java.lang.String parmname, boolean required) Get a double parameter value from input data.
boolean	checkFlagParameter(java.util.Map<java.lang.String,java.lang.Object> input, java.lang.String parmname, boolean required, boolean dfltVal) Get a boolean parameter value from input data.
java.lang.Integer	checkIntParameter(java.util.Map<java.lang.String,java.lang.Object> input, java.lang.String parmname, boolean required, java.lang.Integer dfltVal) Get an integer parameter value from input data.
java.util.Map<java.lang.String,java.lang.Object>	checkMapParameter(java.util.Map<java.lang.String,java.lang.Object> input, java.lang.String parmname, boolean required) Get a map parameter value from the input data; this represents a sub-object within the input object
java.lang.Object	checkParameter(java.util.Map<java.lang.String,java.lang.Object> input, java.lang.String parmname, boolean required) Get a parameter value from input data.
java.lang.String	checkStringParameter(java.util.Map<java.lang.String,java.lang.Object> input, java.lang.String parmname, boolean required) Get a String parameter value from input data.
java.util.List<java.lang.Integer>	getIntArray(java.lang.String paramName, java.lang.Object value) Convert an object to an integer array.
static java.util.List<java.lang.String>	getStringListValue(java.lang.Object str) Converts a generic object to a java.util.List<String>.
abstract java.util.Hashtable<java.lang.String,java.lang.Object>	handleFunction(java.lang.String sessionId, java.lang.String function, java.util.Hashtable<java.lang.String,java.lang.Object> input) Handle a server request for this family of functions.
boolean	isPattern(java.lang.String pattern) Check whether a string contains a pattern (wildcard) value.
protected JLPoint	readPoint(java.util.Map<java.lang.String,java.lang.Object> rec) Convert a generic JSON structure to a JLPoint object
protected JLTransform	readTransform(java.util.Map<java.lang.String,java.lang.Object> rec) Convert an input JSON structure into a JLTransform object
protected java.util.Hashtable<java.lang.String,java.lang.Object>	writeInertia(JLInertia xform) Convert a JLInertia object to a generic JSON structure
protected java.util.Hashtable<java.lang.String,java.lang.Object>	writePoint(JLPoint pt) Convert a JLPoint object to a generic JSON structure
protected java.util.Hashtable<java.lang.String,java.lang.Object>	writeTransform(JLTransform xform) Convert a JLTransform object to a generic JSON structure

Methods inherited from class java.lang.Object

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

Constructor Detail

JLJsonCommandHandler

public JLJsonCommandHandler()

Method Detail

handleFunction

public abstract java.util.Hashtable<java.lang.String,java.lang.Object> handleFunction(java.lang.String sessionId,
                                                                    java.lang.String function,
                                                                    java.util.Hashtable<java.lang.String,java.lang.Object> input)
                                                                               throws JLIException

Handle a server request for this family of functions.

Parameters:

sessionId - The current session id.

function - The name of the function to execute.

input - Input parameter data for the function, converted from JSON.

Returns:

Results of the function, to be converted to JSON.

Throws:

JLIException

checkParameter

public java.lang.Object checkParameter(java.util.Map<java.lang.String,java.lang.Object> input,
                              java.lang.String parmname,
                              boolean required)
                                throws JLIException

Get a parameter value from input data.

Parameters:

input - The input data to search.

parmname - Name of the parameter.

required - Whether the parameter is required; if true, the method will throw an exception if the parameter is missing.

Returns:

The value of the parameter, or null if the parameter was not found.

Throws:

JLIException

checkStringParameter

public java.lang.String checkStringParameter(java.util.Map<java.lang.String,java.lang.Object> input,
                                    java.lang.String parmname,
                                    boolean required)
                                      throws JLIException

Get a String parameter value from input data.

Parameters:

input - The input data to search.

parmname - Name of the parameter.

required - Whether the parameter is required; if true, the method will throw an exception if the parameter is missing.

Returns:

The value of the parameter converted to a string, or null if the parameter was not found.

Throws:

JLIException

checkFlagParameter

public boolean checkFlagParameter(java.util.Map<java.lang.String,java.lang.Object> input,
                         java.lang.String parmname,
                         boolean required,
                         boolean dfltVal)
                           throws JLIException

Get a boolean parameter value from input data.

Parameters:

input - The input data to search.

parmname - Name of the parameter.

required - Whether the parameter is required; if true, the method will throw an exception if the parameter is missing.

dfltVal - Default value for the parameter does not exist and is not required.

Returns:

The value of the parameter converted to a boolean value, or the default value if the parameter was not found.

Throws:

JLIException

checkIntParameter

public java.lang.Integer checkIntParameter(java.util.Map<java.lang.String,java.lang.Object> input,
                                  java.lang.String parmname,
                                  boolean required,
                                  java.lang.Integer dfltVal)
                                    throws JLIException

Get an integer parameter value from input data.

Parameters:

input - The input data to search.

parmname - Name of the parameter.

required - Whether the parameter is required; if true, the method will throw an exception if the parameter is missing.

dfltVal - Default value for the parameter does not exist and is not required.

Returns:

The value of the parameter converted to an integer, or the default value if the parameter was not found.

Throws:

JLIException

checkDoubleParameter

public java.lang.Double checkDoubleParameter(java.util.Map<java.lang.String,java.lang.Object> input,
                                    java.lang.String parmname,
                                    boolean required)
                                      throws JLIException

Get a double parameter value from input data.

Parameters:

input - The input data to search.

parmname - Name of the parameter.

required - Whether the parameter is required; if true, the method will throw an exception if the parameter is missing.

Returns:

The value of the parameter converted to a double, or null if the parameter was not found.

Throws:

JLIException

checkMapParameter

public java.util.Map<java.lang.String,java.lang.Object> checkMapParameter(java.util.Map<java.lang.String,java.lang.Object> input,
                                                                 java.lang.String parmname,
                                                                 boolean required)
                                                                   throws JLIException

Get a map parameter value from the input data; this represents a sub-object within the input object

Parameters:

input - The input data to search

parmname - Name of the parameter

required - Whether the parameter is required; if true, the method will throw an exception if the parameter is missing.

Returns:

The value of the parameter converted to a Map<String, Object>, or null if the parameter was not found.

Throws:

JLIException

getIntArray

public java.util.List<java.lang.Integer> getIntArray(java.lang.String paramName,
                                            java.lang.Object value)
                                              throws JLIException

Convert an object to an integer array.

If the value is a java.util.List, it tries to convert each entry in the list to an Integer and add it to the result. If any entry in the list is not and Integer object, an exception will be thrown.

If the value is a java.lang.String, it assumes the string is a list of numbers separated by spaces and converts each word to an Integer and adds it to the result. If any entry in the string cannot be converted to an Integer object, an exception will be thrown.

Parameters:

paramName - The name of the parameter - used only for error messages

value - The object value to convert

Returns:

The value as a list of Integers

Throws:

JLIException

getStringListValue

public static java.util.List<java.lang.String> getStringListValue(java.lang.Object str)

Converts a generic object to a java.util.List<String>. If the object is a List or an array, it converts each entry into a String and adds it to the result. Otherwise it just converts the object to a single-entry list.

Parameters:

str - The object to convert

Returns:

The value of the object as a string list

writePoint

protected java.util.Hashtable<java.lang.String,java.lang.Object> writePoint(JLPoint pt)

Convert a JLPoint object to a generic JSON structure

Parameters:

pt - The JLPoint object to write

Returns:

The JSON data as a Hashtable

readPoint

protected JLPoint readPoint(java.util.Map<java.lang.String,java.lang.Object> rec)
                     throws JLIException

Convert a generic JSON structure to a JLPoint object

Parameters:

rec - The JSON data as a Map

Returns:

The JLPoint object result

Throws:

JLIException

writeTransform

protected java.util.Hashtable<java.lang.String,java.lang.Object> writeTransform(JLTransform xform)

Convert a JLTransform object to a generic JSON structure

Parameters:

xform - The JLTransform object to write

Returns:

The JSON data as a Hashtable.

readTransform

protected JLTransform readTransform(java.util.Map<java.lang.String,java.lang.Object> rec)
                             throws JLIException

Convert an input JSON structure into a JLTransform object

Parameters:

rec - The JSON structure as a Map

Returns:

The JLTransform object

Throws:

JLIException

writeInertia

protected java.util.Hashtable<java.lang.String,java.lang.Object> writeInertia(JLInertia xform)

Convert a JLInertia object to a generic JSON structure

Parameters:

xform - The JLInertia object to write

Returns:

The JSON data as a Hashtable.

isPattern

public boolean isPattern(java.lang.String pattern)

Check whether a string contains a pattern (wildcard) value. This checks for the characters *, ?, | or [ in the string.

Parameters:

pattern - The pattern to check

Returns:

Whether the string contains a pattern