Integrated base class support for foreign keys #1499
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d of a class attribute of the BSTBaseColumn class. I realized that is_fk is not necessarily a charcteristic exclusive to the planned BSTRelatedColumn. A regular Field column (i.e. BSTColumn) can have fields that are foreign keys and they can be linked whether or not we've defined a BSTRelatedColumn. The features that BSTRelatedColumn will allow is the specification of a display value instead of how a related model object happens to render in str context. Just note that the foreign key cannot be searched or sorted based on that string-context value. That's what defining a BSTRelatedColumn will provide. Details: - Created a model utility method named is_key_field - Defaulted is_fk in the BSTBaseColumn as False if it is not set/defined. - Added doc strings to a bunch of model utility methods. Files checked in: DataRepo/models/utilities.py DataRepo/tests/views/models/bst_list_view/column/test_field.py DataRepo/views/models/bst_list_view/column/base.py DataRepo/views/models/bst_list_view/column/field.py
…archable and sortable automatically defaulted based on whether the field was a foreign key. Files checked in: DataRepo/views/models/bst_list_view/column/base.py
hepcat72
added
type:feature
This was referenced Apr 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary Change Description
Turned
is_fkinto an instance attribute of theBSTColumnclass instead of a class attribute of theBSTBaseColumnclass.I realized that
is_fkis not necessarily a characteristic exclusive to the plannedBSTRelatedColumn. A regularFieldcolumn (i.e.BSTColumn) can have fields that are foreign keys and they can be linked whether or not we've defined aBSTRelatedColumn. The features thatBSTRelatedColumnwill allow is the specification of a display value instead of how a related model object happens to render in str context. Just note that the foreign key cannot be searched or sorted based on that string-context value. That's what defining aBSTRelatedColumnwill provide.Details:
is_key_fieldis_fkin theBSTBaseColumnasFalseif it is not set/defined.is_relatedtoBSTBaseColumnand madesearchableandsortableautomatically defaulted based on whether the field was a foreign key.Affected Issues/Pull Requests
bst_annot_colBSTAnnotColumn(and refactor/re-org) #1494BSTRelatedColumn#1500Reviewer Notes/Requests
See comments in-line.
Checklist
This pull request will be merged once the following requirements are met. The
author and/or reviewers should uncheck any unmet requirements:
CHANGELOG.mdUnreleased section