QueryBuilder (javers-core 5.1.3 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	Description
`QueryBuilder`	`andProperty(java.lang.String propertyName)`	Deprecated.
`static QueryBuilder`	`anyDomainObject()`	Query for selecting changes (or snapshots) made on any object.
`JqlQuery`	`build()`
`QueryBuilder`	`byAuthor(java.lang.String author)`	Only snapshots committed by a given author.
`static QueryBuilder`	`byClass(java.lang.Class... requiredClasses)`	Query for selecting changes (or snapshots) made on any object (Entity or ValueObject) of given classes.
`static QueryBuilder`	`byGlobalId(GlobalIdDTO globalId)`
`static QueryBuilder`	`byInstance(java.lang.Object instance)`	Query for selecting changes (or snapshots) made on a concrete Entity instance.
`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`	`byInstanceId(java.lang.Object localId, java.lang.String typeName)`	Query for selecting changes (or snapshots) made on a concrete type identified by name.
`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(java.time.LocalDate fromDate)`	delegates to `from(LocalDateTime)` with MIDNIGHT
`QueryBuilder`	`from(java.time.LocalDateTime from)`	Limits to snapshots created after this date or exactly at this date.
`QueryBuilder`	`limit(int limit)`	Limits number of Snapshots to be fetched from JaversRepository in a single query, default is 100.
`QueryBuilder`	`skip(int skip)`	Sets the number of Snapshots to skip.
`QueryBuilder`	`to(java.time.LocalDate toDate)`	delegates to `to(LocalDateTime)` with MIDNIGHT
`QueryBuilder`	`to(java.time.LocalDateTime to)`	Limits to snapshots created before this date or exactly at this date.
`QueryBuilder`	`toCommitId(CommitId commitId)`	Only snapshots created before this commit or exactly in this commit.
`QueryBuilder`	`withChangedProperty(java.lang.String propertyName)`	Only snapshots which changed a given property.
`QueryBuilder`	`withChildValueObjects()`	Only for Snapshot and Changes queries.
`QueryBuilder`	`withChildValueObjects(boolean aggregate)`	Only for Snapshot and Changes queries, see `withChildValueObjects()`
`QueryBuilder`	`withCommitId(java.math.BigDecimal commitId)`	Delegates to `withCommitId(CommitId)`
`QueryBuilder`	`withCommitId(CommitId commitId)`	Only snapshots created in a given commit.
`QueryBuilder`	`withCommitIds(java.util.Collection<java.math.BigDecimal> commitIds)`	Only snapshots created in given commits.
`QueryBuilder`	`withCommitProperty(java.lang.String name, java.lang.String value)`	Only snapshots with a given commit property.
`QueryBuilder`	`withNewObjectChanges()`	Affects changes query only.
`QueryBuilder`	`withNewObjectChanges(boolean newObjectChanges)`	See javadoc in `withNewObjectChanges()`
`QueryBuilder`	`withScopeCommitDeep()`	Selects `ShadowScope.COMMIT_DEEP` for Shadow queries.
`QueryBuilder`	`withScopeCommitDeepPlus()`	Deprecated. renamed to `withScopeDeepPlus()` ()}
`QueryBuilder`	`withScopeCommitDeepPlus(int maxGapsToFill)`	Deprecated. renamed to `withScopeDeepPlus(int)` ()}
`QueryBuilder`	`withScopeDeepPlus()`	Selects `ShadowScope.DEEP_PLUS` with `maxGapsToFill` defaulted to 10.
`QueryBuilder`	`withScopeDeepPlus(int maxGapsToFill)`	Selects `ShadowScope.DEEP_PLUS` with given `maxGapsToFill`.
`QueryBuilder`	`withShadowScope(ShadowScope shadowScope)`	Choose between shallow, child-value-object, commit-deep or deep+ query scopes.
`QueryBuilder`	`withShadowScopeDeep()`	Deprecated.
`QueryBuilder`	`withSnapshotType(SnapshotType snapshotType)`	Selects only snapshots with a given type: initial, update or terminal.
`QueryBuilder`	`withSnapshotTypeUpdate()`	Selects only updating snapshots (without initial ones).
`QueryBuilder`	`withVersion(long version)`	Only snapshots with a given version.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - anyDomainObject
```
public static QueryBuilder anyDomainObject()
```
    Query for selecting changes (or snapshots) made on any object.
    
    For example, last changes committed on any object can be fetched with:
