Uploaded image for project: 'Jackrabbit Oak'
  1. Jackrabbit Oak
  2. OAK-116

MicroKernel API: clarify semantics of getNodes depth, offset and count parameters

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • 0.3
    • mk
    • None

    Description

      MicroKernel.getNode(String path, String revisionId, int depth, long offset, int count, String filter)

      the semantics of depth as currently documented in the javadoc is inconsistent:

      • depth=0 returns empty child node objects
      • depth=1 OTOH doesn't return empty grand children objects

      the amount of information returned on the deepest level should IMO be independent of the depth value.

      count as currently documented is only applied to the root of the returned subtree. this would imply that the implementation has to always return all child nodes on deeper levels, even for potentially very large child node sets.

      i suggest we rename count to maxChildNodes and apply it on every level of the returned subtree.

      Attachments

        Issue Links

          Activity

            People

              stefan@jira Stefan Guggisberg
              stefan@jira Stefan Guggisberg
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: