Page History

descendants is optional query parameter with default value of "all". possible values of descendants is as below :

1.  all : to get all descendants 
2.  none: don't include descendants
3.  number : positive number 0 to n, to query nodes till nth descendant 

1. we need to support different version for this query API for backward compatibility 

descendants is optional query parameter with default value of "all". possible values of descendants is as below :

1.  all : to get all descendants 
2.  none: don't include descendants
3.  number : positive number 0 to n, to query nodes till nth descendant 

1. we need to support different version for this query API for backward compatibility 

/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
  $ref: 'cpsDataV2.yml#/nodeByDataspaceAndAnchor'

/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
  $ref: 'cpsQueryV2.yml#/nodesByDataspaceAndAnchorAndCpsPath'

nodesByDataspaceAndAnchorAndCpsPath:
  get:
    description: Query data nodes for the given dataspace and anchor using CPS path
    tags:
      - cps-query
    summary: Query data nodes
    operationId: getNodesByDataspaceAndAnchorAndCpsPathV2
    parameters:
      - $ref: 'components.yml#/components/parameters/dataspaceNameInPath'
      - $ref: 'components.yml#/components/parameters/anchorNameInPath'
      - $ref: 'components.yml#/components/parameters/cpsPathInQuery'
      - $ref: 'components.yml#/components/parameters/depthInQuerydescendantsInQuery'
...

depthInQuerydescendantsInQuery:
  name: depthdescendants
  in: query
  description: depthdescendants parameter for large query outputs to limit descendants. use "all", "none" or number
  required: false
  schema:
    type: string
    default: all
    example: 1

FetchDescendantsOption.java

We Need to change this class to accept for any other depth values except -1, 0 and 1.  

Do we need to change FetchDescendantsOption to support multiple depths or add depth as separate argument along

with FetchDescendantsOption

3
    pattern: <use pattern to validate accepted values for descendants>
Notes : return error descendants value if less then -1 and invalid string values.

DataRestController.java

@Override
public ResponseEntity<Object> getNodeByDataspaceAndAnchorV2(final String dataspaceName, final String anchorName,
    final String xpath, final String descendants) {
    final FetchDescendantsOption fetchDescendantsOption = getFetchDescendantOption(descendants);
    final DataNode dataNode = cpsDataService.getDataNode(dataspaceName, anchorName, xpath

FragmentRepository.java

@Query(value = "SELECT id, anchor_id AS anchorId, xpath, parent_id AS parentId,"
    + " CAST(attributes AS TEXT) AS attributes"
    + " FROM FRAGMENT WHERE anchor_id = :anchorId"
    + " AND ( xpath = :parentXpath OR xpath LIKE CONCAT(:parentXpath,'/%') )",
       nativeQuery = true)
List<FragmentExtract> findByAnchorIdAndParentXpath(@Param("anchorId") int anchorId,
        fetchDescendantsOption);
    final String prefix = prefixResolver.getPrefix(dataspaceName, anchorName, xpath);
    return new ResponseEntity<>(DataMapUtils.toDataMapWithIdentifier(dataNode, prefix), HttpStatus.OK);
}

private FetchDescendantsOption getFetchDescendantOption(final String descendants) {
    if (null == descendants || descendants.trim().isEmpty()
             @Param("parentXpath") String parentXpath, 
|| "-1".equals(descendants) || "all".equals(descendants)) {
        return FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS;
    } else if ("0".equals(descendants) || "none".equals(descendants)) {
        return FetchDescendantsOption.OMIT_DESCENDANTS;
    } else {
        final Integer depth = Integer.valueOf(descendants);
        return new @ParamFetchDescendantsOption("depth");
 Integer depth);   }
}

QueryRestController.java

@Override
public ResponseEntity<Object> getNodesByDataspaceAndAnchorAndCpsPathV2(final String dataspaceName,

FragmentEntityArranger.java

private static FragmentEntity reuniteChildrenWithTheirParents(final Map<Long, 
    final String anchorName, final String cpsPath, final String descendants) {
    final FetchDescendantsOption fetchDescendantsOption = getFetchDescendantOption(descendants);
    final Collection<DataNode> dataNodes =
        FragmentEntity> fragmentEntityPerIdcpsQueryService.queryDataNodes(dataspaceName, anchorName, IntegercpsPath, depthfetchDescendantsOption) {;
    final Collection<FragmentEntity> fragmentEntitiesWithoutParentInResultSetList<Map<String, Object>> dataMaps = new HashSet<>ArrayList<>(dataNodes.size());
    forString (finalprefix FragmentEntity fragmentEntity : fragmentEntityPerId.values()) {= null;
    for    (final FragmentEntityDataNode parentFragmentEntitydataNode = fragmentEntityPerId.get(fragmentEntity.getParentId());: dataNodes) {
        if (parentFragmentEntityprefix == null) {
            fragmentEntitiesWithoutParentInResultSet.add(fragmentEntityprefix = prefixResolver.getPrefix(dataspaceName, anchorName, dataNode.getXpath());
        } else
 {
       final Map<String, Object> dataMap = parentFragmentEntityDataMapUtils.getChildFragments().add(fragmentEntitytoDataMapWithIdentifier(dataNode, prefix);
        }dataMaps.add(dataMap);
    }
    return fragmentEntitiesWithoutParentInResultSet.stream().findFirst().orElse(nullnew ResponseEntity<>(jsonObjectMapper.asJsonString(dataMaps), HttpStatus.OK);
}