com.haulmont.restapi.service.filter

Class RestFilterParser

java.lang.Object

com.haulmont.restapi.service.filter.RestFilterParser

@Component(value="cuba_RestFilterParser")
public class RestFilterParser
extends java.lang.Object

Class for REST API search filter JSON parsing

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
RestFilterParser()

Method Summary

Modifier and Type	Method and Description
RestFilterParseResult	parse(java.lang.String filterJson, MetaClass metaClass) Parses the JSON with entities filter and returns an object with JPQL query string and query parameters.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

RestFilterParser

public RestFilterParser()

Method Detail

parse

public RestFilterParseResult parse(java.lang.String filterJson,
                                   MetaClass metaClass)
                            throws RestFilterParseException

Parses the JSON with entities filter and returns an object with JPQL query string and query parameters. The method expects a JSON object like this:

 {
  "conditions": [
      {
          "group": "OR",
          "conditions": [
              {
                  "property": "stringField",
                  "operator": "<>",
                  "value": "stringValue"
              },
              {
                  "property": "intField",
                  "operator": ">",
                  "value": 100
              }
          ]
      },
      {
          "property": "booleanField",
          "operator": "=",
          "value": true
      }
  ]
 }
 

Conditions here may be of two types: property condition and group condition (AND and OR) . Root conditions are automatically placed to the group condition of type AND.

Throws:

RestFilterParseException