QueryBuilder (javers-core 1.6.7 API)

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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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)` Query for selecting changes (or snapshots) made on any object (Entity or ValueObject) of given class.
`static QueryBuilder`	`byGlobalIdDTO(GlobalIdDTO globalId)` Deprecated.
`static QueryBuilder`	`byInstanceId(java.lang.Object localId, java.lang.Class entityClass)` Query for selecting changes (or snapshots) made on a concrete Entity instance.
`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).
`QueryBuilder`	`from(org.joda.time.LocalDate fromDate)` delegates to `from(LocalDateTime)` with MIDNIGHT
`QueryBuilder`	`from(org.joda.time.LocalDateTime from)` Limits Snapshots to be fetched from JaversRepository to those created after (>=) given date.
`protected java.util.List<org.javers.repository.jql.Filter>`	`getFilters()`
`protected QueryParams`	`getQueryParams()`
`QueryBuilder`	`limit(int limit)` Limits number of Snapshots to be fetched from JaversRepository, default is 100.
`QueryBuilder`	`skip(int skip)` Sets the number of Snapshots to skip.
`QueryBuilder`	`to(org.joda.time.LocalDate toDate)` delegates to `to(LocalDateTime)` with MIDNIGHT
`QueryBuilder`	`to(org.joda.time.LocalDateTime to)` Limits Snapshots to be fetched from JaversRepository to those created before (<=) given date.
`QueryBuilder`	`withCommitId(java.math.BigDecimal commitId)` delegates to `withCommitId(CommitId)`
`QueryBuilder`	`withCommitId(CommitId commitId)` Limits Snapshots to be fetched from JaversRepository to those with a given commitId.
`QueryBuilder`	`withNewObjectChanges()` Alias to `withNewObjectChanges(boolean)` with true
`QueryBuilder`	`withNewObjectChanges(boolean newObjectChanges)` Affects changes query only.
`QueryBuilder`	`withVersion(long version)` Limits Snapshots to be fetched from JaversRepository to those with a given version.

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)
```
    Query for selecting changes (or snapshots) made on any object (Entity or ValueObject) of given class.
    
    For example, last changes on any object of MyClass.class:
```
 javers.findChanges( QueryBuilder.byClass(MyClass.class).build() );
 
```
  - byInstanceId
```
public static QueryBuilder byInstanceId(java.lang.Object localId,
                                        java.lang.Class entityClass)
```
    Query for selecting changes (or snapshots) made on a concrete Entity instance.
    
    For example, last changes on "bob" Person:
```
 javers.findChanges( QueryBuilder.byInstanceId("bob", Person.class).build() );
 
```
  - 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.
  - withNewObjectChanges
```
public QueryBuilder withNewObjectChanges()
```
    Alias to withNewObjectChanges(boolean) with true
  - limit
```
public QueryBuilder limit(int limit)
```
    Limits number of Snapshots to be fetched from JaversRepository, default is 100.
    Always choose reasonable limits to improve performance of your queries, production database could contain more records than you expect.
  - skip
```
public QueryBuilder skip(int skip)
```
    Sets the number of Snapshots to skip. Use skip() and limit() for for paging.
  - from
```
public QueryBuilder from(org.joda.time.LocalDateTime from)
```
    Limits Snapshots to be fetched from JaversRepository to those created after (>=) given date.
    
    Important for Changes query
    When querying for Changes done after given point in time, results will lack in first set of changes after that point.
    For example. Consider three commits of some object done in every two days:
```
     javers.commit(someObject); //Monday
     javers.commit(someObject); //Wednesday
     javers.commit(someObject); //Friday
 
```
    Query for Snapshots from Wednesday gives you 2 results as expected: Wednesday's and Friday's Snapshots.
    But query for Changes from Wednesday gives you only changes done on Friday. That's because Changes Query is backed by Snapshots Query and Changes are calculated as a diff between subsequent Snapshots.
    CommitDate is local datetime
    Please remember that commitDate is persisted as LocalDateTime (without information about time zone and daylight saving time).
    iteration of the hour, given commit was made.
    See Also:
    
    to(LocalDateTime)
  - from
```
public QueryBuilder from(org.joda.time.LocalDate fromDate)
```
    delegates to from(LocalDateTime) with MIDNIGHT
  - to
```
public QueryBuilder to(org.joda.time.LocalDateTime to)
```
    Limits Snapshots to be fetched from JaversRepository to those created before (<=) given date.
  - to
```
public QueryBuilder to(org.joda.time.LocalDate toDate)
```
    delegates to to(LocalDateTime) with MIDNIGHT
  - withCommitId
```
public QueryBuilder withCommitId(CommitId commitId)
```
    Limits Snapshots to be fetched from JaversRepository to those with a given commitId.
    
    Warning! Using withCommitId filter when querying for Changes makes no sense because the result will always be empty.
  - withCommitId
```
public QueryBuilder withCommitId(java.math.BigDecimal commitId)
```
    delegates to withCommitId(CommitId)
  - withVersion
```
public QueryBuilder withVersion(long version)
```
    Limits Snapshots to be fetched from JaversRepository to those with a given version.
    
    Warning! Using withVersion filter when querying for Changes makes no sense because the result will always be empty.
  - addFilter
```
protected void addFilter(org.javers.repository.jql.Filter filter)
```
  - getFilters
```
protected java.util.List<org.javers.repository.jql.Filter> getFilters()
```
  - getQueryParams
```
protected QueryParams getQueryParams()
```
  - build
```
public JqlQuery build()
```

Class QueryBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

byClass

byInstanceId

byValueObject

byValueObjectId

byGlobalIdDTO

andProperty

withNewObjectChanges

withNewObjectChanges

limit

skip

from

Important for Changes query

CommitDate is local datetime

from

to

to

withCommitId

withCommitId

withVersion

addFilter

getFilters

getQueryParams

build