```
 javers.findChanges( QueryBuilder.anyDomainObject().build() );
 
```
    Since:
    
    2.0
  - byClass
```
public static QueryBuilder byClass(java.lang.Class... requiredClasses)
```
    Query for selecting changes (or snapshots) made on any object (Entity or ValueObject) of given classes.
    
    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() );
 
```
  - byInstanceId
```
public static QueryBuilder byInstanceId(java.lang.Object localId,
                                        java.lang.String typeName)
```
    Query for selecting changes (or snapshots) made on a concrete type identified by name.
    
    For example, last changes on "bob" Person:
```
 javers.findChanges( QueryBuilder.byInstanceId("bob", "Person").build() );
 
```
  - byInstance
```
public static QueryBuilder byInstance(java.lang.Object instance)
```
    Query for selecting changes (or snapshots) made on a concrete Entity instance.
    
    For example, last changes on "bob" Person:
```
 javers.findChanges( QueryBuilder.byInstanceId(new Person("bob")).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() );
 
```
  - byGlobalId
```
public static QueryBuilder byGlobalId(GlobalIdDTO globalId)
```
  - withChangedProperty
```
public QueryBuilder withChangedProperty(java.lang.String propertyName)
```
    Only snapshots which changed a given property.
    
    See Also:
    
    CdoSnapshot.getChanged()
  - withNewObjectChanges
```
public QueryBuilder withNewObjectChanges(boolean newObjectChanges)
```
    See javadoc in withNewObjectChanges()
  - withNewObjectChanges
```
public QueryBuilder withNewObjectChanges()
```
    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.
  - withSnapshotType
```
public QueryBuilder withSnapshotType(SnapshotType snapshotType)
```
    Selects only snapshots with a given type: initial, update or terminal.
    
    Typical use case:
```
 javers.findSnapshots(QueryBuilder.byClass(SnapshotEntity)
       .withChangedProperty("someProperty")
       .withSnapshotTypeUpdate().build())
 
```
  - withSnapshotTypeUpdate
```
public QueryBuilder withSnapshotTypeUpdate()
```
    Selects only updating snapshots (without initial ones).
  - withChildValueObjects
```
public QueryBuilder withChildValueObjects(boolean aggregate)
```
    Only for Snapshot and Changes queries, see withChildValueObjects()
    
    Since:
    
    2.1
  - withChildValueObjects
```
public QueryBuilder withChildValueObjects()
```
    Only for Snapshot and Changes queries. When enabled, selects all child ValueObjects owned by selected Entities.
    
    This switch has no effect on Shadow queries because Shadows are always loaded together with their child ValueObjects (see ShadowScope.CHILD_VALUE_OBJECT).
    
    Since:
    
    2.1
    
    See Also:
    
    http://javers.org/documentation/jql-examples
  - limit
```
public QueryBuilder limit(int limit)
```
    Limits number of Snapshots to be fetched from JaversRepository in a single query, default is 100.
    
    Always choose reasonable limits to improve performance of your queries.
  - skip
```
public QueryBuilder skip(int skip)
```
    Sets the number of Snapshots to skip. Use skip() and limit() for paging Snapshots and Changes.
    
    For paging Shadows use Javers.findShadowsAndStream(JqlQuery) with Stream.skip(long) and Stream.limit(long).
  - from
```
public QueryBuilder from(java.time.LocalDateTime from)
```
    Limits to snapshots created after this date or exactly at this date.
    
    CommitDate is local datetime
    Please remember that commitDate is persisted as LocalDateTime (without information about time zone and daylight saving time).
    
    It may affects your query results. For example, once a year when DST ends, one hour is repeated (clock goes back from 3 am to 2 am). Looking just on the commitDate we can't distinct in which iteration of the hour, given commit was made.
    
    See Also:
    
    to(LocalDateTime)
  - to
```
public QueryBuilder to(java.time.LocalDateTime to)
```
    Limits to snapshots created before this date or exactly at this date.
  - withCommitId
```
public QueryBuilder withCommitId(CommitId commitId)
```
    Only snapshots created in a given commit.
  - withCommitId
```
public QueryBuilder withCommitId(java.math.BigDecimal commitId)
```
    Delegates to withCommitId(CommitId)
  - withCommitIds
```
public QueryBuilder withCommitIds(java.util.Collection<java.math.BigDecimal> commitIds)
```
    Only snapshots created in given commits.
  - toCommitId
```
public QueryBuilder toCommitId(CommitId commitId)
```
    Only snapshots created before this commit or exactly in this commit.
  - from
```
public QueryBuilder from(java.time.LocalDate fromDate)
```
    delegates to from(LocalDateTime) with MIDNIGHT
  - to
```
public QueryBuilder to(java.time.LocalDate toDate)
```
    delegates to to(LocalDateTime) with MIDNIGHT
  - withCommitProperty
```
public QueryBuilder withCommitProperty(java.lang.String name,
                                       java.lang.String value)
```
    Only snapshots with a given commit property.
    
    all given properties must match with persisted commit properties.
    
    Since:
    
    2.0
  - withVersion
```
public QueryBuilder withVersion(long version)
```
    Only snapshots with a given version.
  - withShadowScope
```
public QueryBuilder withShadowScope(ShadowScope shadowScope)
```
    Choose between shallow, child-value-object, commit-deep or deep+ query scopes.
    The wider the scope, the more object shadows are loaded to the resulting graph.
    
    Default scope is ShadowScope.SHALLOW.
    
    Read more about query scopes in Javers.findShadows(JqlQuery) javadoc.
    
    Only for Shadow queries.
    
    Since:
    
    3.2
    
    See Also:
    
    http://javers.org/documentation/jql-examples
  - withScopeCommitDeep
```
public QueryBuilder withScopeCommitDeep()
```
    Selects ShadowScope.COMMIT_DEEP for Shadow queries.
    
    Read about query scopes in Javers.findShadows(JqlQuery) javadoc.
    
    Since:
    
    3.5
    
    See Also:
    
    http://javers.org/documentation/jql-examples
  - withScopeDeepPlus
```
public QueryBuilder withScopeDeepPlus()
```
    Selects ShadowScope.DEEP_PLUS with maxGapsToFill defaulted to 10.
    
    Read more about query scopes in Javers.findShadows(JqlQuery) javadoc.
    
    Only for Shadow queries.
    
    Since:
    
    3.5
    
    See Also:
    
    http://javers.org/documentation/jql-examples
  - withScopeDeepPlus
```
public QueryBuilder withScopeDeepPlus(int maxGapsToFill)
```
    Selects ShadowScope.DEEP_PLUS with given maxGapsToFill.
    
    Read more about Shadow query scopes, profiling, and runtime statistics in Javers.findShadows(JqlQuery) javadoc.
    
    Only for Shadow queries.
    
    Parameters:
    
    maxGapsToFill - Limits the number of referenced entity Shadows to be eagerly loaded. The limit is global for a query. When it is exceeded, references to other entities are nulled. Collections of entities may not be fully loaded.
    
    Since:
    
    3.5
    
    See Also:
    
    http://javers.org/documentation/jql-examples
  - withScopeCommitDeepPlus
```
@Deprecated
public QueryBuilder withScopeCommitDeepPlus()
```
    Deprecated.
    renamed to withScopeDeepPlus() ()}
  - withScopeCommitDeepPlus
```
@Deprecated
public QueryBuilder withScopeCommitDeepPlus(int maxGapsToFill)
```
    Deprecated.
    renamed to withScopeDeepPlus(int) ()}
  - byAuthor
```
public QueryBuilder byAuthor(java.lang.String author)
```
    Only snapshots committed by a given author.
    
    Since:
    
    2.0
  - build
```
public JqlQuery build()
```
  - withShadowScopeDeep
```
@Deprecated
public QueryBuilder withShadowScopeDeep()
```
    Deprecated.
    
    renamed to withScopeCommitDeep()
  - andProperty
```
@Deprecated
public QueryBuilder andProperty(java.lang.String propertyName)
```
    Deprecated.
    
    renamed to withChangedProperty(String)

Class QueryBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

anyDomainObject

byClass

byInstanceId

byInstanceId

byInstance

byValueObject

byValueObjectId

byGlobalId

withChangedProperty

withNewObjectChanges

withNewObjectChanges

withSnapshotType

withSnapshotTypeUpdate

withChildValueObjects

withChildValueObjects

limit

skip

from

CommitDate is local datetime

to

withCommitId

withCommitId

withCommitIds

toCommitId

from

to

withCommitProperty

withVersion

withShadowScope

withScopeCommitDeep

withScopeDeepPlus

withScopeDeepPlus

withScopeCommitDeepPlus

withScopeCommitDeepPlus

byAuthor

build

withShadowScopeDeep

andProperty