com.simplifiedlogic.nitro.jlink.impl

Class JLParameter

java.lang.Object

com.simplifiedlogic.nitro.jlink.impl.JLParameter

All Implemented Interfaces:

IJLParameter

public class JLParameter
extends java.lang.Object
implements IJLParameter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JLParameter.BasicListLooper An implementation of ParamLooper which just collects parameter objects for a model
class	JLParameter.CopyLooper An implementation of ModelLooper which copies one or more parameters to a list of models
class	JLParameter.DeleteLooper An implementation of ModelLooper which deletes parameters from a list of models.
class	JLParameter.DeleteLooper2 An implementation of ParamLooper which deletes matching parameters on a model
class	JLParameter.ExistsLooper An implementation of ParamLooper which checks whether a parameter exists
class	JLParameter.ListLooper An implementation of ModelLooper which collects information about parameters on a list of models.
class	JLParameter.SetBatchLooper An implementation of ModelLooper which sets a list of parameters on a list of models
class	JLParameter.SetDesignateLooper An implementation of ModelLooper which sets a parameter's designated state on a list of models
class	JLParameter.SetDesignateLooper2 An implementation of ParamLooper which sets designate state of matching parameters on a model
class	JLParameter.SetLooper An implementation of ModelLooper which sets one parameter on a list of models

Field Summary

Fields

Modifier and Type	Field and Description
static int	PARAMETER_LIMIT Maximum length of a parameter name
static int	VALUE_LIMIT Maximum length of a parameter value

Fields inherited from interface com.simplifiedlogic.nitro.jlink.intf.IJLParameter

DESIGNATE_OFF, DESIGNATE_ON, DESIGNATE_UNKNOWN, ENCODED_NO, ENCODED_YES, NOCREATE_NO, NOCREATE_YES, TYPE_BOOL, TYPE_DOUBLE, TYPE_INTEGER, TYPE_NOTE, TYPE_STRING

Constructor Summary

Constructors

Constructor and Description
JLParameter()

Method Summary

Methods

Modifier and Type	Method and Description
void	copy(java.lang.String filename, java.lang.String paramName, java.lang.String toModel, java.lang.String toName, int designate, AbstractJLISession sess)
void	copy(java.lang.String filename, java.lang.String paramName, java.lang.String toModel, java.lang.String toName, int designate, java.lang.String sessionId)
void	copyOneParam(CallParameter param, CallModel m, java.lang.String toName, int designate) Copy a single parameter to a parameter in another model or to another parameter in the same model
void	delete(java.lang.String filename, java.lang.String paramName, AbstractJLISession sess)
void	delete(java.lang.String filename, java.lang.String paramName, java.lang.String sessionId)
boolean	exists(java.lang.String filename, java.lang.String paramName, java.util.List<java.lang.String> paramNames, AbstractJLISession sess)
boolean	exists(java.lang.String filename, java.lang.String paramName, java.util.List<java.lang.String> paramNames, java.lang.String sessionId)
java.util.List<ParameterData>	list(java.lang.String filename, java.lang.String paramName, java.util.List<java.lang.String> paramNames, java.lang.String valuePattern, boolean encoded, AbstractJLISession sess)
java.util.List<ParameterData>	list(java.lang.String filename, java.lang.String paramName, java.util.List<java.lang.String> paramNames, java.lang.String valuePattern, boolean encoded, java.lang.String sessionId)
void	set(java.lang.String filename, java.lang.String paramName, java.lang.Object value, java.lang.String type, int designate, boolean encoded, boolean noCreate, java.lang.String description, AbstractJLISession sess)
void	set(java.lang.String filename, java.lang.String paramName, java.lang.Object value, java.lang.String type, int designate, boolean encoded, boolean noCreate, java.lang.String description, java.lang.String sessionId)
void	setBatch(ParameterCollData batch, boolean encoded, boolean noCreate, AbstractJLISession sess)
void	setBatch(ParameterCollData batch, boolean encoded, boolean noCreate, java.lang.String sessionId)
void	setDesignated(java.lang.String filename, java.lang.String paramName, boolean designate, AbstractJLISession sess)
void	setDesignated(java.lang.String filename, java.lang.String paramName, boolean designate, java.lang.String sessionId)
static void	setOneParameter(CallModel model, CallParameterOwner owner, java.lang.String paramName, java.lang.Object value, java.lang.String type, int designate, java.lang.String description, boolean noCreate, boolean encoded) Set or create a single parameter on a model or feature
protected static java.lang.String	validateParameter(java.lang.String param, java.lang.Object value, boolean encoded) Validate a parameter name and value; checks that The name is less than PARAMETER_LIMIT in length The name does not contain any invalid characters The value is less than VALUE_LIMIT in length It will also reformat the parameter name (convert it to upper case)

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_LIMIT

public static final int VALUE_LIMIT

Maximum length of a parameter value

See Also:

Constant Field Values

PARAMETER_LIMIT

public static final int PARAMETER_LIMIT

Maximum length of a parameter name

See Also:

Constant Field Values

Constructor Detail

JLParameter

public JLParameter()

Method Detail

set

public void set(java.lang.String filename,
       java.lang.String paramName,
       java.lang.Object value,
       java.lang.String type,
       int designate,
       boolean encoded,
       boolean noCreate,
       java.lang.String description,
       java.lang.String sessionId)
         throws JLIException

Specified by:

set in interface IJLParameter

Throws:

JLIException

set

public void set(java.lang.String filename,
       java.lang.String paramName,
       java.lang.Object value,
       java.lang.String type,
       int designate,
       boolean encoded,
       boolean noCreate,
       java.lang.String description,
       AbstractJLISession sess)
         throws JLIException

Specified by:

set in interface IJLParameter

Throws:

JLIException

setBatch

public void setBatch(ParameterCollData batch,
            boolean encoded,
            boolean noCreate,
            java.lang.String sessionId)
              throws JLIException

Specified by:

setBatch in interface IJLParameter

Throws:

JLIException

setBatch

public void setBatch(ParameterCollData batch,
            boolean encoded,
            boolean noCreate,
            AbstractJLISession sess)
              throws JLIException

Specified by:

setBatch in interface IJLParameter

Throws:

JLIException

setDesignated

public void setDesignated(java.lang.String filename,
                 java.lang.String paramName,
                 boolean designate,
                 java.lang.String sessionId)
                   throws JLIException

Specified by:

setDesignated in interface IJLParameter

Throws:

JLIException

setDesignated

public void setDesignated(java.lang.String filename,
                 java.lang.String paramName,
                 boolean designate,
                 AbstractJLISession sess)
                   throws JLIException

Specified by:

setDesignated in interface IJLParameter

Throws:

JLIException

delete

public void delete(java.lang.String filename,
          java.lang.String paramName,
          java.lang.String sessionId)
            throws JLIException

Specified by:

delete in interface IJLParameter

Throws:

JLIException

delete

public void delete(java.lang.String filename,
          java.lang.String paramName,
          AbstractJLISession sess)
            throws JLIException

Specified by:

delete in interface IJLParameter

Throws:

JLIException

copy

public void copy(java.lang.String filename,
        java.lang.String paramName,
        java.lang.String toModel,
        java.lang.String toName,
        int designate,
        java.lang.String sessionId)
          throws JLIException

Specified by:

copy in interface IJLParameter

Throws:

JLIException

copy

public void copy(java.lang.String filename,
        java.lang.String paramName,
        java.lang.String toModel,
        java.lang.String toName,
        int designate,
        AbstractJLISession sess)
          throws JLIException

Specified by:

copy in interface IJLParameter

Throws:

JLIException

list

public java.util.List<ParameterData> list(java.lang.String filename,
                                 java.lang.String paramName,
                                 java.util.List<java.lang.String> paramNames,
                                 java.lang.String valuePattern,
                                 boolean encoded,
                                 java.lang.String sessionId)
                                   throws JLIException

Specified by:

list in interface IJLParameter

Throws:

JLIException

list

public java.util.List<ParameterData> list(java.lang.String filename,
                                 java.lang.String paramName,
                                 java.util.List<java.lang.String> paramNames,
                                 java.lang.String valuePattern,
                                 boolean encoded,
                                 AbstractJLISession sess)
                                   throws JLIException

Specified by:

list in interface IJLParameter

Throws:

JLIException

exists

public boolean exists(java.lang.String filename,
             java.lang.String paramName,
             java.util.List<java.lang.String> paramNames,
             java.lang.String sessionId)
               throws JLIException

Specified by:

exists in interface IJLParameter

Throws:

JLIException

exists

public boolean exists(java.lang.String filename,
             java.lang.String paramName,
             java.util.List<java.lang.String> paramNames,
             AbstractJLISession sess)
               throws JLIException

Specified by:

exists in interface IJLParameter

Throws:

JLIException

validateParameter

protected static java.lang.String validateParameter(java.lang.String param,
                                 java.lang.Object value,
                                 boolean encoded)
                                             throws JLIException

Validate a parameter name and value; checks that

• The name is less than PARAMETER_LIMIT in length
• The name does not contain any invalid characters
• The value is less than VALUE_LIMIT in length

It will also reformat the parameter name (convert it to upper case)

Parameters:

param - The parameter name to check

value - The parameter value to check (optional)

encoded - Whether the parameter value is Base64-encoded

Returns:

The reformatted parameter name

Throws:

JLIException

copyOneParam

public void copyOneParam(CallParameter param,
                CallModel m,
                java.lang.String toName,
                int designate)
                  throws JLIException,
                         com.ptc.cipjava.jxthrowable

Copy a single parameter to a parameter in another model or to another parameter in the same model

Parameters:

param - The parameter object to copy

m - The model containing the target parameter

toName - The name of the target parameter

designate - Whether the target parameter should be designated/not designated/not changed. Valid values are DESIGNATE_ON, DESIGNATE_OFF, and DESIGNATE_UNKNOWN.

Throws:

JLIException

com.ptc.cipjava.jxthrowable

setOneParameter

public static void setOneParameter(CallModel model,
                   CallParameterOwner owner,
                   java.lang.String paramName,
                   java.lang.Object value,
                   java.lang.String type,
                   int designate,
                   java.lang.String description,
                   boolean noCreate,
                   boolean encoded)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

Set or create a single parameter on a model or feature

Parameters:

model - The model which contains the parameter (even if it's a feature parameter)

owner - The owner of the parameter. If this is a model parameter, then this will be the same as the "model" argument. If it's a feature parameter, this will be the feature.

paramName - The parameter name

value - The new parameter value

type - The parameter data type

designate - Whether the parameter should be designated/not designated/not changed. Valid values are DESIGNATE_ON, DESIGNATE_OFF, and DESIGNATE_UNKNOWN.

description - The parameter description. If null, then the current description is left alone.

noCreate - Whether to NOT create the parameter if it does not exist

encoded - Whether the parameter value is Base64-encoded

Throws:

JLIException

com.ptc.cipjava.jxthrowable