Skip to content

Use @hierarchy annotation #601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
agoerler wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Use @hierarchy annotation #601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a88f385
snap 9.7.0-2026012316504290-SNAPSHOT
agoerler Jan 26, 2026
e299356
Use @hierarchy annotation
agoerler Jan 27, 2026
1571deb
Delete .npmrc
agoerler Jan 27, 2026
3edc983
genres write scenario
eugene-andreev Jan 29, 2026
9f2fa1b
Merge remote-tracking branch 'origin/main' into hierarchyAnnotaion
eugene-andreev Apr 16, 2026
ccd6d3f
update to 4.9.x
eugene-andreev Apr 16, 2026
4b213f9
bump up cds-services 4.9.0
eugene-andreev Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 3 additions & 15 deletions app/admin/fiori-service.cds
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ annotate AdminService.GenreHierarchy with {
ID @UI.Hidden;
};

annotate AdminService.GenreHierarchy with @Hierarchy.RecursiveHierarchyActions #GenreHierarchy: {
annotate AdminService.GenreHierarchy with @Hierarchy.RecursiveHierarchyActions #GenreHierarchyHierarchy: {
Copy link
Copy Markdown
Contributor Author

@agoerler agoerler Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should avoid the duplicate HierarchyHierarchy

$Type : 'Hierarchy.RecursiveHierarchyActionsType',
// any name can be the action name with namespace/no bound action name
ChangeNextSiblingAction: 'AdminService.moveSibling',
Expand All @@ -104,7 +104,7 @@ annotate AdminService.GenreHierarchy with @UI: {
PresentationVariant #VH: {
$Type : 'UI.PresentationVariantType',
Visualizations : ['@UI.LineItem'],
RecursiveHierarchyQualifier: 'GenreHierarchy'
RecursiveHierarchyQualifier: 'GenreHierarchyHierarchy'
Copy link
Copy Markdown
Contributor Author

@agoerler agoerler Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should avoid the duplicate HierarchyHierarchy

},
LineItem : [{
$Type: 'UI.DataField',
Expand Down Expand Up @@ -196,19 +196,7 @@ annotate AdminService.Books.texts {
//
// Annotations for hierarchy ContentsHierarchy
//
annotate AdminService.ContentsHierarchy with @Aggregation.RecursiveHierarchy#ContentsHierarchy: {
$Type: 'Aggregation.RecursiveHierarchyType',
NodeProperty: ID, // identifies a node
ParentNavigationProperty: parent // navigates to a node's parent
};

annotate AdminService.ContentsHierarchy with @Hierarchy.RecursiveHierarchy#ContentsHierarchy: {
$Type: 'Hierarchy.RecursiveHierarchyType',
LimitedDescendantCount: LimitedDescendantCount,
DistanceFromRoot: DistanceFromRoot,
DrillState: DrillState,
LimitedRank: LimitedRank
};
annotate AdminService.ContentsHierarchy with @hierarchy;

annotate AdminService.Books actions {
@(
Expand Down
2 changes: 1 addition & 1 deletion app/admin/webapp/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
"controlConfiguration": {
"contents/@com.sap.vocabularies.UI.v1.LineItem": {
"tableSettings": {
"hierarchyQualifier": "ContentsHierarchy",
"hierarchyQualifier": "ContentsHierarchyHierarchy",
"type": "TreeTable"
}
}
Expand Down
13 changes: 1 addition & 12 deletions app/browse-genres/fiori-service.cds
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,5 @@
using CatalogService from '../../srv/cat-service';


annotate CatalogService.GenreHierarchy with @Aggregation.RecursiveHierarchy#GenreHierarchy: {
$Type: 'Aggregation.RecursiveHierarchyType',
NodeProperty: ID, // identifies a node
ParentNavigationProperty: parent // navigates to a node's parent
};
annotate CatalogService.GenreHierarchy with @hierarchy;

annotate CatalogService.GenreHierarchy with @Hierarchy.RecursiveHierarchy#GenreHierarchy: {
$Type: 'Hierarchy.RecursiveHierarchyType',
LimitedDescendantCount: LimitedDescendantCount,
DistanceFromRoot: DistanceFromRoot,
DrillState: DrillState,
LimitedRank: LimitedRank
};
2 changes: 1 addition & 1 deletion app/browse-genres/webapp/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
"controlConfiguration": {
"@com.sap.vocabularies.UI.v1.LineItem": {
"tableSettings": {
"hierarchyQualifier": "GenreHierarchy",
"hierarchyQualifier": "GenreHierarchyHierarchy",
"type": "TreeTable"
}
}
Expand Down
15 changes: 1 addition & 14 deletions app/genres/fiori-service.cds
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,4 @@
using AdminService from '../../srv/admin-service';


annotate AdminService.GenreHierarchy with @Aggregation.RecursiveHierarchy#GenreHierarchy: {
$Type: 'Aggregation.RecursiveHierarchyType',
NodeProperty: ID, // identifies a node
ParentNavigationProperty: parent // navigates to a node's parent
};

annotate AdminService.GenreHierarchy with @Hierarchy.RecursiveHierarchy#GenreHierarchy: {
$Type: 'Hierarchy.RecursiveHierarchyType',
// ExternalKey : null,
LimitedDescendantCount: LimitedDescendantCount,
DistanceFromRoot: DistanceFromRoot,
DrillState: DrillState,
LimitedRank: LimitedRank
};
annotate AdminService.GenreHierarchy with @hierarchy;
2 changes: 1 addition & 1 deletion app/genres/webapp/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
"controlConfiguration": {
"@com.sap.vocabularies.UI.v1.LineItem": {
"tableSettings": {
"hierarchyQualifier": "GenreHierarchy",
"hierarchyQualifier": "GenreHierarchyHierarchy",
Copy link
Copy Markdown
Contributor Author

@agoerler agoerler Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should avoid the duplicate HierarchyHierarchy

"type": "TreeTable"
}
}
Expand Down
5 changes: 2 additions & 3 deletions db/books.cds
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ namespace my.bookshop;
using {Currency, sap, managed, cuid} from '@sap/cds/common';
using my.bookshop.Reviews from './reviews';
using my.bookshop.TechnicalBooleanFlag from './common';
using {my.common.Hierarchy as Hierarchy} from './hierarchy';

@fiori.draft.enabled
entity Books : cuid, managed {
Expand Down Expand Up @@ -46,7 +45,7 @@ annotate Authors with
/**
* Hierarchically organized Code List for Genres
*/
entity Genres : sap.common.CodeList, Hierarchy {
entity Genres : sap.common.CodeList {
key ID : UUID;
// move siblings
siblingRank : Integer;
Expand All @@ -59,7 +58,7 @@ entity Genres : sap.common.CodeList, Hierarchy {
/**
* Hierarchically organized entity for Contents
*/
entity Contents: Hierarchy {
entity Contents {
key ID : UUID;
name : String;
page : Integer;
Expand Down
23 changes: 0 additions & 23 deletions db/hierarchy.cds
View file
Open in desktop

This file was deleted.

27 changes: 20 additions & 7 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

<!-- DEPENDENCIES VERSION -->
<jdk.version>21</jdk.version>
<cds.services.version>4.8.0</cds.services.version>
<cds.services.version>4.9.0</cds.services.version>
<cloud.sdk.version>5.27.0</cloud.sdk.version>
<xsuaa.version>3.6.9</xsuaa.version>
<cf-java-logging-support.version>4.1.1</cf-java-logging-support.version>
Expand Down
16 changes: 8 additions & 8 deletions srv/src/test/java/my/bookshop/GenreHierarchyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ void startOneLevel() throws Exception {
genresURI
+ "?$select=DrillState,ID,name,DistanceFromRoot"
+ "&$apply=orderby(name)/"
+ "com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchy',NodeProperty='ID',Levels=1)"
+ "com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchyHierarchy',NodeProperty='ID',Levels=1)"
+ "&$count=true"))
.andExpect(status().isOk())
.andExpect(jsonPath("$.value[0].ID").value("8bbf14c6-b378-4e35-9b4f-05a9c8878001"))
Expand All @@ -68,7 +68,7 @@ void startTwoLevels() throws Exception {
genresURI
+ "?$select=DrillState,ID,name,DistanceFromRoot"
+ "&$apply=orderby(name)/"
+ "com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchy',NodeProperty='ID',Levels=2)"
+ "com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchyHierarchy',NodeProperty='ID',Levels=2)"
+ "&$count=true"))
.andExpect(status().isOk())
.andExpect(jsonPath("$.value[0].name").value("Fiction"))
Expand Down Expand Up @@ -107,7 +107,7 @@ void collapseAll() throws Exception {
get(
genresURI
+ "?$select=DrillState,ID,name"
+ "&$apply=orderby(name)/com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchy',NodeProperty='ID',Levels=1)"
+ "&$apply=orderby(name)/com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchyHierarchy',NodeProperty='ID',Levels=1)"
+ "&$count=true&$skip=0&$top=238"))
.andExpect(status().isOk())
.andExpect(jsonPath("$.value[0].name").value("Fiction"))
Expand All @@ -123,7 +123,7 @@ void expandAllTop100() throws Exception {
String url =
genresURI
+ "?$select=DistanceFromRoot,DrillState,ID,LimitedDescendantCount,name"
+ "&$apply=orderby(name)/com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchy',NodeProperty='ID')"
+ "&$apply=orderby(name)/com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchyHierarchy',NodeProperty='ID')"
+ "&$count=true&$skip=0&$top=100";

client
Expand All @@ -147,7 +147,7 @@ void search() throws Exception {
+ "?$select=DistanceFromRoot,DrillState,ID,LimitedDescendantCount,name"
+ "&$apply=ancestors($root/GenreHierarchy,GenreHierarchy,ID,search(\"true\"),keep start)"
+ "/orderby(name)"
+ "/com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchy',NodeProperty='ID')"
+ "/com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchyHierarchy',NodeProperty='ID')"
+ "&$count=true"))
.andExpect(status().isOk())
.andExpect(jsonPath("$.value[0].name").value("Fiction"))
Expand Down Expand Up @@ -177,7 +177,7 @@ void filterNotExpanded() throws Exception {
genresURI
+ "?$select=DrillState,ID,name,DistanceFromRoot"
+ "&$apply=ancestors($root/GenreHierarchy,GenreHierarchy,ID,filter(name eq 'Autobiography'),keep start)/orderby(name)"
+ "/com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchy',NodeProperty='ID',Levels=1)"))
+ "/com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchyHierarchy',NodeProperty='ID',Levels=1)"))
.andExpect(status().isOk())
.andExpect(jsonPath("$.value[0].name").value("Non-Fiction"))
.andExpect(jsonPath("$.value[0].DrillState").value("collapsed"))
Expand All @@ -196,7 +196,7 @@ void filterExpandLevels() throws Exception {
genresURI
+ "?$select=DistanceFromRoot,DrillState,ID,LimitedDescendantCount,name"
+ "&$apply=ancestors($root/GenreHierarchy,GenreHierarchy,ID,filter(name eq 'Autobiography'),keep start)/orderby(name)"
+ "/com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchy',NodeProperty='ID',Levels=1,ExpandLevels="
+ "/com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchyHierarchy',NodeProperty='ID',Levels=1,ExpandLevels="
+ expandLevelsJson
+ ")&$count=true";
String uriString = UriComponentsBuilder.fromUriString(unencoded).toUriString();
Expand All @@ -219,7 +219,7 @@ void startTwoLevelsOrderByDesc() throws Exception {
genresURI
+ "?$select=DrillState,ID,name,DistanceFromRoot"
+ "&$apply=orderby(name desc)/"
+ "com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchy',NodeProperty='ID',Levels=2)"
+ "com.sap.vocabularies.Hierarchy.v1.TopLevels(HierarchyNodes=$root/GenreHierarchy,HierarchyQualifier='GenreHierarchyHierarchy',NodeProperty='ID',Levels=2)"
+ "&$count=true"))
.andExpect(status().isOk())
.andExpect(jsonPath("$.value[0].name").value("Non-Fiction"))
Expand Down
Loading