Class MMSearchFilter

Object
   |
   +--MMSearchFilter

class MMSearchFilter

Defined in MultimapOpenAPI

Field Detail

field

String field

The name of the field to query.

operator

String operator

The operator to be used.

options

String options

Array of options that can be used with eq, contains, startswith, endswith, like, sl, co or com operators. Can also be a comma-separated list.

value

Object value

The value to be used.

MMSearchFilter

MMSearchFilter( <String> field, <String> operator, <Object> value, <String> options )

An object for storing information about a field filter.
Permitted values for operator:
• 'eq' (equals)
• 'lt' (less than)
• 'gt' (greater than)
• 'not' (not)
• 'le' (less than or equal to)
• 'ge' (greater than or equal to)
• 'in' (match against a comma-separated list of values)
• 'null' (value is null)
• 'notnull' (value is not null)
• 'contains'
• 'startswith'
• 'endswith'
• 'like' (partial match) - for example, field like 'hello%'
• 'sl' (sounds like) - implements a SOUNDEX() query
• 'co' (char order) - for example, field co 'hello' "field like '%h%e%l%l%o%'"
• 'com' (compound - see MMSearch#compound_order)

Default: 'eq'
Permitted values for options:
• wildcard_punctuation ("john's cars" will search for "john%s cars")
• remove_punctuation ("john's cars" will search for "johns cars")
• wildcard_space ("john's cars" will search for "john's%cars")
• remove_space ("john's cars" will search for "john'cars")

Default: none
NOTE: If wildcard_punctuation and remove_punctuation, or wildcard_space and remove_space are used together, the wildcard_* option will take precedence

Parameters:
field - The name of the field to query.
operator - The operator to be used.
value - The value to be used.
options - Array of options that can be used with eq, contains, startswith, endswith, like, sl, co or com operators. Can also be a comma-separated list.

copy

MMSearchFilter copy()

Function to return a copy of this object in another object.

Returns:
A new object containing the same data as this object.

toString

String toString()

Function to return a simple string representation of the object.

Returns:
Formatted version of the object as "[field:operator:value:]".