sirius.db.mixing.query.constraints

Class CSVFilter<C extends Constraint>

java.lang.Object

sirius.db.mixing.query.constraints.CSVFilter<C>

Type Parameters:

C - the effective type of constraint generated by this builder

public class CSVFilter<C extends Constraint>
extends Object

Represents a constraint which checks if the given field contains one or all of the values given as a comma separated string. By default the given String will be split on "," and "|" but you can also use customSplitter(String) to split by a custom Regular Expression.

Therefore the constraint translates x,y,z for field f to: f = x OR f = y OR f = z. Empty strings are gracefully handled (ignored). If orEmpty() is used, the constraint also succeeds if the target field is empty. This is only valid when containsAny is used.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CSVFilter.Mode Specifies the matching mode for a filter.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	commaSeparatedValues
protected static String	DEFAULT_SPLITTER
protected FilterFactory<C>	factory
protected Mapping	field
protected boolean	lowercaseValues
protected CSVFilter.Mode	mode
protected boolean	orEmpty
protected String	splitter
protected boolean	uppercaseValues

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CSVFilter(FilterFactory<C> factory, Mapping field, String value, CSVFilter.Mode mode)

Method Summary

Modifier and Type	Method and Description
C	build() Generates the effective constraint.
protected List<String>	collectValues()
CSVFilter<C>	customSplitter(String customSplitter) Signals that this constraint should split the give values String using the given Regular Expression
CSVFilter<C>	lowercaseValues() Signals that this constraint should convert the values to lowercase before being applied
CSVFilter<C>	orEmpty() Signals the constraint to also accept an empty target field if containsAny is used.
CSVFilter<C>	uppercaseValues() Signals that this constraint should convert the values to uppercase before being applied

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SPLITTER

protected static final String DEFAULT_SPLITTER

See Also:

Constant Field Values

factory

protected FilterFactory<C extends Constraint> factory

field

protected final Mapping field

orEmpty

protected boolean orEmpty

mode

protected CSVFilter.Mode mode

commaSeparatedValues

protected String commaSeparatedValues

splitter

protected String splitter

lowercaseValues

protected boolean lowercaseValues

uppercaseValues

protected boolean uppercaseValues

Constructor Detail

CSVFilter

protected CSVFilter(FilterFactory<C> factory,
                    Mapping field,
                    String value,
                    CSVFilter.Mode mode)

Method Detail

lowercaseValues

public CSVFilter<C> lowercaseValues()

Signals that this constraint should convert the values to lowercase before being applied

Returns:

the constraint itself for fluent method calls

uppercaseValues

public CSVFilter<C> uppercaseValues()

Signals that this constraint should convert the values to uppercase before being applied

Returns:

the constraint itself for fluent method calls

customSplitter

public CSVFilter<C> customSplitter(String customSplitter)

Signals that this constraint should split the give values String using the given Regular Expression

Parameters:

customSplitter - a Regular Expression used to split

Returns:

the constraint itself for fluent method calls

orEmpty

public CSVFilter<C> orEmpty()

Signals the constraint to also accept an empty target field if containsAny is used.

Returns:

the constraint itself for fluent method calls

build

public C build()

Generates the effective constraint.

Returns:

the constraint to be added to a Query.

collectValues

protected List<String> collectValues()