Changes between Version 15 and Version 16 of S3/S3Hierarchy

Timestamp:

05/27/14 12:26:58 (10 years ago)

Author:

Dominic König

Comment:

--

S3/S3Hierarchy

@@ -244 +244 @@
 ''(Description to follow)''
 
-== Hierarchical Query Operator __typeof ==
-
-The {{{__typeof}}} query operator can be used to filter by a type and all its sub-types in a hierarchical taxonomy.
-
-''(Description to follow)''
+== Hierarchical Query Operator typeof ==
+
+The {{{typeof}}} query operator can be used to filter by a type and all its sub-types in a hierarchical taxonomy.
+
+It can be used with a reference (or list:reference) to a hierarchical table:
+{{{#!python
+query = FS("site_facility_type.facility_type_id").typeof(4L)
+}}}
+
+or with a field within the hierarchical table:
+{{{#!python
+query = FS("site_facility_type.facility_type_id.name").typeof("Hospital")
+}}}
+
+For string fields within the hierarchical table, "*" can be used as wildcard:
+{{{#!python
+# Matches e.g. "Fuel Depot", "Goods Depot" etc, and all their subtypes
+query = FS("site_facility_type.facility_type_id.name").typeof("*Depot")
+}}}
+
+Multiple options can be specified as list:
+{{{#!python
+# Matches "Hospital", "*Depot" and all their subtypes
+query = FS("site_facility_type.facility_type_id.name").typeof(["Hospital", "*Depot"])
+}}}
+
+In URLs, the operator is specified as !__typeof like:
+{{{
+eden/org/facility?site_facility_type.facility_type_id.name__typeof=Hospital,*Depot
+}}}
+
+Where {{{typeof}}} is used with a virtual field, or no hierarchy is configured for the target table, it falls back to {{{belongs}}} (or {{{contains}}} for list-types, respectively).