org.javers.repository.jql

Class QueryBuilder

java.lang.Object

org.javers.repository.jql.QueryBuilder

public class QueryBuilder
extends java.lang.Object

Fluent API for building JqlQuery, executed with Javers.findChanges(JqlQuery) and Javers.findSnapshots(JqlQuery)

See Also:

http://javers.org/documentation/jql-examples

Method Summary

Modifier and Type	Method and Description
protected void	addFilter(org.javers.repository.jql.Filter filter)
QueryBuilder	andProperty(java.lang.String propertyName) Filters to snapshots with a given property on changed properties list.
JqlQuery	build()
static QueryBuilder	byClass(java.lang.Class requiredClass)
static QueryBuilder	byGlobalIdDTO(GlobalIdDTO globalId) Deprecated.
static QueryBuilder	byInstanceId(java.lang.Object localId, java.lang.Class entityClass)
static QueryBuilder	byValueObject(java.lang.Class ownerEntityClass, java.lang.String path) Query for selecting changes (or snapshots) made on all ValueObjects at given path, owned by any instance of given Entity.
static QueryBuilder	byValueObjectId(java.lang.Object ownerLocalId, java.lang.Class ownerEntityClass, java.lang.String path) Query for selecting changes (or snapshots) made on a concrete ValueObject (so a ValueObject owned by a concrete Entity instance).
protected java.util.List<org.javers.repository.jql.Filter>	getFilters()
protected int	getLimit()
QueryBuilder	limit(int limit) Limits number of snapshots to be read from JaversRepository, default is 100.
QueryBuilder	withNewObjectChanges(boolean newObjectChanges) Affects changes query only.

Methods inherited from class java.lang.Object

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

Method Detail

byClass

public static QueryBuilder byClass(java.lang.Class requiredClass)

byInstanceId

public static QueryBuilder byInstanceId(java.lang.Object localId,
                                        java.lang.Class entityClass)

byValueObject

public static QueryBuilder byValueObject(java.lang.Class ownerEntityClass,
                                         java.lang.String path)

Query for selecting changes (or snapshots) made on all ValueObjects at given path, owned by any instance of given Entity.

See Path parameter hints in byValueObjectId(Object, Class, String).

byValueObjectId

public static QueryBuilder byValueObjectId(java.lang.Object ownerLocalId,
                                           java.lang.Class ownerEntityClass,
                                           java.lang.String path)

Query for selecting changes (or snapshots) made on a concrete ValueObject (so a ValueObject owned by a concrete Entity instance).

Path parameter is a relative path from owning Entity instance to ValueObject that you are looking for.

When ValueObject is just a property, use propertyName. For example:

 class Employee {
     @Id String name;
     Address primaryAddress;
 }
 ...
 javers.findChanges( QueryBuilder.byValueObjectId("bob", Employee.class, "primaryAddress").build() );
 

When ValueObject is stored in a List, use propertyName and list index separated by "/", for example:

 class Employee {
     @Id String name;
     List<Address> addresses;
 }
 ...
 javers.findChanges( QueryBuilder.byValueObjectId("bob", Employee.class, "addresses/0").build() );
 

When ValueObject is stored as a Map value, use propertyName and map key separated by "/", for example:

 class Employee {
     @Id String name;
     Map<String,Address> addressMap;
 }
 ...
 javers.findChanges( QueryBuilder.byValueObjectId("bob", Employee.class, "addressMap/HOME").build() );
 

byGlobalIdDTO

@Deprecated
public static QueryBuilder byGlobalIdDTO(GlobalIdDTO globalId)

Deprecated.

andProperty

public QueryBuilder andProperty(java.lang.String propertyName)

Filters to snapshots with a given property on changed properties list.

See Also:

CdoSnapshot.getChanged()

withNewObjectChanges

public QueryBuilder withNewObjectChanges(boolean newObjectChanges)

Affects changes query only. When switched on, additional changes are generated for the initial snapshot (the first commit of a given object). Off by default.
It means one NewObject change for each initial snapshot and the full set of initial PropertyChanges with null on the left side and initial property value on the right.

limit

public QueryBuilder limit(int limit)

Limits number of snapshots to be read from JaversRepository, default is 100.
Always choose reasonable limits to improve performance of your queries.

addFilter

protected void addFilter(org.javers.repository.jql.Filter filter)

getFilters

protected java.util.List<org.javers.repository.jql.Filter> getFilters()

getLimit

protected int getLimit()

build

public JqlQuery build()