Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-26658

Clean up FileFormatter vs Formatter hierarchy

    XMLWordPrintable

    Details

    • Story Points:
      4
    • Team:
      Architecture
    • Urgent?:
      No

      Description

      In working on DM-25691 it became clear that the FileFormatter subclass is a bit inconsistent and not as useful as it should be. We also have some design issues stemming from an initial design decision that Formatter is a generic concept for gen3 that deals with read() and write() to a datastore location but is not specific for files.

      At this point it seems likely that Formatter is only used for files and that we can clean up some wrinkles in the structure of the classes by making that explicit. If a new datastore comes along that needs something other than files and needs a Formatter concept then we can create a whole new unrelated class for it.

        Attachments

          Issue Links

            Activity

            Hide
            tjenness Tim Jenness added a comment -

            The urgency of this work is not clear to me. It's something that will help future formatter writers but I don't know what the timeline is for other people wanting to write them before gen2 deprecation.

            Show
            tjenness Tim Jenness added a comment - The urgency of this work is not clear to me. It's something that will help future formatter writers but I don't know what the timeline is for other people wanting to write them before gen2 deprecation.
            Hide
            jbosch Jim Bosch added a comment -

            I think the big question is whether it's likely to change what we want to write into the datastore records tables, either in terms of structural changes or formatter names.  But I think even the worst case is probably a fairly straightforward migration script.

            Show
            jbosch Jim Bosch added a comment - I think the big question is whether it's likely to change what we want to write into the datastore records tables, either in terms of structural changes or formatter names.  But I think even the worst case is probably a fairly straightforward migration script.
            Hide
            tjenness Tim Jenness added a comment -

            None of this cleanup would change the formatter names in the datastore. No dataset ever uses Formatter or FileFormatter directly.

            Show
            tjenness Tim Jenness added a comment - None of this cleanup would change the formatter names in the datastore. No dataset ever uses Formatter or FileFormatter directly.

              People

              Assignee:
              tjenness Tim Jenness
              Reporter:
              tjenness Tim Jenness
              Watchers:
              Eli Rykoff, Jim Bosch, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins Builds

                  No builds found.