QueryParser (CUBA 6.7 API)

All Known Implementing Classes:

QueryParserAstBased, QueryParserRegex, QueryTransformerRegex
```
public interface QueryParser
```
Parses JPQL query and returns some information about it.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class QueryParser.QueryPath

Nested Classes
Modifier and Type	Interface and Description
`static class`	`QueryParser.QueryPath`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String NAME

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.Set<java.lang.String>`	`getAllEntityNames()`
`java.lang.String`	`getEntityAlias()`
`java.lang.String`	`getEntityAlias(java.lang.String targetEntity)` Main entity alias
`java.lang.String`	`getEntityName()` Main entity name
`java.lang.String`	`getEntityNameIfSecondaryReturnedInsteadOfMain()`
`java.lang.String`	`getEntityPathIfSecondaryReturnedInsteadOfMain()`
`java.util.Set<java.lang.String>`	`getParamNames()` Get all parameter names
`java.util.List<QueryParser.QueryPath>`	`getQueryPaths()`
`boolean`	`hasIsNullCondition(java.lang.String attribute)`
`boolean`	`hasJoins()` Returns true if SELECT query contains joins
`boolean`	`isCollectionSecondaryEntitySelect()`
`boolean`	`isEntitySelect(java.lang.String targetEntity)` Returns true if this is a standard select from an entity - not count() and not fields (e.id, etc.)
`boolean`	`isParameterInCondition(java.lang.String parameterName)`

- Field Detail
  - NAME
```
static final java.lang.String NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getParamNames
```
java.util.Set<java.lang.String> getParamNames()
```
    Get all parameter names
  - getEntityName
```
java.lang.String getEntityName()
```
    Main entity name
  - getAllEntityNames
```
java.util.Set<java.lang.String> getAllEntityNames()
```
  - getEntityAlias
```
java.lang.String getEntityAlias(java.lang.String targetEntity)
```
    Main entity alias
  - getEntityAlias
```
java.lang.String getEntityAlias()
```
  - isEntitySelect
```
boolean isEntitySelect(java.lang.String targetEntity)
```
    Returns true if this is a standard select from an entity - not count() and not fields (e.id, etc.)
  - hasIsNullCondition
```
boolean hasIsNullCondition(java.lang.String attribute)
```
  - hasJoins
```
boolean hasJoins()
```
    Returns true if SELECT query contains joins
  - getEntityNameIfSecondaryReturnedInsteadOfMain
```
@Nullable
java.lang.String getEntityNameIfSecondaryReturnedInsteadOfMain()
```
    Returns:
    
    Entity name if not main entity name is returned, otherwise null Example: select u.group from sec$User u -> sec$Group Example: select g from sec$User u join u.group g -> sec$Group
  - getEntityPathIfSecondaryReturnedInsteadOfMain
```
@Nullable
java.lang.String getEntityPathIfSecondaryReturnedInsteadOfMain()
```
    Returns:
    
    Entity path if not main entity name is returned, otherwise null Example: select u.group from sec$User u -> u.group Example: select g from sec$User u join u.group g -> g
  - isCollectionSecondaryEntitySelect
```
boolean isCollectionSecondaryEntitySelect()
```
    Returns:
    
    true if not main entity selected and it's path with collection Example: select u.group from sec$User u -> false Example: select u.userRoles from sec$User u -> true
  - isParameterInCondition
```
boolean isParameterInCondition(java.lang.String parameterName)
```
  - getQueryPaths
```
java.util.List<QueryParser.QueryPath> getQueryPaths()
```

Interface QueryParser

Nested Class Summary

Field Summary

Method Summary

Field Detail

NAME

Method Detail

getParamNames

getEntityName

getAllEntityNames

getEntityAlias

getEntityAlias

isEntitySelect

hasIsNullCondition

hasJoins

getEntityNameIfSecondaryReturnedInsteadOfMain

getEntityPathIfSecondaryReturnedInsteadOfMain

isCollectionSecondaryEntitySelect

isParameterInCondition

getQueryPaths