Mendix XPath is one of the Mendix query languages designed to retrieve data. XPath uses path expressions to select data of Mendix objects and their attributes or associations.
XPath queries can be written both in Studio Pro, for example when you want to specify a constraint on the data retrieved in a Retrieve microflow activity, and directly in code in the .java files of your Java actions. Note that not all operators are supported by Studio Pro, and that the syntax of your query may differ between Studio Pro and Java environments.
Examples of XPath queries are:
//Sales.CustomerRetrieve all customers.
//Sales.Customer[Name='Jansen']Retrieve all customers with name ‘Jansen’.
avg(//Sales.Order[IsPaid = true()]/TotalPrice)Retrieve the average of the total prices of all paid orders.
In Studio Pro, you do not write complete queries, only the constraints. The entity is implicitly determined by the context. So, instead of
//Sales.Customer[Name='Jansen'], you only need to write
[Name='Jansen'] in the context of a customer. In Java, you do need to write the whole queries, including the double slashes (
//) and the entity name.
2 XPath Elements
A common Mendix XPath query consists of a several elements.
|Aggregate function (optional)||Entity to retrieve (required)||Constraint (optional)||Attribute to retrieve (optional)|
|avg||//Sales.Order||[IsPaid = true()]||/TotalPrice|
Element B describes the core of each query and consists of a description of the object being retrieved. This segment always starts with two forward slashes ‘//’ and includes the name of the entity you wish to access preceded by the module containing the entity separated by a period. E.g. //Sales.Customer would return all objects of entity ‘Customer’ in the module ‘Sales’.
Element C of a query is optional and contains one or more constraints to restrict the data being retrieved.
Consider the following query:
The constraint is clearly visible between brackets and restricts the objects retrieved to those for which the attribute ‘Name’ equals ‘Jansen’. Objects with any other name than Jansen are excluded from the list. The number of possible constraints on a single query is unlimited. For more information on how to add and manipulate these constraints, see XPath Constraints.
Element D of a query is optional and specifies an attribute of the retrieved entity. This option is rarely used in Studio Pro itself as all data is stored in objects, making it cumbersome and needlessly complicated to deal with a list of single attribute. However, various Java actions have use of such lists. Also, this functionality can be used in conjunction with Part A to create aggregates of certain attributes easily.
Element A of a query is optional and specifies an aggregation. Element A can be one of the following functions: avg, count, max, min and sum. With the exception of ‘count’, each of these functions require that a particular attribute is specified in element D.
For details, see XPath Tokens.
For details, see XPath Operators.
The following XPath functions are available:
- XPath functions:
- Constraint functions:
How to find the right path to XPath
This video was done with Studio Pro 8, but the concepts remain applicable.