net.sf.mmm.util.search.base

Class AbstractSearchCriteria

java.lang.Object

net.sf.mmm.util.transferobject.api.AbstractTransferObject

net.sf.mmm.util.search.base.AbstractSearchCriteria

All Implemented Interfaces:

Serializable, Cloneable, Entity, SearchCriteria, TransferObject

public abstract class AbstractSearchCriteria
extends AbstractTransferObject
implements SearchCriteria

This is the abstract base implementation of SearchCriteria.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private int	hitOffset
private Integer	maximumHitCount
private boolean	readOnly
private Long	searchTimeout
private static long	serialVersionUID UID for serialization.

Constructor Summary

Constructors

Constructor and Description
AbstractSearchCriteria() The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getHitOffset() This method gets the offset for the first hit.
Integer	getMaximumHitCount() This method gets the maximum number of hits that will be received as result for this query.
Long	getSearchTimeout() This method gets the maximum delay in milliseconds the search may last until it is canceled.
int	hashCode()
boolean	isReadOnly() This method determines if the search should be performed in read-only mode.
void	limitMaximumHitCount(int limit) Limits the maximum hit count by the given limit.
void	setHitOffset(int hitOffset)
void	setMaximumHitCount(Integer maximumHitCount)
void	setReadOnly(boolean readOnly)
void	setSearchTimeout(Long searchTimeout)

Methods inherited from class net.sf.mmm.util.transferobject.api.AbstractTransferObject

clone, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

maximumHitCount

private Integer maximumHitCount

See Also:

getMaximumHitCount()

hitOffset

private int hitOffset

See Also:

getHitOffset()

searchTimeout

private Long searchTimeout

See Also:

getSearchTimeout()

readOnly

private boolean readOnly

See Also:

isReadOnly()

Constructor Detail

AbstractSearchCriteria

public AbstractSearchCriteria()

The constructor.

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTransferObject

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractTransferObject

getMaximumHitCount

public Integer getMaximumHitCount()

This method gets the maximum number of hits that will be received as result for this query.
Note:
This feature is the same as Query.setMaxResults(int) in JPA.

Specified by:

getMaximumHitCount in interface SearchCriteria

Returns:

the maximum hit-count or null for NO limit.

getHitOffset

public int getHitOffset()

This method gets the offset for the first hit. This is 0 by default. By providing a multiple of SearchCriteria.getMaximumHitCount() you can simply implement paging.
Note:
This feature is the same as Query.setFirstResult(int) in JPA.

Specified by:

getHitOffset in interface SearchCriteria

Returns:

the offset of the first hit.

getSearchTimeout

public Long getSearchTimeout()

This method gets the maximum delay in milliseconds the search may last until it is canceled.
Note:
This feature is the same as the query hint "javax.persistence.query.timeout" in JPA.

Specified by:

getSearchTimeout in interface SearchCriteria

Returns:

the search timeout in milliseconds or null for NO timeout.

setMaximumHitCount

public void setMaximumHitCount(Integer maximumHitCount)

Parameters:

maximumHitCount - is the new value of getMaximumHitCount().

setHitOffset

public void setHitOffset(int hitOffset)

Parameters:

hitOffset - is the new value of getHitOffset().

setSearchTimeout

public void setSearchTimeout(Long searchTimeout)

Parameters:

searchTimeout - is the new value of getSearchTimeout().

isReadOnly

public boolean isReadOnly()

This method determines if the search should be performed in read-only mode. In such case the result hits can NOT be modified or their changes will NOT be persisted. If a search-engine does not support this feature (e.g. for full-text search this makes no sense), it will be ignored.

Specified by:

isReadOnly in interface SearchCriteria

Returns:

true if read-only, false otherwise (default).

setReadOnly

public void setReadOnly(boolean readOnly)

Parameters:

readOnly - is the new value of isReadOnly().

limitMaximumHitCount

public void limitMaximumHitCount(int limit)

Limits the maximum hit count by the given limit. If current maximum hit count is null or greater than the given limit, the value is replaced by limit.

Parameters:

limit - is the maximum allowed value for maximum hit count.

Since:

6.0.0