org.kuali.rice.core.api.criteria
Class AbstractCompositePredicate

java.lang.Object
  org.kuali.rice.core.api.criteria.AbstractPredicate
      org.kuali.rice.core.api.criteria.AbstractCompositePredicate

All Implemented Interfaces:

Serializable, CompositePredicate, Predicate, ModelObjectBasic, ModelObjectComplete

Direct Known Subclasses:

AndPredicate, OrPredicate

abstract class AbstractCompositePredicate
extends AbstractPredicate
implements CompositePredicate

An abstract implementation of a CompositePredicate. This class defines all of the JAXB annotations such that sub-classes should not have to.

If a class subclasses this class then it *MUST* be sure to add itself to the JAXB annotations for predicates

Author:

Kuali Rice Team (rice.collab@kuali.org)

Nested Class Summary

(package private) static class

AbstractCompositePredicate.Constants Defines some internal constants used on this class.

Field Summary

private Set<Predicate>	predicates Defines the JAXB annotations for the List of predicates.
private static long	serialVersionUID

Constructor Summary

AbstractCompositePredicate()
This default constructor exists only to be invoked by sub-classes in their default constructors which is used by JAXB.

AbstractCompositePredicate(Set<Predicate> predicates)
When invoked by a subclass, this constructor will set the predicates to the given set.

Method Summary

Set<Predicate>

getPredicates() Returns an unmodifiable set of predicates contained within this composite predicate.

Methods inherited from class org.kuali.rice.core.api.criteria.AbstractPredicate

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectComplete

equals, hashCode

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

predicates

private final Set<Predicate> predicates

Defines the JAXB annotations for the List of predicates. All supported predicates *MUST* be included in this List in order for them to be supported in the XML schema. If a new type of predicate is created it *MUST* be added to this list.

Constructor Detail

AbstractCompositePredicate

AbstractCompositePredicate()

This default constructor exists only to be invoked by sub-classes in their default constructors which is used by JAXB.

AbstractCompositePredicate

AbstractCompositePredicate(Set<Predicate> predicates)

When invoked by a subclass, this constructor will set the predicates to the given set. If the set is null then it will be translated internally to an empty set.

Parameters:

predicates - the list of predicates to set

Method Detail

getPredicates

public Set<Predicate> getPredicates()

Description copied from interface: CompositePredicate

Returns an unmodifiable set of predicates contained within this composite predicate. This set could be empty but should never be null.

Specified by:

getPredicates in interface CompositePredicate

Returns:

the set of predicates contained within this composite