io.spine.server.entity.storage

Class EntityQuery<I>

java.lang.Object

io.spine.server.entity.storage.EntityQuery<I>

Type Parameters:

I - the type of the IDs of the query target

public final class EntityQuery<I>
extends java.lang.Object

A query to a RecordStorage for the records matching the given parameters.

Acts like a DTO between the repository and the RecordStorage.

The query contains the acceptable values of the record IDs and the entity columns.

A storage may ignore the query or throw an exception if it's specified. By default, RecordStorage supports the Entity queries.

If the accepted IDs set is empty, all the IDs are considered to be queried.

Empty query parameters are not considered when the actual data query is performed as well as the parameters which have no accepted values.

If the Column specified in the query is absent in a record, the record is considered not matching.

If both the accepted IDs set and query parameters are empty, all the records are considered matching.

If the query specifies the values of the Entity lifecycle Columns, then the default behavior will be overridden meaning that the records resulting to such query may active or inactive.

See Also:

EntityRecordWithColumns

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.Set<I>	getIds() Obtains an immutable set of accepted ID values.
QueryParameters	getParameters() Obtains a Map of the Column metadata to the column required value.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getIds

public java.util.Set<I> getIds()

Obtains an immutable set of accepted ID values.

getParameters

public QueryParameters getParameters()

Obtains a Map of the Column metadata to the column required value.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object