Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
* @since 2.0
*/
public static QueryBuilder anyDomainObject(){
return new QueryBuilder(new AnyDomainObjectFilterDefinition());
}
/**
* 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:
*
*/
public static QueryBuilder byClass(Class... requiredClasses){
return new QueryBuilder(new ClassFilterDefinition(Sets.asSet(requiredClasses)));
}
/**
* Query for selecting Changes, Snapshots or Shadows for a given Entity instance.
*
*
* @param localId Value of an Id-property. When an Entity has Composite-Id (more than one Id-property) —
* localId should be Map<String, Object> with
* Id-property name to value pairs.
* @see CompositeIdExample.groovy
*/
public static QueryBuilder byInstanceId(Object localId, Class entityClass){
Validate.argumentsAreNotNull(localId, entityClass);
return new QueryBuilder(new IdFilterDefinition(instanceId(localId, entityClass)));
}
/**
* Query for selecting Changes, Snapshots or Shadows for a given Entity instance, identified by its type name.
*
*
* @param localId Value of an Id-property. When an Entity has Composite-Id (more than one Id-property) —
* localId should be Map<String, Object> with
* Id-property name to value pairs.
* @see CompositeIdExample.groovy
*/
public static QueryBuilder byInstanceId(Object localId, String typeName){
Validate.argumentsAreNotNull(localId, typeName);
return new QueryBuilder(new IdAndTypeNameFilterDefinition(localId, typeName));
}
/**
* Query for selecting changes (or snapshots) made on a concrete Entity instance.
*
* @Since 2.8.0
*/
public static QueryBuilder byInstance(Object instance){
Validate.argumentsAreNotNull(instance);
return new QueryBuilder(new InstanceFilterDefinition(instance));
}
/**
* 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 {@link #byValueObjectId(Object, Class, String)}.
*/
public static QueryBuilder byValueObject(Class ownerEntityClass, String path){
Validate.argumentsAreNotNull(ownerEntityClass, path);
return new QueryBuilder(new VoOwnerFilterDefinition(ownerEntityClass, 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:
*
*/
public static QueryBuilder byValueObjectId(Object ownerLocalId, Class ownerEntityClass, String path){
Validate.argumentsAreNotNull(ownerEntityClass, ownerLocalId, path);
return new QueryBuilder(new IdFilterDefinition(ValueObjectIdDTO.valueObjectId(ownerLocalId, ownerEntityClass, path)));
}
@Deprecated
public static QueryBuilder byGlobalId(GlobalIdDTO globalId){
Validate.argumentIsNotNull(globalId);
return new QueryBuilder(new IdFilterDefinition(globalId));
}
/**
* Only snapshots with changes on a given property.
*
* @see CdoSnapshot#getChanged()
*/
public QueryBuilder withChangedProperty(String propertyName) {
Validate.argumentIsNotNull(propertyName);
queryParamsBuilder.changedProperties(asList(propertyName));
return this;
}
/**
* Only snapshots with changes on one or more properties from a given list.
*
* @see CdoSnapshot#getChanged()
*/
public QueryBuilder withChangedPropertyIn(String... propertyNames) {
Validate.argumentIsNotNull(propertyNames);
queryParamsBuilder.changedProperties(asList(propertyNames));
return this;
}
/**
* Since Javers 6.0 this method is deprecated and has no effect.
*
*
* Since Javers 6.0, the newObjectChanges flag is renamed to initialChanges
* and can be set only on a Javers instance level,
* see {@link org.javers.core.JaversBuilder#withInitialChanges(boolean)}.
*/
@Deprecated
public QueryBuilder withNewObjectChanges(boolean newObjectChanges) {
return this;
}
/**
* Since Javers 6.0 this method is deprecated and has no effect.
*
*
* Since Javers 6.0, the newObjectChanges flag is renamed to initialChanges
* and can be set only on a Javers instance level,
* see {@link org.javers.core.JaversBuilder#withInitialChanges(boolean)}.
*/
@Deprecated
public QueryBuilder withNewObjectChanges() {
return this;
}
/**
* Selects only snapshots with a given type: initial, update or terminal.
*
*/
public QueryBuilder withSnapshotType(SnapshotType snapshotType) {
queryParamsBuilder.withSnapshotType(snapshotType);
return this;
}
/**
* Selects only updating snapshots (without initial ones).
*/
public QueryBuilder withSnapshotTypeUpdate() {
queryParamsBuilder.withSnapshotType(SnapshotType.UPDATE);
return this;
}
/**
* Only for Snapshot and Changes queries, see {@link #withChildValueObjects()}
*
* @since 2.1
*/
public QueryBuilder withChildValueObjects(boolean aggregate) {
queryParamsBuilder.withChildValueObjects(aggregate);
return this;
}
/**
* 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 {@link ShadowScope#CHILD_VALUE_OBJECT}).
*
* @since 2.1
* @see http://javers.org/documentation/jql-examples
*/
public QueryBuilder withChildValueObjects() {
queryParamsBuilder.withChildValueObjects(true);
return this;
}
/**
* Should be changed only to improve performance of Shadow queries.
* Please do not confused it with {@link #limit(int)}.
*
*
* Works only with {@link Javers#findShadows(JqlQuery)} and {@link Javers#findShadowsAndStream(JqlQuery)}.
*
* Limits the number of Snapshots to be fetched from a JaversRepository in a single DB query
*
* — 100 by default.
*
* @throws JaversException MALFORMED_JQL if used with {@link Javers#findSnapshots(JqlQuery)} or {@link Javers#findChanges(JqlQuery)}
*/
public QueryBuilder snapshotQueryLimit(Integer snapshotQueryLimit) {
queryParamsBuilder.snapshotQueryLimit(snapshotQueryLimit);
return this;
}
/**
* Limits the number of Snapshots or Shadows to be fetched from a JaversRepository.
* By default, the limit is set to 100.
*
*
* There are four types of JQL query output: List of Changes,
* List of Snapshots, Stream of Shadows, and List of Shadows.
* The limit() filter affects all of them, but in a different way:
*
*
*
*
{@link Javers#findSnapshots(JqlQuery)} — limit() works intuitively,
* it's the maximum size of a returned list.
*
*
{@link Javers#findChanges(JqlQuery)} —
* limit() is applied to
* the Snapshots query, which underlies the Changes query.
* The size of the returned list can be greater than limit(),
* because, typically a difference between any two Snapshots consists of many atomic Changes.
*
*
{@link Javers#findShadows(JqlQuery)} —
* limit() is applied to Shadows,
* it limits the size of the returned list.
* The underlying Snapshots query uses its own limit — {@link QueryBuilder#snapshotQueryLimit(Integer)}.
* Since one Shadow might be reconstructed from many Snapshots,
* when snapshotQueryLimit() is hit, Javers repeats a given Shadow query
* to load a next frame of Shadows until required limit is reached.
*
*
{@link Javers#findShadowsAndStream(JqlQuery)} —
* limit() works like in findShadows(), it limits the size of the returned stream.
* The main difference is that the stream is lazy loaded and subsequent
* frame queries
* are executed gradually, during the stream consumption.
*
*
*
* See
*
* QueryBuilderLimitExamples.groovy
* .
*/
public QueryBuilder limit(int limit) {
queryParamsBuilder.limit(limit);
return this;
}
/**
* Sets the number of Snapshots or Shadows to skip.
* Use skip() and limit() for paging.
*
*
* See {@link #limit(int)}
*/
public QueryBuilder skip(int skip) {
queryParamsBuilder.skip(skip);
return this;
}
/**
* Limits to snapshots created after this date or exactly at this date.
*
* @see CommitMetadata#getCommitDate()
* @see #fromInstant(Instant)}
* @see #to(LocalDateTime)
*/
public QueryBuilder from(LocalDateTime from) {
queryParamsBuilder.from(from);
return this;
}
/**
* Limits to snapshots created after this UTC date or exactly at this UTC date.
*
*
* @see CommitMetadata#getCommitDateInstant()
* @see #toInstant(Instant)
* @see #from(LocalDateTime)
*/
public QueryBuilder fromInstant(Instant fromInstant) {
queryParamsBuilder.fromInstant(fromInstant);
return this;
}
/**
* Limits to snapshots created before this date or exactly at this date.
*
* @see CommitMetadata#getCommitDate()
* @see #toInstant(Instant)}
* @see #from(LocalDateTime)
*/
public QueryBuilder to(LocalDateTime to) {
queryParamsBuilder.to(to);
return this;
}
/**
* Limits to snapshots created before this UTC date or exactly at this UTC date.
*
* @see CommitMetadata#getCommitDateInstant()
* @see #fromInstant(Instant)
* @see #to(LocalDateTime)
*/
public QueryBuilder toInstant(Instant toInstant) {
queryParamsBuilder.toInstant(toInstant);
return this;
}
/**
* Only snapshots created in a given commit.
*/
public QueryBuilder withCommitId(CommitId commitId) {
Validate.argumentIsNotNull(commitId);
queryParamsBuilder.commitId(commitId);
return this;
}
/**
* Delegates to {@link #withCommitId(CommitId)}
*/
public QueryBuilder withCommitId(BigDecimal commitId) {
Validate.argumentIsNotNull(commitId);
queryParamsBuilder.commitId(CommitId.valueOf(commitId));
return this;
}
/**
* Only snapshots created in given commits.
*/
public QueryBuilder withCommitIds(Collection commitIds) {
Validate.argumentIsNotNull(commitIds);
queryParamsBuilder.commitIds(commitIds.stream().map(CommitId::valueOf).collect(Collectors.toSet()));
return this;
}
/**
* Only snapshots created before this commit or exactly in this commit.
*/
public QueryBuilder toCommitId(CommitId commitId) {
Validate.argumentIsNotNull(commitId);
queryParamsBuilder.toCommitId(commitId);
return this;
}
/**
* delegates to {@link #from(LocalDateTime)} with MIDNIGHT
*/
public QueryBuilder from(LocalDate fromDate) {
return from(fromDate.atTime(MIDNIGHT));
}
/**
* delegates to {@link #to(LocalDateTime)} with MIDNIGHT
*/
public QueryBuilder to(LocalDate toDate) {
return to(toDate.atTime(MIDNIGHT));
}
/**
* Only snapshots with a given commit property.
*
all given properties must match with persisted commit properties.
* @since 2.0
*/
public QueryBuilder withCommitProperty(String name, String value) {
Validate.argumentsAreNotNull(name, value);
queryParamsBuilder.commitProperty(name, value);
return this;
}
/**
* Only snapshots with a given version.
*/
public QueryBuilder withVersion(long version) {
Validate.argumentCheck(version > 0, "Version is not a positive number.");
queryParamsBuilder.version(version);
return this;
}
/**
* 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 {@link ShadowScope#SHALLOW}.
*
*
* Read more about query scopes in {@link Javers#findShadows(JqlQuery)} javadoc.
*
*
* Only for Shadow queries.
*
* @see http://javers.org/documentation/jql-examples
* @since 3.2
*/
public QueryBuilder withShadowScope(ShadowScope shadowScope){
Validate.argumentIsNotNull(shadowScope);
this.shadowScope = shadowScope;
if (shadowScope == DEEP_PLUS && maxGapsToFill == 0) {
this.maxGapsToFill = DEFAULT_GAPS_TO_FILL_LIMIT;
}
return this;
}
/**
* Selects {@link ShadowScope#COMMIT_DEEP} for Shadow queries.
*
*
* Read about query scopes in {@link Javers#findShadows(JqlQuery)} javadoc.
*
* @see http://javers.org/documentation/jql-examples
* @since 3.5
*/
public QueryBuilder withScopeCommitDeep() {
return withShadowScope(COMMIT_DEEP);
}
/**
* Selects {@link ShadowScope#DEEP_PLUS}
* with maxGapsToFill defaulted to 10.
*
*
* Read more about query scopes in {@link Javers#findShadows(JqlQuery)} javadoc.
*
*
* Only for Shadow queries.
*
* @see http://javers.org/documentation/jql-examples
* @since 3.5
*/
public QueryBuilder withScopeDeepPlus() {
return withShadowScope(DEEP_PLUS);
}
/**
* Selects {@link ShadowScope#DEEP_PLUS} with given maxGapsToFill.
*
*
* Read more about Shadow query scopes, profiling, and runtime statistics
* in {@link Javers#findShadows(JqlQuery)} javadoc.
*
*
* Only for Shadow queries.
*
* @param 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.
* @see http://javers.org/documentation/jql-examples
* @since 3.5
*/
public QueryBuilder withScopeDeepPlus(int maxGapsToFill) {
this.maxGapsToFill = maxGapsToFill;
return withShadowScope(DEEP_PLUS);
}
/**
* @deprecated renamed to {@link #withScopeDeepPlus()} ()}
*/
@Deprecated
public QueryBuilder withScopeCommitDeepPlus() {
return withScopeDeepPlus();
}
/**
* @deprecated renamed to {@link #withScopeDeepPlus(int)} ()}
*/
@Deprecated
public QueryBuilder withScopeCommitDeepPlus(int maxGapsToFill) {
return withScopeDeepPlus(maxGapsToFill);
}
/**
* Only snapshots committed by a given author.
* @since 2.0
*/
public QueryBuilder byAuthor(String author) {
Validate.argumentIsNotNull(author);
queryParamsBuilder.author(author);
return this;
}
public JqlQuery build() {
return new JqlQuery(filter, queryParamsBuilder.build(), new ShadowScopeDefinition(shadowScope, maxGapsToFill));
}
/**
* renamed to {@link #withScopeCommitDeep()}
* @deprecated
*/
@Deprecated
public QueryBuilder withShadowScopeDeep() {
return withShadowScope(COMMIT_DEEP);
}
/**
* renamed to {@link #withChangedProperty(String)}
* @deprecated
*/
@Deprecated
public QueryBuilder andProperty(String propertyName) {
return withChangedProperty(propertyName);
}
}
