com.googlecode.genericdao.search

Class ExampleOptions

java.lang.Object

com.googlecode.genericdao.search.ExampleOptions

public class ExampleOptions
extends Object

Use this class to pass options to find by example functionality.

Author:

dwolverton

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANYWHERE
static int	END
static int	EXACT
static int	START

Constructor Summary

Constructors

Constructor and Description
ExampleOptions()

Method Summary

Methods

Modifier and Type	Method and Description
ExampleOptions	excludeProp(String property) Add a property to the excludeProps collection
Collection<String>	getExcludeProps()
int	getLikeMode()
boolean	isExcludeNulls()
boolean	isExcludeZeros()
boolean	isIgnoreCase()
ExampleOptions	setExcludeNulls(boolean excludeNulls) If this is true, all properties with null values will be ignored.
ExampleOptions	setExcludeProps(Collection<String> excludeProps) This is a list of properties to exclude.
ExampleOptions	setExcludeZeros(boolean excludeZeros) If this is true, all properties with the value 0 will be ignored.
ExampleOptions	setIgnoreCase(boolean ignoreCase) If this is true, case is ignored when comparing string values.
ExampleOptions	setLikeMode(int likeMode) This options describes how all string values are compared.

Methods inherited from class java.lang.Object

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

Field Detail

EXACT

public static final int EXACT

See Also:

Constant Field Values

START

public static final int START

See Also:

Constant Field Values

END

public static final int END

See Also:

Constant Field Values

ANYWHERE

public static final int ANYWHERE

See Also:

Constant Field Values

Constructor Detail

ExampleOptions

public ExampleOptions()

Method Detail

excludeProp

public ExampleOptions excludeProp(String property)

Add a property to the excludeProps collection

getExcludeProps

public Collection<String> getExcludeProps()

setExcludeProps

public ExampleOptions setExcludeProps(Collection<String> excludeProps)

This is a list of properties to exclude. For example if a person object is as an example and it is not desirable to filter on the person's parents, the mother and father properties can be excluded by setting this list to contain the strings "mother" and "father".

Default: <none>

isExcludeNulls

public boolean isExcludeNulls()

setExcludeNulls

public ExampleOptions setExcludeNulls(boolean excludeNulls)

If this is true, all properties with null values will be ignored.

Default: true

isExcludeZeros

public boolean isExcludeZeros()

setExcludeZeros

public ExampleOptions setExcludeZeros(boolean excludeZeros)

If this is true, all properties with the value 0 will be ignored.

Default: false

isIgnoreCase

public boolean isIgnoreCase()

setIgnoreCase

public ExampleOptions setIgnoreCase(boolean ignoreCase)

If this is true, case is ignored when comparing string values.

Default: true

getLikeMode

public int getLikeMode()

setLikeMode

public ExampleOptions setLikeMode(int likeMode)

This options describes how all string values are compared. The options are:

• EXACT: The entire strings must match entirely.
• START: The value must start with the example string.
• END: The value must end with the example string.
• ANYWHERE: The value may contain the example string anywhere.

Default: EXACT