Uploaded image for project: 'ModeShape'
  1. ModeShape
  2. MODE-2410

Clarify ambigous method in the connector's DocumentWriter API

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Major
    • 4.2.0.Final
    • 3.8.1.Final, 4.1.0.Final
    • Federation

    Description

      The DocumentWriter SPI contains the following method (unused atm in any of the default connector implementations):

        /**
           * Some connectors may want to pre-generate additional documents when {@link Connector#getDocumentById(String)} is called. In
           * such a case, the connector can use this method to obtain a writer for an additional document and use it in much the same
           * was as {@link Connector#newDocument(String)}. The resulting additional document will be included automatically when the
           * Connector returns the {@link #document() top-level document}.
           * 
           * @param id the identifier of the additional document; may not be null
           * @return the writer for the additional document; never null
           */
          DocumentWriter writeAdditionalDocument( String id );
      

      Considering the way the external document store/connector support works, this makes little sense to me atm in this form/implementation.
      We need to either clarify this or deprecate this method.

      Attachments

        Activity

          People

            hchiorean Horia Chiorean (Inactive)
            hchiorean Horia Chiorean (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: