Expand Primitives

You can use the expand primitives to expand nodes of an object structure.

Note: Only leaf node of each occurrence or branch in the Navigation Set is expanded.

Important: To use the following primitives, add var ExpandPrimitives = Java.type ("com.dassault_systemes.completion.service.ExpandPrimitives"); in the Header Section of your procedure.

This page discusses:

See Also
User-Defined Open and User-Defined Explore Procedures
Expand Primitives from 3D Index
Navigation Primitives
Advanced Primitives
Navigation Set Management Primitives

expandEBOM

Expands each Product occurrence in a Navigation Set at the specified level, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • prdInput: A Navigation Set that contains the Product occurrences
  • iDepth: An integer that defines the expansion depth, that is, the number of levels to expand
    Note: If set to 0, all levels are expanded.

Output

  • A Navigation Set that contains the expanded Product occurrences

Example

/**
 * Expands a Product navigation set at a specific level
 * 
 * @param ctx      completion context
 * @param prdInput navigation set that contains the Products occurrences to expand
 * @param iDepth   integer that defines the depth of the expand
 *                 Note: If the depth is set to zero, it expands all
 *
 * @return new navigation set that contains the expanded input
 * @throws Exception
 */
public static NavigationSet expandEBOM (CompletionContext ctx, NavigationSet prdInput, int iDepth) throws Exception;

expandMBOM

Expands each MBOM occurrence in a Navigation Set at the specified level, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • MBOMInput: A Navigation Set that contains the MBOM occurrences
  • iDepth: An integer that defines the expansion depth, that is, the number of levels to expand
    Note: If set to 0, all levels are expanded.

Output

  • A Navigation Set that contains the expanded MBOM occurrences

Example

/**
 * Expands a MBOM navigation set at a specific level
 * 
 * @param ctx       completion context
 * @param MBOMInput navigation set that contains the MBOM occurrences to expand
 * @param iDepth    integer that defines the depth of the expand
 *                  Note: If the depth is set to zero, it expands all
 *
 * @return new navigation set that contains the expanded input occurrences
 * @throws Exception
 */
public static NavigationSet expandMBOM (CompletionContext ctx, NavigationSet MBOMInput, int iDepth) throws Exception;

expandSystem

Expands each Workplan or System occurrence in a Navigation Set at the specified level, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • systInput: A Navigation Set that contains the Workplan or System occurrences
  • iDepth: An integer that defines the expansion depth, that is, the number of levels to expand
    Note: If set to 0, all levels are expanded.

Output

  • A Navigation Set that contains the expanded Workplan or System occurrences

Example

/**
 * Expands a Work plan or System navigation set at a specific level
 *
 * @param ctx       completion context
 * @param systInput navigation set that contains the Work plan or System occurrences to expand
 * @param iDepth    integer that defines the depth of the expand
 *                  Note: If the depth is set to zero, it expands all
 *
 * @return new navigation set that contains the expanded input
 * @throws Exception
 */
public static NavigationSet expandSystem (CompletionContext ctx, NavigationSet systInput, int iDepth) throws Exception;

expandResource

Expands each Resource occurrence in a Navigation Set at the specified level, with a configuration filter if necessary.

Input

  • ctx: A Completion Context that contains the configuration filter
  • resInput: A Navigation Set that contains the Resource occurrences
  • iDepth: An integer that defines the expansion depth, that is, the number of levels to expand
    Note: If set to 0, all levels are expanded.

Output

  • A Navigation Set that contains the expanded Resource occurrences

Example

/**
 * Expands a Resource navigation set at a specific level
 *
 * @param ctx      completion context
 * @param resInput navigation set that contains the Resource occurrences to expand
 * @param iDepth   integer that defines the depth of the expand
 *                 Note: If the depth is set to zero, it expands all
 *
 * @return new navigation set that contains the expanded input
 * @throws Exception
 */
public static NavigationSet expandResource (CompletionContext ctx, NavigationSet resInput, int iDepth) throws Exception;

expandMultiRoot

Expands each occurrence in a Navigation Set at the specified level, with a configuration filter if necessary.

Notes:
  • There can be multiple root entities defined in this Navigation Set.
  • After using this primitive, no navigation must be performed from the resulting Navigation Set. This primitive must be the final step of a procedure before it returns the lists of entities to be opened.

Input

  • ctx: A Completion Context that contains the configuration filter
  • navSetInput : A Navigation Set that contains the Resource occurrences
  • iDepth: An integer that defines the expansion depth, that is, the number of levels to expand
    Note: If set to 0, all levels are expanded.

Output

  • A Navigation Set that contains the expanded occurrences

Example

/**
 * Expands a Resource navigation set at a specific level
 *
 * @param ctx         completion context
 * @param navSetInput navigation set that contains the occurrences to expand
 * @param iDepth      integer that defines the depth of the expand
 *                    Note: If the depth is set to zero, it expands all
 *
 * @return new navigation set that contains the expanded input
 * @throws Exception
 */
public static NavigationSet expandMultiRoot (CompletionContext ctx, NavigationSet navSetInput, int iDepth) throws Exception;

keepRoot

From a Navigation Set of any supported type, this primitive removes all the occurrences contained in this Navigation Set except the root entity.

Input

  • InputNavSet: A Navigation Set that contains the occurrences from which you want to extract and keep only the root entity.
    Note: Note: If the Navigation Set contains more than one root entity (as it may be the case for Resource Navigation Sets), then the resulting Navigation Set will contain only one of those root entities. As the order of occurrences is not guaranteed in a Navigation Set, the returned root entity can be any of those defined in the input Navigation Set.
    Note: Note: If the navigation set contains more than one root entity (as may be the case for resource navigation sets), the resulting navigation set will contain only one of those root entities. Since the order of occurrences is not guaranteed in a navigation set, the returned root entity may be any of those defined in the input navigation set.

Output

  • A Navigation Set that contains only the root entity collapsed and retrived fom Navigation Set

Example

/**
* From a Navigation Set of any supported type, this primitive removes all the occurrences contained in this Navigation Set except the root entity
* 
* @param InputNavSet navigation set that contains the occurrences from which user wants to extract and keep only the root entity
*                 Note: If the navigation set contains more than 1 root entity (this can be the case for Resources Navigation Sets for instance), resulting Navigation Set will contain only one of these root entities. 
*                 As order of occurrences is not guaranteed in a Navigation Set, the root entity returned can be any of those defined in input Navigation Set. 
*
* @return new navigation set that contains only the root entity from the input Navigation Set
* @throws Exception
*/
public static NavigationSet keepRoot (NavigationSet InputNavSet) throws Exception;