feat: adds sortable schema property [DHIS2-18749] #19612
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
|
||
| /** Object sharing (JSONB). */ | ||
| protected Sharing sharing = new Sharing(); | ||
| @Setter protected Sharing sharing = new Sharing(); |
Check notice
Code scanning / CodeQL
Missing Override annotation Note
| @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0) | ||
| public boolean isSortable() { | ||
| Sortable sortable = getterMethod == null ? null : getterMethod.getAnnotation(Sortable.class); | ||
| return sortable != null ? sortable.value() : !isCollection() && isSimple(); |
There was a problem hiding this comment.
I think we need to check if the property is persisted , meaning it is mapped to a database column.
For example: a class may not have the property shortName but it is still inherit the property from base class.
There was a problem hiding this comment.
Good point, but I will have to find a way to not exclude a computed property like displayName that way since it isn't persisted but still possible to sort by.
There was a problem hiding this comment.
I use persisted now where the default is that it has to be persisted. To make properties like displayName still be sortable they must be annotated with @Sortable(whenPersisted=false). This is not perfect but covers most of the cases.
Added a test now |
|
Summary
Adds a
sortableproperty to schemaPropertythat indicates if a property can be used in theorderparameter.By default only simple non-collections properties are sortable. Exceptions can be made by annotating the property getter with
@Sortable(true)or@Sortable(false).As far as I could tell we do not have any actual validation for the
orderparameter apart from simply ignoring collections and non-simple properties should they be present. Therefore that logic was used as the fall-back if no@Sortableannotation is present.Cleanup
IDE supported refactoring to
@Setterand some@Getterinstead of explicitly stating the methodfinalManual changes
access = READ_ONLYfor jacksonManual Testing
check for example
/api/schemas/dataElementand look at thepropertiesarrayProperties now have a
sortableattribute, for examplenamelooks like{ "klass": "java.lang.String", "propertyType": "TEXT", "name": "name", "fieldName": "name", "persisted": true, "description": "The name of this Object. Required and unique.", "attribute": true, "simple": true, "collection": false, "ordered": false, "owner": true, "identifiableObject": false, "nameableObject": false, "embeddedObject": false, "analyticalObject": false, "readable": true, "writable": true, "unique": true, "required": true, "length": 230, "max": 230.0, "min": 1.0, "manyToMany": false, "oneToOne": false, "manyToOne": false, "oneToMany": false, "translatable": true, "translationKey": "NAME", "i18nTranslationKey": "name", "gistPreferences": { "included": "AUTO", "transformation": "AUTO" }, "sortable": true, "propertyTransformer": false }