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

Update IDREF to IDREFS #298

Closed
jdmgoogle opened this issue Jan 7, 2016 · 8 comments
Closed

Update IDREF to IDREFS #298

jdmgoogle opened this issue Jan 7, 2016 · 8 comments
Assignees
Milestone

Comments

@jdmgoogle
Copy link
Contributor

Many elements of type IDREF also have maxOccurs="unbounded". We should switch these over to IDREFS for a few reasons.

  1. An unbounded list of IDREF values is the point of IDREFS;
  2. Certain libraries (such as JAXB for Java) work with IDREFS but not an unbounded list of IDREF elements (go figure);
  3. The NIST spec will probably be switching over to this as well; and
  4. It's a minor change.

Comments? Feedback?

@jdmgoogle jdmgoogle self-assigned this Jan 7, 2016
@jdmgoogle jdmgoogle added this to the Version 5.1 milestone Jan 7, 2016
@pstenbjorn
Copy link
Contributor

@jdmgoogle I was under the impression that the use of IDREFS was to refer to a series of ID elements in a single list not that there could be multiple elements with a single IDREF value. So is your suggestion that we have a single element that will contain a collection of reference IDs?

@jdmgoogle
Copy link
Contributor Author

@pstenbjorn Correct. I may have worded my request awkwardly. For example, in BallotStyle instead of this:

<OrderedContestId>oc0001</OrderedContestId>
<OrderedContestId>oc0002</OrderedContestId>
<OrderedContestId>oc0003</OrderedContestId>
<OrderedContestId>oc0004</OrderedContestId>
<OrderedContestId>oc0005</OrderedContestId>

we'd have this:

<OrderedContestId>oc0000 oc0001 oc0002 oc0003 oc0004 oc0005</OrderedContestId>

@pstenbjorn
Copy link
Contributor

@jdmgoogle in that case, yes, this makes a great deal of sense.

@jungshadow
Copy link
Collaborator

@pstenbjorn @jdmgoogle Seconded.

@cjerdonek
Copy link
Contributor

Should the suffix in those names be changed to "Ids" to reflect that it can
be more than one?

On Thursday, January 7, 2016, Jared notifications@github.com wrote:

@pstenbjorn https://github.com/pstenbjorn @jdmgoogle
https://github.com/jdmgoogle Seconded.


Reply to this email directly or view it on GitHub
#298 (comment)
.

@jdmgoogle
Copy link
Contributor Author

It was more than one before, and pretty much any API for parsing the data provided it as a list.

I'm torn, but leaning towards keeping the name as it is.

I'm open to feedback from others, though.

@cjerdonek
Copy link
Contributor

The difference is that before it was multiple elements, and each
element represented a single ID. So the singular "Id" for the element name was
appropriate. In this case, it will be a single element whose value
represents multiple IDs.

On Thursday, January 7, 2016, jdmgoogle notifications@github.com wrote:

It was more than one before, and pretty much any API for parsing the data
provided it as a list.

I'm torn, but leaning towards keeping the name as it is.

I'm open to feedback from others, though.


Reply to this email directly or view it on GitHub
#298 (comment)
.

@jungshadow
Copy link
Collaborator

I think @cjerdonek makes a really good point. It's more clear regarding what the element potentially contains (1...n). I'd vote to change the name and update the styleguide to reflect it.

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

No branches or pull requests

4 participants