Skip to content
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

gedcomx-model includes other/RS specification fields #87

Open
thnaeff opened this issue Sep 7, 2022 · 1 comment
Open

gedcomx-model includes other/RS specification fields #87

thnaeff opened this issue Sep 7, 2022 · 1 comment

Comments

@thnaeff
Copy link
Contributor

thnaeff commented Sep 7, 2022

The gedcomx-java project in general and specifically the gedcomx-model is described as

This is where the Java classes that correspond to the GEDCOM X data types defined by the GEDCOM X Conceptual Model...

I see "RS" only mentioned for the (deprecated) client implementation and for the extensions module.

However, various classes in the gedcomx-model contain other fields - for example from the RS specification. A few examples:

  • Person is defined by the Conceptual Model to have private, gender, names, facts fields. But the model implementation here also contains living, principal and display which are part of the RS extension (I am not sure where principal comes from).
  • Relationship also contains an extra fields field - which I am actually not sure where it comes from
  • The Link class is defined in the RS specifications
  • Name contains the field preferred which is from the RS specifications
  • ...

Should the documentation be updated to mention that the gedcomx-model is a combination of conceptual model + RS extension (if that was intended)? Or, should the model be separated into conceptual model and a model that applies the extension?

@stoicflame
Copy link
Member

Hi!

Thanks for the report.

Yeah we've been a little looser with the gedcomx-model Java implementation since it's not the canonical definition of the model. So we've allowed some extensions to leak in there, and in general it's worked out fine. We should update the documentation to reflect that. It would also be nice to explicitly indicate any properties that belong in the RS spec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants