com.simplifiedlogic.nitro.jlink.impl

Class JLFeature

java.lang.Object

com.simplifiedlogic.nitro.jlink.impl.JLFeature

All Implemented Interfaces:

IJLFeature

public class JLFeature
extends java.lang.Object
implements IJLFeature

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JLFeature.SetLooper An implementation of FeatureLooper to set a parameter value on a feature.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FEATURE_LIMIT Maximum number of characters in a feature name

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

ENCODED_NO, ENCODED_YES, GETPATHS_NO, GETPATHS_YES, INCLUDEUNNAMED_NO, INCLUDEUNNAMED_YES, NOCOMPFEAT_NO, NOCOMPFEAT_YES, NODATUMFEAT_NO, NODATUMFEAT_YES, NONAME_FEATURE, STATUS_ACTIVE, STATUS_FAMILY_TABLE_SUPPRESSED, STATUS_INACTIVE, STATUS_PROGRAM_SUPPRESSED, STATUS_SIMP_REP_SUPPRESSED, STATUS_SUPPRESSED, STATUS_UNREGENERATED

Constructor Summary

Constructors

Constructor and Description
JLFeature()

Method Summary

Methods

Modifier and Type	Method and Description
void	addUDF(java.lang.String filename, java.lang.String udfFile, java.lang.String csysName, java.lang.String csysPrompt, java.util.Map<java.lang.String,java.lang.Number> dimensions, java.util.Map<java.lang.String,java.lang.Object> parameters, AbstractJLISession sess)
void	addUDF(java.lang.String filename, java.lang.String udfFile, java.lang.String csysName, java.lang.String csysPrompt, java.util.Map<java.lang.String,java.lang.Number> dimensions, java.util.Map<java.lang.String,java.lang.Object> parameters, java.lang.String sessionId)
void	delete(java.lang.String filename, java.lang.String featureName, java.util.List<java.lang.String> featureNames, java.lang.String featureStatus, java.lang.String featureType, boolean clip, AbstractJLISession sess)
void	delete(java.lang.String filename, java.lang.String featureName, java.util.List<java.lang.String> featureNames, java.lang.String featureStatus, java.lang.String featureType, boolean clip, java.lang.String sessionId)
void	deleteParam(java.lang.String filename, java.lang.String featName, java.lang.String paramName, AbstractJLISession sess)
void	deleteParam(java.lang.String filename, java.lang.String featName, java.lang.String paramName, java.lang.String sessionId)
void	doDelete(AbstractJLISession jliSession, CallSolid solid, java.util.List<CallFeature> features, boolean clip) Perform the delete operations.
void	doResume(AbstractJLISession jliSession, CallSolid solid, java.util.List<CallFeature> features) Perform the resume operations.
void	doSuppress(AbstractJLISession jliSession, CallSolid solid, java.util.List<CallFeature> features, boolean clip) Perform the suppress operations.
java.util.List<FeatureData>	list(java.lang.String filename, java.lang.String featureName, java.lang.String featureStatus, java.lang.String featureType, boolean paths, boolean noDatumFeatures, boolean includeUnnamed, boolean noComponentFeatures, AbstractJLISession sess)
java.util.List<FeatureData>	list(java.lang.String filename, java.lang.String featureName, java.lang.String featureStatus, java.lang.String featureType, boolean paths, boolean noDatumFeatures, boolean includeUnnamed, boolean noComponentFeatures, java.lang.String sessionId)
java.util.List<FeatureData>	listGroupFeatures(java.lang.String filename, java.lang.String groupName, java.lang.String featureType, AbstractJLISession sess)
java.util.List<FeatureData>	listGroupFeatures(java.lang.String filename, java.lang.String groupName, java.lang.String featureType, java.lang.String sessionId)
java.util.List<ParameterData>	listParams(java.lang.String filename, java.lang.String featName, int featId, java.lang.String paramName, java.util.List<java.lang.String> paramNames, java.lang.String typePattern, java.lang.String valuePattern, boolean encoded, boolean noDatumFeatures, boolean includeUnnamed, boolean noComponentFeatures, AbstractJLISession sess)
java.util.List<ParameterData>	listParams(java.lang.String filename, java.lang.String featName, int featId, java.lang.String paramName, java.util.List<java.lang.String> paramNames, java.lang.String typePattern, java.lang.String valuePattern, boolean encoded, boolean noDatumFeatures, boolean includeUnnamed, boolean noComponentFeatures, java.lang.String sessionId)
java.util.List<FeatureData>	listPatternFeatures(java.lang.String filename, java.lang.String patternName, java.lang.String featureType, AbstractJLISession sess)
java.util.List<FeatureData>	listPatternFeatures(java.lang.String filename, java.lang.String patternName, java.lang.String featureType, java.lang.String sessionId)
java.util.List<FeatSelectData>	listSelected(boolean paths, AbstractJLISession sess)
java.util.List<FeatSelectData>	listSelected(boolean paths, java.lang.String sessionId)
boolean	paramExists(java.lang.String filename, java.lang.String featName, java.lang.String paramName, java.util.List<java.lang.String> paramNames, AbstractJLISession sess)
boolean	paramExists(java.lang.String filename, java.lang.String featName, java.lang.String paramName, java.util.List<java.lang.String> paramNames, java.lang.String sessionId)
void	rename(java.lang.String filename, java.lang.String featureName, int featureId, java.lang.String newName, AbstractJLISession sess)
void	rename(java.lang.String filename, java.lang.String featureName, int featureId, java.lang.String newName, java.lang.String sessionId)
void	resume(java.lang.String filename, java.lang.String featureName, java.util.List<java.lang.String> featureNames, int featureId, java.lang.String featureStatus, java.lang.String featureType, boolean withChildren, AbstractJLISession sess)
void	resume(java.lang.String filename, java.lang.String featureName, java.util.List<java.lang.String> featureNames, int featureId, java.lang.String featureStatus, java.lang.String featureType, boolean withChildren, java.lang.String sessionId)
void	setParam(java.lang.String filename, java.lang.String featName, 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	setParam(java.lang.String filename, java.lang.String featName, 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	suppress(java.lang.String filename, java.lang.String featureName, java.util.List<java.lang.String> featureNames, int featureId, java.lang.String featureStatus, java.lang.String featureType, boolean clip, boolean withChildren, AbstractJLISession sess)
void	suppress(java.lang.String filename, java.lang.String featureName, java.util.List<java.lang.String> featureNames, int featureId, java.lang.String featureStatus, java.lang.String featureType, boolean clip, boolean withChildren, java.lang.String sessionId)
java.util.List<FeatSelectData>	userSelectCsys(java.lang.String modelname, int max, AbstractJLISession sess)
java.util.List<FeatSelectData>	userSelectCsys(java.lang.String modelname, int max, java.lang.String sessionId)
protected static java.lang.String	validateFeatureName(java.lang.String feat) Check whether a feature name is valid.

Methods inherited from class java.lang.Object

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

Field Detail

FEATURE_LIMIT

public static final int FEATURE_LIMIT

Maximum number of characters in a feature name

See Also:

Constant Field Values

Constructor Detail

JLFeature

public JLFeature()

Method Detail

delete

public void delete(java.lang.String filename,
          java.lang.String featureName,
          java.util.List<java.lang.String> featureNames,
          java.lang.String featureStatus,
          java.lang.String featureType,
          boolean clip,
          java.lang.String sessionId)
            throws JLIException

Specified by:

delete in interface IJLFeature

Throws:

JLIException

delete

public void delete(java.lang.String filename,
          java.lang.String featureName,
          java.util.List<java.lang.String> featureNames,
          java.lang.String featureStatus,
          java.lang.String featureType,
          boolean clip,
          AbstractJLISession sess)
            throws JLIException

Specified by:

delete in interface IJLFeature

Throws:

JLIException

list

public java.util.List<FeatureData> list(java.lang.String filename,
                               java.lang.String featureName,
                               java.lang.String featureStatus,
                               java.lang.String featureType,
                               boolean paths,
                               boolean noDatumFeatures,
                               boolean includeUnnamed,
                               boolean noComponentFeatures,
                               java.lang.String sessionId)
                                 throws JLIException

Specified by:

list in interface IJLFeature

Throws:

JLIException

list

public java.util.List<FeatureData> list(java.lang.String filename,
                               java.lang.String featureName,
                               java.lang.String featureStatus,
                               java.lang.String featureType,
                               boolean paths,
                               boolean noDatumFeatures,
                               boolean includeUnnamed,
                               boolean noComponentFeatures,
                               AbstractJLISession sess)
                                 throws JLIException

Specified by:

list in interface IJLFeature

Throws:

JLIException

listPatternFeatures

public java.util.List<FeatureData> listPatternFeatures(java.lang.String filename,
                                              java.lang.String patternName,
                                              java.lang.String featureType,
                                              java.lang.String sessionId)
                                                throws JLIException

Specified by:

listPatternFeatures in interface IJLFeature

Throws:

JLIException

listPatternFeatures

public java.util.List<FeatureData> listPatternFeatures(java.lang.String filename,
                                              java.lang.String patternName,
                                              java.lang.String featureType,
                                              AbstractJLISession sess)
                                                throws JLIException

Specified by:

listPatternFeatures in interface IJLFeature

Throws:

JLIException

listGroupFeatures

public java.util.List<FeatureData> listGroupFeatures(java.lang.String filename,
                                            java.lang.String groupName,
                                            java.lang.String featureType,
                                            java.lang.String sessionId)
                                              throws JLIException

Specified by:

listGroupFeatures in interface IJLFeature

Throws:

JLIException

listGroupFeatures

public java.util.List<FeatureData> listGroupFeatures(java.lang.String filename,
                                            java.lang.String groupName,
                                            java.lang.String featureType,
                                            AbstractJLISession sess)
                                              throws JLIException

Specified by:

listGroupFeatures in interface IJLFeature

Throws:

JLIException

listSelected

public java.util.List<FeatSelectData> listSelected(boolean paths,
                                          java.lang.String sessionId)
                                            throws JLIException

Specified by:

listSelected in interface IJLFeature

Throws:

JLIException

listSelected

public java.util.List<FeatSelectData> listSelected(boolean paths,
                                          AbstractJLISession sess)
                                            throws JLIException

Specified by:

listSelected in interface IJLFeature

Throws:

JLIException

rename

public void rename(java.lang.String filename,
          java.lang.String featureName,
          int featureId,
          java.lang.String newName,
          java.lang.String sessionId)
            throws JLIException

Specified by:

rename in interface IJLFeature

Throws:

JLIException

rename

public void rename(java.lang.String filename,
          java.lang.String featureName,
          int featureId,
          java.lang.String newName,
          AbstractJLISession sess)
            throws JLIException

Specified by:

rename in interface IJLFeature

Throws:

JLIException

resume

public void resume(java.lang.String filename,
          java.lang.String featureName,
          java.util.List<java.lang.String> featureNames,
          int featureId,
          java.lang.String featureStatus,
          java.lang.String featureType,
          boolean withChildren,
          java.lang.String sessionId)
            throws JLIException

Specified by:

resume in interface IJLFeature

Throws:

JLIException

resume

public void resume(java.lang.String filename,
          java.lang.String featureName,
          java.util.List<java.lang.String> featureNames,
          int featureId,
          java.lang.String featureStatus,
          java.lang.String featureType,
          boolean withChildren,
          AbstractJLISession sess)
            throws JLIException

Specified by:

resume in interface IJLFeature

Throws:

JLIException

suppress

public void suppress(java.lang.String filename,
            java.lang.String featureName,
            java.util.List<java.lang.String> featureNames,
            int featureId,
            java.lang.String featureStatus,
            java.lang.String featureType,
            boolean clip,
            boolean withChildren,
            java.lang.String sessionId)
              throws JLIException

Specified by:

suppress in interface IJLFeature

Throws:

JLIException

suppress

public void suppress(java.lang.String filename,
            java.lang.String featureName,
            java.util.List<java.lang.String> featureNames,
            int featureId,
            java.lang.String featureStatus,
            java.lang.String featureType,
            boolean clip,
            boolean withChildren,
            AbstractJLISession sess)
              throws JLIException

Specified by:

suppress in interface IJLFeature

Throws:

JLIException

userSelectCsys

public java.util.List<FeatSelectData> userSelectCsys(java.lang.String modelname,
                                            int max,
                                            java.lang.String sessionId)
                                              throws JLIException

Specified by:

userSelectCsys in interface IJLFeature

Throws:

JLIException

userSelectCsys

public java.util.List<FeatSelectData> userSelectCsys(java.lang.String modelname,
                                            int max,
                                            AbstractJLISession sess)
                                              throws JLIException

Specified by:

userSelectCsys in interface IJLFeature

Throws:

JLIException

deleteParam

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

Specified by:

deleteParam in interface IJLFeature

Throws:

JLIException

deleteParam

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

Specified by:

deleteParam in interface IJLFeature

Throws:

JLIException

paramExists

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

Specified by:

paramExists in interface IJLFeature

Throws:

JLIException

paramExists

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

Specified by:

paramExists in interface IJLFeature

Throws:

JLIException

listParams

public java.util.List<ParameterData> listParams(java.lang.String filename,
                                       java.lang.String featName,
                                       int featId,
                                       java.lang.String paramName,
                                       java.util.List<java.lang.String> paramNames,
                                       java.lang.String typePattern,
                                       java.lang.String valuePattern,
                                       boolean encoded,
                                       boolean noDatumFeatures,
                                       boolean includeUnnamed,
                                       boolean noComponentFeatures,
                                       java.lang.String sessionId)
                                         throws JLIException

Specified by:

listParams in interface IJLFeature

Throws:

JLIException

listParams

public java.util.List<ParameterData> listParams(java.lang.String filename,
                                       java.lang.String featName,
                                       int featId,
                                       java.lang.String paramName,
                                       java.util.List<java.lang.String> paramNames,
                                       java.lang.String typePattern,
                                       java.lang.String valuePattern,
                                       boolean encoded,
                                       boolean noDatumFeatures,
                                       boolean includeUnnamed,
                                       boolean noComponentFeatures,
                                       AbstractJLISession sess)
                                         throws JLIException

Specified by:

listParams in interface IJLFeature

Throws:

JLIException

setParam

public void setParam(java.lang.String filename,
            java.lang.String featName,
            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:

setParam in interface IJLFeature

Throws:

JLIException

setParam

public void setParam(java.lang.String filename,
            java.lang.String featName,
            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:

setParam in interface IJLFeature

Throws:

JLIException

addUDF

public void addUDF(java.lang.String filename,
          java.lang.String udfFile,
          java.lang.String csysName,
          java.lang.String csysPrompt,
          java.util.Map<java.lang.String,java.lang.Number> dimensions,
          java.util.Map<java.lang.String,java.lang.Object> parameters,
          java.lang.String sessionId)
            throws JLIException

Specified by:

addUDF in interface IJLFeature

Throws:

JLIException

addUDF

public void addUDF(java.lang.String filename,
          java.lang.String udfFile,
          java.lang.String csysName,
          java.lang.String csysPrompt,
          java.util.Map<java.lang.String,java.lang.Number> dimensions,
          java.util.Map<java.lang.String,java.lang.Object> parameters,
          AbstractJLISession sess)
            throws JLIException

Specified by:

addUDF in interface IJLFeature

Throws:

JLIException

validateFeatureName

protected static java.lang.String validateFeatureName(java.lang.String feat)
                                               throws JLIException

Check whether a feature name is valid. Checks for length and invalid characters. Returns a reformatted feature name.

Parameters:

feat - The feature name

Returns:

The reformatted name

Throws:

JLIException

doDelete

public void doDelete(AbstractJLISession jliSession,
            CallSolid solid,
            java.util.List<CallFeature> features,
            boolean clip)
              throws JLIException,
                     com.ptc.cipjava.jxthrowable

Perform the delete operations. Meant to be overridden by child classes.

Parameters:

jliSession - The JShell session

solid - The Solid that owns the features

features - The features to delete

clip - Whether to clip children

Throws:

JLIException

com.ptc.cipjava.jxthrowable

doResume

public void doResume(AbstractJLISession jliSession,
            CallSolid solid,
            java.util.List<CallFeature> features)
              throws JLIException,
                     com.ptc.cipjava.jxthrowable

Perform the resume operations. Meant to be overridden by child classes.

Parameters:

jliSession - The JShell session

solid - The Solid that owns the features

features - The features to resume

Throws:

JLIException

com.ptc.cipjava.jxthrowable

doSuppress

public void doSuppress(AbstractJLISession jliSession,
              CallSolid solid,
              java.util.List<CallFeature> features,
              boolean clip)
                throws JLIException,
                       com.ptc.cipjava.jxthrowable

Perform the suppress operations. Meant to be overridden by child classes.

Parameters:

jliSession - The JShell session

solid - The Solid that owns the features

features - The features to suppress

clip - Whether to clip children

Throws:

JLIException

com.ptc.cipjava.jxthrowable