-
Notifications
You must be signed in to change notification settings - Fork 31
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.
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
Can we use more consistent terminology for entity attribute/field/property? #906
Milestone
Comments
I tried for years to convince the world to use "attribute" here, but finally I gave up and now I mostly just recite "field or property" or "fields and properties". |
I like |
In today's meeting we agreed with |
njr-11
added a commit
to njr-11/data
that referenced
this issue
Dec 18, 2024
…erminology Signed-off-by: Nathan Rauh <nathan.rauh@us.ibm.com>
njr-11
added a commit
to njr-11/data
that referenced
this issue
Jan 9, 2025
Signed-off-by: Nathan Rauh <nathan.rauh@us.ibm.com>
njr-11
added a commit
to njr-11/data
that referenced
this issue
Jan 9, 2025
Signed-off-by: Nathan Rauh <nathan.rauh@us.ibm.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Jakarta Data is currently very inconsistent in how it refers to entity attributes/fields/properties. Or sometimes persistent fields. Or sometimes (persistent) fields and properties. By using different terms, there is some concern that users, especially newer users who are often the ones who most need to rely on the documentation, will believe they are referring to different things.
Whether or not we go back and try to be more consistent with what we have already done is one matter, but I would like to at least figure out what is preferred going forward before we starting adding documentation for v1.1 and beyond.
I did some quick searches across the Javadoc and spec documents to approximately figure out what the current usage is:
117 occurrences of
attribute
: 108 in Javadoc. 9 in spec doc.94 occurrences of
property
: 59 in Javadoc. 35 is spec doc.220 occurrences of
field
: 98 in Javadoc. 122 in spec doc.11 occurrences of
field or property
and similar: 8 in Javadoc. 3 in spec doc.52 occurrences of
persistent field
: 19 in Javadoc. 43 in spec doc.A subset of this usage is encoded into the API and cannot change even if we wanted to:
Attribute
is used in class namesAttribute
,SortableAttribute
,TextAttribute
within the static metamodel (and also in the *Record implementation classes, which are lesser concern because users should not look at those)property
is a record component name of theSort
API.And we just recently added for v1.1 (so it could still be changed if we want),
field
is a record component name of theBasicRestriction
API.The text was updated successfully, but these errors were encountered: