Navigation Set Management Primitives

You can use the following primitives to filter or remove objects from navigation sets.

Important: Add

var FilterServices = Java.type
        ("com.dassault_systemes.completion.service.FilterServices");

in the Header Section of your procedure.

This page discusses:

compact
merge
cutLeafOccurrences
insert
filterOnLeaves
cutOccurrences

compact

Filters a set of occurrences by removing occurrences already included in other ones

Input

inputNavSet: A Navigation Set that contains the occurrences to filter

Output

A Navigation Set that contains the filtered occurrences

Example

/*
 * Remove useless occurrences from a Navigation Set (occurrences included in some other ones from the Navigation Set
 * 
 * @param inputNavSet: input navigation to filter. Not modified by this method
 *
 * @return navigation set that contains the compacted occurrences 
 * @throws Exception
 */
public static NavigationSet compact (NavigationSet inputNavSet) throws java.lang.Exception

merge

Inserts a set of occurrences into another.

Input

input: The Navigation Set to be inserted in the one output from the previous primitive

Output

A Navigation Set that contains both Navigation Sets

Example

/* 
 * Merge Navigation with another Navigation Set 
 *
 * @param input:          navigation set to be merged with this one. Not modified by this method. It must have the same modeler as this one.
 * @return NavigationSet  new navigation set, containing data from both this one and the input
 */
public static NavigationSet merge (navigationSet input) throws Exception;

cutLeafOccurrences

Filters a set of occurrences by removing the final instances and references (leaves), with a configuration filter if necessary.

Input

ctx: A Completion Context that contains the configuration filter
inputNavSet: A Navigation Set that contains the occurrences to filter

Output

A Navigation Set that contains the filtered occurrences

Example

/**
 * This method "cuts" occurrences and removes the Leaf couple of instance/Reference.
 * 
 * @param ctx:         completion context to perform the filtering
 * @param InputNavSet: input navigation set to Cut. Not modified by this method.
 *
 * @return navigation set after the cut
 * @throws Exception in case of error
 */
NavigationSet cutLeafOccurrences (CompletionContext ctx , NavigationSet InputNavSet) throws Exception;

insert

Inserts a set of occurrences into another, using a filter criteria

Input

ctx: A Completion Context that contains the configuration filter
inputNavSet: The target Navigation Set of occurrences, that also contains filter criteria
iOccurrenceToBeInserted: The Navigation Set of occurrences to insert in the inputNavSet

Output

A Navigation Set that contains the inputNavSet and the iOccurrenceToBeInserted matching the filter criteria

Example

/**
 * Insert all the Occurrences of a Navigation set in another Navigation Set if the Occurrences are compatible with the filter criteria
 *
 * @param Ctx                      M1 context
 * @param iNavSet                  The Navigation Set (containing a filter) where the occurrence should be inserted
 * @param iOccurrenceToBeInserted  The occurrence that should be inserted in the Navigation Set
 *
 * @return NavigationSet           The original NavigationSet + the Occurrence that was added according to the filter criteria
 */
 public static NavigationSet insert (CompletionContext Ctx, NavigationSet iNavSet, NavigationSet iOccurrenceToBeInserted) throws Exception;

filterOnLeaves

Filters a set of occurrences by applying a WhereClause criteria to their final references (leaves), with a configuration filter if necessary.

Input

ctx: A Completion Context that contains the configuration filter
inputNavSet: A Navigation Set that contains the occurrences to filter
whereClause: The WhereClause to apply to the final references (leaves)
For more information, see WhereClause Examples.

Output

A Navigation Set that contains the filtered occurrences

Example

/*
 * Filter occurrences from a Navigation Set according to a WhereClause
 *
 * @param ctx:         completion context 
 * @param inputNavSet: input navigation to filter. Not modified by this method
 * @param whereClause  where clause to apply on leaves
 *
 * @return navigation set that contains the filtered occurrences 
 * @throws Exception
 */
public static NavigationSet filterOnLeaves (CompletionContext ctx, NavigationSet inputNavSet, java.lang.String whereClause) throws java.lang.Exception

