ModelQueryFilter class

Definition class for filtering data.

You can use ModelQueryFilter.equal to filter only elements whose value matches the value for key.

You can use ModelQueryFilter.notEqual to filter only those elements whose value does not match the value for key.

ModelQueryFilter.lessThanOrEqual to filter only elements whose value for key is less than value.

ModelQueryFilter.greaterThanOrEqual to filter only elements whose value for key is greater than value.

You can use ModelQueryFilter.contains to filter only those elements whose value is contained in the array for key.

You can use ModelQueryFilter.containsAny to filter only elements whose array for key contains one of the values in value.

You can use ModelQueryFilter.where to filter only those elements in the value array that contain one of the values for key.

You can use ModelQueryFilter.notWhere to filter only those elements in the value array that do not contain any of the values for key.

ModelQueryFilter.isNull and ModelQueryFilter.isNotNull allow you to filter only elements that are null or not null for values for key.

You can use ModelQueryFilter.geo to filter only those elements that contain location information for key within the range of the value array.

You can use ModelQueryFilter.like to filter only those elements whose text for key contains the text for value.

Sort ascending order on the elements of key with ModelQueryFilter.orderByAsc.

Sort in descending order on the elements of key in ModelQueryFilter.orderByDesc.

Limit the number of elements to value with ModelQueryFilter.limitTo.

Specify a condition by giving it to ModelQuery.filters. Multiple conditions will result in an AND condition.

データのフィルターをかけるための定義クラス。

ModelQueryFilter.equalでkeyに対する値とvalueが一致する要素のみをフィルタリングすることができます。

ModelQueryFilter.notEqualでkeyに対する値とvalueが一致しない要素のみをフィルタリングすることができます。

ModelQueryFilter.lessThan、ModelQueryFilter.lessThanOrEqualでkeyに対する値がvalueより小さい要素のみをフィルタリングすることができます。

ModelQueryFilter.greaterThan、ModelQueryFilter.greaterThanOrEqualでkeyに対する値がvalueより大きい要素のみをフィルタリングすることができます。

ModelQueryFilter.containsでkeyに対する配列にvalueが含まれる要素のみをフィルタリングすることができます。

ModelQueryFilter.containsAnyでkeyに対する配列にvalueの値のいずれかが含まれる要素のみをフィルタリングすることができます。

ModelQueryFilter.whereでvalueの配列にkeyに対する値のいずれかが含まれる要素のみをフィルタリングすることができます。

ModelQueryFilter.notWhereでvalueの配列にkeyに対する値のいずれも含まれない要素のみをフィルタリングすることができます。

ModelQueryFilter.isNull、ModelQueryFilter.isNotNullでkeyに対する値に対してNullかそうではない要素のみをフィルタリングすることができます。

ModelQueryFilter.geoでvalueの配列の範囲内にkeyに対する位置情報が含まれる要素のみをフィルタリングすることができます。

ModelQueryFilter.likeでkeyに対するテキストにvalueのテキストが含まれる要素のみをフィルタリングすることができます。

ModelQueryFilter.orderByAscでkeyの要素に対して昇順でソートをかけます。

ModelQueryFilter.orderByDescでkeyの要素に対して降順でソートをかけます。

ModelQueryFilter.limitToで要素をvalueの数に制限します。

ModelQuery.filtersに与えることで条件を指定します。複数与えるとAND条件になります。

Available Extensions

• FutureIndicatorExtensions

Constructors

ModelQueryFilter.contains({required String key, required Object value})

You can filter only those elements whose value is contained in the array for key.

const

ModelQueryFilter.containsAny({required String key, required List<Object> values})

Only elements whose array for key contains one of the values in values can be filtered.

const

ModelQueryFilter.equal({required String key, required Object value})

You can filter only those elements for which the value for key matches the value for value.

const

ModelQueryFilter.geo({required String key, required List<GeoValue> geoValues})

Only elements that contain positional information for key within the range of the geoValues array can be filtered.

const

ModelQueryFilter.greaterThan({required String key, required Object value})

Only elements whose value for key is greater than value can be filtered.

const

ModelQueryFilter.greaterThanOrEqual({required String key, required Object value})

Only elements whose value for key is greater than value (including equal values) can be filtered.

const

ModelQueryFilter.isNotNull({required String key})

Only elements whose value for key is not Null can be filtered.

const

ModelQueryFilter.isNull({required String key})

Only elements with a value of Null for key can be filtered.

const

ModelQueryFilter.lessThan({required String key, required Object value})

Only elements whose value for key is less than value can be filtered.

const

ModelQueryFilter.lessThanOrEqual({required String key, required Object value})

Only elements whose value for key is less than value (including equal values) can be filtered.

const

ModelQueryFilter.like({required String key, required String text})

You can filter only elements that contain the text of text in the text for key.

const

ModelQueryFilter.limitTo({required int value})

Limit the number of elements to value.

const

ModelQueryFilter.notEqual({required String key, required Object value})

You can filter only those elements whose value for key does not match the value for value.

const

ModelQueryFilter.notifyDocumentChanges()

Ensure that the collection is notified of changes to internal documents.

const

ModelQueryFilter.notWhere({required String key, required List<Object> values})

You can filter only those elements in the values array that do not contain any of the values for key.

const

ModelQueryFilter.orderByAsc({required String key})

Sort ascending order on the elements of key.

const

ModelQueryFilter.orderByDesc({required String key})

Sort descending order on the elements of key.

const

ModelQueryFilter.where({required String key, required List<Object> values})

You can filter only those elements in the values array that contain one of the values for key.

const

Properties

hashCode → int

The hash code for this object.

no setter, override

key → String?

Specify the key(s) to be filtered.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

type → ModelQueryFilterType

The filter condition specified in ModelQueryFilter is defined in ModelQueryFilterType.

final

value → Object?

Specify the value to be the target of the filter condition.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → DynamicMap

ModelQueryFilter is converted to Map.

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override