jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Jackrabbit Wiki] Update of "frm/RemoteOperations" by frm
Date Tue, 10 Feb 2015 09:12:59 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Jackrabbit Wiki" for change notification.

The "frm/RemoteOperations" page has been changed by frm:
https://wiki.apache.org/jackrabbit/frm/RemoteOperations?action=diff&rev1=2&rev2=3

  
  Optional parameters:
  
-  * Depth. How deep the returned tree should be. Defaults to 0.
+  * Depth. How deep the returned tree should be. Defaults to `0`.
  
-  * Property filters. A list of globs to filter property names. Defaults to ['*'].
+  * Property filters. A list of globs to filter property names. Defaults to `['*']`.
  
-  * Node filters. A list of globs to filter node names. Defaults to ['*'].
+  * Node filters. A list of globs to filter node names. Defaults to `['*']`.
  
-  * Binary threshold. The maximum number of bytes a binary property should have to be inlined
inside the response. See the section about serializing binary properties below. Defaults to
0.
+  * Binary threshold. The maximum number of bytes a binary property should have to be inlined
inside the response. See the section about serializing binary properties below. Defaults to
`0`.
+ 
+  * Children start index. A number representing the staring index where to read children
from. Defaults to `0`, meaning that children will be returned starting from the beginning.
+ 
+  * Children count. A number representing the maximum number of children to read. Defaults
to `-1`, meaning that every children will be returned.
  
  Returned values:
  
@@ -70, +74 @@

  
  The snippet above represents a tree with depth zero. The root of the tree has three properties:
a string property named "foo", a URI property names "baz" and a multi-value boolean property
named "qux". The root of the tree also has two children named "bob" and "sue". Since including
the children would make the depth of the tree exceed the requested depth of zero, the special
empty tree value `null` is used to end the recursion in the tree representation.
  
+ The caller has two way to filter out children. The first is by providing one or more name
filters. The second is by providing a children start index, the maximum number of children
to return, or both. When all these mechanisms are used in the same call, the following order
in applying filters must be followed:
+ 
+  * If the children start index is provided, the list of children is trimmed to exclude every
children before the provided start index.
+ 
+  * If the children count is provided, the list of children is trimmed to include at most
the number of children specified by the children count.
+ 
+  * If children filters are provided, they are applied to filter out the resulting list even
more.
+ 
  The simple property types supported during serialization are string, binary, binary ID,
long, double, date, boolean, name, path, reference, weak reference, URI and decimal. The multi-value
property types are strings, binaries, binary IDs, longs, doubles, dates, booleans, names,
paths, references, weak references, URIs and decimals.
  
  == Serializing binary properties ==

Mime
View raw message