io.spine.client

Class QueryFactory

java.lang.Object

io.spine.client.QueryFactory

public final class QueryFactory
extends java.lang.Object

A factory of Query instances.

Uses the given ActorRequestFactory as a source of the query meta information, such as the actor.

See Also:

ActorRequestFactory.query()

Method Summary

Modifier and Type	Method and Description
io.spine.client.Query	all(java.lang.Class<? extends io.spine.base.EntityState> entityClass) Creates a Query to read all states of a certain entity.
io.spine.client.Query	allWithMask(java.lang.Class<? extends io.spine.base.EntityState> entityClass, java.lang.String... maskPaths) Creates a Query to read all entity states with the FieldMask applied to each of the results.
io.spine.client.Query	byIds(java.lang.Class<? extends io.spine.base.EntityState> entityClass, java.util.Set<?> ids) Creates a Query to read certain entity states by IDs.
io.spine.client.Query	byIdsWithMask(java.lang.Class<? extends io.spine.base.EntityState> entityClass, java.util.Set<?> ids, java.lang.String... maskPaths) Creates a Query to read certain entity states by IDs with the FieldMask applied to each of the results.
QueryBuilder	select(java.lang.Class<? extends io.spine.base.EntityState> targetType) Creates a new instance of QueryBuilder for the further Query construction.

Methods inherited from class java.lang.Object

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

Method Detail

select

public QueryBuilder select(java.lang.Class<? extends io.spine.base.EntityState> targetType)

Creates a new instance of QueryBuilder for the further Query construction.

Parameters:

targetType - the query target type

Returns:

new instance of QueryBuilder

byIdsWithMask

public io.spine.client.Query byIdsWithMask(java.lang.Class<? extends io.spine.base.EntityState> entityClass,
                                           java.util.Set<?> ids,
                                           java.lang.String... maskPaths)

Creates a Query to read certain entity states by IDs with the FieldMask applied to each of the results.

Allows to specify a set of identifiers to be used during the Query processing. The processing results will contain only the entities, which IDs are present among the ids.

Allows to set property paths for a FieldMask applied to each of the query results. This processing is performed according to the FieldMask specs.

If the paths array contains entries inapplicable to the resulting entity (for example a path references a missing field), such invalid paths are silently ignored.

Parameters:

entityClass - the class of a target entity

ids - the IDs of interest of type which is supported as identifier

maskPaths - the property paths for the FieldMask applied to each of the results

Returns:

an instance of Query formed according to the passed parameters

byIds

public io.spine.client.Query byIds(java.lang.Class<? extends io.spine.base.EntityState> entityClass,
                                   java.util.Set<?> ids)

Creates a Query to read certain entity states by IDs.

Allows to specify a set of identifiers to be used during the Query processing. The processing results will contain only the entities which IDs are present among the ids.

Unlike QueryFactory.byIdsWithMask(Class, Set, String...), the Query processing will not change the resulting entities.

Parameters:

entityClass - the class of a target entity

ids - the IDs of interest of type which is supported as identifier

Returns:

an instance of Query formed according to the passed parameters

Throws:

java.lang.IllegalArgumentException - if any of IDs have invalid type or are null

allWithMask

public io.spine.client.Query allWithMask(java.lang.Class<? extends io.spine.base.EntityState> entityClass,
                                         java.lang.String... maskPaths)

Creates a Query to read all entity states with the FieldMask applied to each of the results.

Allows to set property paths for a FieldMask, applied to each of the query results. This processing is performed according to the FieldMask specs.

If the paths array contains entries inapplicable to the resulting entity (e.g. a path references a missing field), such invalid paths are silently ignored.

Parameters:

entityClass - the class of a target entity

maskPaths - the property paths for the FieldMask applied to each of the results

Returns:

an instance of Query formed according to the passed parameters

all

public io.spine.client.Query all(java.lang.Class<? extends io.spine.base.EntityState> entityClass)

Creates a Query to read all states of a certain entity.

Unlike QueryFactory.allWithMask(Class, String...), the Query processing will not change the resulting entities.

Parameters:

entityClass - the class of a target entity

Returns:

an instance of Query formed according to the passed parameters