Semantic Object Query Language

The Semantic Object Query Language (SOQL) is an object query language analogous to JPQL (or HQL) designed for JOPA. Its main purpose is to simplify creation of queries over the object model managed by JOPA. SOQL queries are translated into SPARQL based on the metamodel and executed in a similar manner to the current support for SPARQL in JOPA.

The goal is to support as many features of JPQL as possible, but taking into account the specifics of SPARQL and ontologies.

Supported Features

• SELECT, ASK (since 2.11.0)
• DISTINCT
• Join by property path (p.phone.number)
• LIKE, AND, OR, NOT, (since 0.20.0) IN, (since 1.1.0) MEMBER OF
• ORDER BY, GROUP BY
• COUNT
• Comparison operators - >, <, >=, <=, =, <> (alternatively !=)
• (Since 0.22.0) Functions on strings - UPPER, LOWER, LENGTH
• (Since 0.22.0) Functions on numbers - ABS, CEIL, FLOOR
• (Since 0.22.0) Selection by identifier
• (Since 1.1.0) Language tag extraction function LANG

Simple examples:

• SELECT p FROM Person p
• SELECT p FROM Person p WHERE p.username = :username
• SELECT p FROM Person p WHERE NOT p.role = :role
• SELECT p FROM Person p WHERE p.username LIKE :username
• SELECT p FROM Person p WHERE p.phone.number = :phoneNumber
• SELECT p FROM Person p WHERE p.age > :age ORDER BY p.age DESC
• SELECT p FROM Person p WHERE p.username IN :authorizedUsers
• SELECT p FROM Person p WHERE :adminType MEMBER OF p.types
• SELECT t FROM Term t WHERE LANG(t.label) = :uiLanguage
• ASK FROM Person p WHERE p.age > :age

See SoqlQueryParserTest for more examples.

TODO

The following features are not implemented, yet:

• Parentheses in the WHERE clause
• OPTIONAL
• Aggregation functions besides count
• Complex joins
• Projection of multiple entities or entity attributes -> currently, only an entity (or its count) can be projected from the query
• Inner selects