Package org.gbif.api.model.predicate

Class InPredicate<S extends SearchParameter>

java.lang.Object

org.gbif.api.model.predicate.InPredicate<S>

All Implemented Interfaces:

Serializable, Predicate

public class InPredicate<S extends SearchParameter>
extends Object
implements Predicate

This predicate checks if its key contains any of its values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
InPredicate(S key, Collection<String> values, Boolean matchCase)
InPredicate(S key, Collection<String> values, Boolean matchCase, String checklistKey)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Experimental String	getChecklistKey()
S	getKey()
Collection<String>	getValues()
int	hashCode()
@Experimental Boolean	isMatchCase()	This flag enables the use of case-sensitive matches and aggregations on certain search parameters.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InPredicate

public InPredicate(S key,
                   Collection<String> values,
                   Boolean matchCase)

InPredicate

public InPredicate(S key,
                   Collection<String> values,
                   @Nullable
                   Boolean matchCase,
                   @Nullable
                   String checklistKey)

Method Detail

getKey

public S getKey()

getValues

public Collection<String> getValues()

isMatchCase

@Experimental
public @Experimental Boolean isMatchCase()

This flag enables the use of case-sensitive matches and aggregations on certain search parameters.

Fields that support this feature are: occurrenceId, recordedBy, samplingProtocol, catalogNumber, collectionCode, institutionCode, eventId, parentEventId, waterBody, stateProvince, recordNumber, identifiedBy, organismId and locality.

This is an experimental feature and its implementation map change or be removed at any time.

getChecklistKey

@Experimental
public @Experimental String getChecklistKey()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object