[OAK-75] specify format and semantics of 'filter' parameter in MicroKernel API

• Type: New Feature
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.3
• Component/s: mk
• Assignee: Stefan Guggisberg
• Reporter: Stefan Guggisberg
• Created: 27/Apr/12 14:02
• Updated: 05/Jul/12 15:02
• Resolved: 25/May/12 20:21

Description

the following MicroKernel methods contain a 'filter' string parameter:

• getJournal
• diff
• getNodes

through the filter an API client could e.g. specify:

• special 'meta' properties to be included (e.g. ":hash")
• glob patterns on the names of properties/child nodes to be included/excluded
• path filter (for getJournal and diff)

format/detailed semantics TBD, here's an initial proposal (json):

 
{
  "path" : "/some/path",
  "incl" : [ ":hash", "*" ],
  "excl" : [ "tmp*" ]
}

name filter patterns should ideally be the same
format as specified for JCR Node.getNodes/getProperties.

Issue Links

• is part of: OAK-11 Document and tighten contract of Microkernel API