org.springframework.data.mongodb.core.query

Class UntypedExampleMatcher

java.lang.Object

org.springframework.data.mongodb.core.query.UntypedExampleMatcher

All Implemented Interfaces:

ExampleMatcher

public class UntypedExampleMatcher
extends Object
implements ExampleMatcher

ExampleMatcher implementation for query by example (QBE). Unlike plain ExampleMatcher this untyped counterpart does not enforce type matching when executing the query. This allows to query unrelated example documents as references for querying collections as long as the used field/property names match.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.domain.ExampleMatcher

ExampleMatcher.GenericPropertyMatcher, ExampleMatcher.GenericPropertyMatchers, ExampleMatcher.MatcherConfigurer<T>, ExampleMatcher.MatchMode, ExampleMatcher.NoOpPropertyValueTransformer, ExampleMatcher.NullHandler, ExampleMatcher.PropertySpecifier, ExampleMatcher.PropertySpecifiers, ExampleMatcher.PropertyValueTransformer, ExampleMatcher.StringMatcher

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ExampleMatcher.StringMatcher	getDefaultStringMatcher()
Set<String>	getIgnoredPaths()
ExampleMatcher.MatchMode	getMatchMode()
ExampleMatcher.NullHandler	getNullHandler()
ExampleMatcher.PropertySpecifiers	getPropertySpecifiers()
int	hashCode()
boolean	isAllMatching()
boolean	isAnyMatching()
boolean	isIgnoreCaseEnabled()
boolean	isIgnoredPath(String path)
static UntypedExampleMatcher	matching()
static UntypedExampleMatcher	matchingAll()
static UntypedExampleMatcher	matchingAny()
UntypedExampleMatcher	withIgnoreCase()
UntypedExampleMatcher	withIgnoreCase(boolean defaultIgnoreCase)
UntypedExampleMatcher	withIgnoreCase(String... propertyPaths)
UntypedExampleMatcher	withIgnoreNullValues()
UntypedExampleMatcher	withIgnorePaths(String... ignoredPaths)
UntypedExampleMatcher	withIncludeNullValues()
UntypedExampleMatcher	withMatcher(String propertyPath, ExampleMatcher.GenericPropertyMatcher genericPropertyMatcher)
UntypedExampleMatcher	withMatcher(String propertyPath, ExampleMatcher.MatcherConfigurer<ExampleMatcher.GenericPropertyMatcher> matcherConfigurer)
UntypedExampleMatcher	withNullHandler(ExampleMatcher.NullHandler nullHandler)
UntypedExampleMatcher	withStringMatcher(ExampleMatcher.StringMatcher defaultStringMatcher)
UntypedExampleMatcher	withTransformer(String propertyPath, ExampleMatcher.PropertyValueTransformer propertyValueTransformer)

Methods inherited from class java.lang.Object

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

Method Detail

matching

public static UntypedExampleMatcher matching()

Specified by:

matching in interface ExampleMatcher

matchingAny

public static UntypedExampleMatcher matchingAny()

Specified by:

matchingAny in interface ExampleMatcher

matchingAll

public static UntypedExampleMatcher matchingAll()

Specified by:

matchingAll in interface ExampleMatcher

withIgnorePaths

public UntypedExampleMatcher withIgnorePaths(String... ignoredPaths)

Specified by:

withIgnorePaths in interface ExampleMatcher

withStringMatcher

public UntypedExampleMatcher withStringMatcher(ExampleMatcher.StringMatcher defaultStringMatcher)

Specified by:

withStringMatcher in interface ExampleMatcher

withIgnoreCase

public UntypedExampleMatcher withIgnoreCase()

Specified by:

withIgnoreCase in interface ExampleMatcher

withIgnoreCase

public UntypedExampleMatcher withIgnoreCase(boolean defaultIgnoreCase)

Specified by:

withIgnoreCase in interface ExampleMatcher

withMatcher

public UntypedExampleMatcher withMatcher(String propertyPath,
                                         ExampleMatcher.MatcherConfigurer<ExampleMatcher.GenericPropertyMatcher> matcherConfigurer)

Specified by:

withMatcher in interface ExampleMatcher

withMatcher

public UntypedExampleMatcher withMatcher(String propertyPath,
                                         ExampleMatcher.GenericPropertyMatcher genericPropertyMatcher)

Specified by:

withMatcher in interface ExampleMatcher

withTransformer

public UntypedExampleMatcher withTransformer(String propertyPath,
                                             ExampleMatcher.PropertyValueTransformer propertyValueTransformer)

Specified by:

withTransformer in interface ExampleMatcher

withIgnoreCase

public UntypedExampleMatcher withIgnoreCase(String... propertyPaths)

Specified by:

withIgnoreCase in interface ExampleMatcher

withIncludeNullValues

public UntypedExampleMatcher withIncludeNullValues()

Specified by:

withIncludeNullValues in interface ExampleMatcher

withIgnoreNullValues

public UntypedExampleMatcher withIgnoreNullValues()

Specified by:

withIgnoreNullValues in interface ExampleMatcher

withNullHandler

public UntypedExampleMatcher withNullHandler(ExampleMatcher.NullHandler nullHandler)

Specified by:

withNullHandler in interface ExampleMatcher

getNullHandler

public ExampleMatcher.NullHandler getNullHandler()

Specified by:

getNullHandler in interface ExampleMatcher

getDefaultStringMatcher

public ExampleMatcher.StringMatcher getDefaultStringMatcher()

Specified by:

getDefaultStringMatcher in interface ExampleMatcher

isIgnoreCaseEnabled

public boolean isIgnoreCaseEnabled()

Specified by:

isIgnoreCaseEnabled in interface ExampleMatcher

isIgnoredPath

public boolean isIgnoredPath(String path)

Specified by:

isIgnoredPath in interface ExampleMatcher

getIgnoredPaths

public Set<String> getIgnoredPaths()

Specified by:

getIgnoredPaths in interface ExampleMatcher

getPropertySpecifiers

public ExampleMatcher.PropertySpecifiers getPropertySpecifiers()

Specified by:

getPropertySpecifiers in interface ExampleMatcher

isAllMatching

public boolean isAllMatching()

Specified by:

isAllMatching in interface ExampleMatcher

isAnyMatching

public boolean isAnyMatching()

Specified by:

isAnyMatching in interface ExampleMatcher

getMatchMode

public ExampleMatcher.MatchMode getMatchMode()

Specified by:

getMatchMode in interface ExampleMatcher

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object