cutOccurrences

Filters a set of occurrences by removing occurrences that do not match a WhereClause criteria applied to their references, with a configuration filter if necessary.

Input

ctx: A Completion Context that contains the configuration filter
inputNavSet: A Navigation Set that contains the occurrences to filter
whereClause: The WhereClause to apply to the references
For more information, see WhereClause Examples.

Output

A Navigation Set that contains the filtered occurrences
Note:
This output may contain:
- Occurrences included in other occurrences. To remove them, see the compact primitive.
- More occurrences than the input Navigation Set

Example

/*
 * Cut occurrences from a Navigation Set according to criteria applied on references (WhereClause)
 *
 * @param ctx:         completion context 
 * @param inputNavSet: input navigation to filter. Not modified by this method
 * @param whereClause  where clause to apply on references
 *
 * @return navigation set that contains the filtered occurrences 
 * @throws Exception
 */
public static NavigationSet cutOccurrences (CompletionContext ctx, NavigationSet inputNavSet, java.lang.String whereClause) throws java.lang.Exception

WhereClause Examples

The WhereClause examples concern only the filterOnLeaves and cutOccurrences primitives.

Removing Fasten Items

// To remove Fasten Mfg Items from PRCS navigation set
       var whereClause = "attribute[" + CompletionServicesConstants.BO_ATTRIBUTE_V_DISCIPLINE + "] != 'Fasten'";
       PRCS = FilterServices.cutOccurrences(context, PRCS, whereClause);

Retrieving and Expanding an Entity Named "LINE (MainBodyRespot)"

// To retrieve an entity named 'LINE (MainBodyRespot)' and expand it one level
       var SystExpand1lUpScope = ExpandPrimitives.expandSystem (context, SystScopeNS, 1);
       var whereClause0 = "attribute[PLMEntity.V_Name] == 'LINE (MainBodyRespot)'";
       var TMP0 = FilterServices.cutOccurrences (context, SEL_PROD_SYS, whereClause0);
       var SystExpand1lUpScope = ExpandPrimitives.expandSystem (context, TMP0, 1);

Keeping Only General Operations

// Keep only GeneralOperations from SystExpand1lUpScope Navigation Set and add them to PROD_SYS Navigation Set
       var whereClause1 = "type.kindof[DELLmiGeneralOperationReference] == TRUE";
       var TMP1 = FilterServices.cutOccurrences (context, SystExpand1lUpScope, whereClause1);
       PROD_SYS = PROD_SYS.merge (TMP1);

Removing All Predecessor Fastening Operations

// Remove all predecessor Fastening Operations from SelPrdcsorSysExpandAll Navigation Set and add the remaining operations to PROD_SYS Navigation Set
       var whereClause2 = "type.kindof[DELLmiPunctualOperationReference] == FALSE";
       var TMP2 = FilterServices.cutOccurrences (context, SelPrdcsorSysExpandAll, whereClause2);
       PROD_SYS = PROD_SYS.merge (TMP2);

Keeping Only EBOM Entities Modified in the Last Two Days

// Keep only product modified in the last 2 days
       var dateNow = new Date();
       var X=2
       var day = dateNow.getDate()-X;
       dateNow.setDate(day)
       day = dateNow.getDate()
       var month = dateNow.getMonth()+1;
       var year = dateNow.getFullYear();
       var date = "'" + month + "/" + day + "/" + year + "'";
       var whereClause = "modified >=" + date;
       var TMP = FilterServices.cutOccurrences (context, resExpandProduct, whereClause);

Keeping Only EBOM Entities Created After a Given Date

// Keep only Products created after a given date
       var date = '11/19/2020';
       var whereClause = "originated >=" + date;
       var TMP = FilterServices.cutOccurrences (context, resExpandProduct, whereClause);

Keeping Only EBOM Entities Modified Between Two Dates

// Keep only Products modified between 2 dates
       var whereClause = (modified >= '11/20/2020') AND (modified <= '11/30/2020');
       var TMP = FilterServices.cutOccurrences (context, resExpandProduct, whereClause);