org.biojava.bio
Class CollectionConstraint.Contains

java.lang.Object
  |
  +--org.biojava.bio.CollectionConstraint.Contains

All Implemented Interfaces:

CollectionConstraint

Enclosing class:

CollectionConstraint

public static class CollectionConstraint.Contains

extends java.lang.Object

implements CollectionConstraint

CollectionConstraint which validates a portion of a Collection. Accepts only collections where the number of members matching the PropertyConstraint is in the supplied cardinality.

A typical application for this would be with Annotations where one property can contain a number of synonyms. CollectionConstraint.Contains could be used as a query to select instances based on one of these synonyms.

Author:

Thomas Down

Nested Class Summary

Nested classes inherited from class org.biojava.bio.CollectionConstraint

CollectionConstraint.AllValuesIn, CollectionConstraint.And, CollectionConstraint.Contains, CollectionConstraint.Or

Field Summary

Fields inherited from interface org.biojava.bio.CollectionConstraint

ANY, EMPTY, NONE

Constructor Summary

CollectionConstraint.Contains(PropertyConstraint pc, Location card)

Method Summary

boolean	accept(java.lang.Object o) accept returns true if the value fulfills the constraint.
boolean	equals(java.lang.Object o)
Location	getCardinalityConstraint()
PropertyConstraint	getPropertyConstraint()
int	hashCode()
boolean	subConstraintOf(CollectionConstraint cc) subConstraintOf returns true if the constraint is a sub-constraint.
java.lang.String	toString()
boolean	validateAddValue(java.util.Collection oldCol, java.lang.Object newValue) Return true iff the Collection formed by adding newValue to current would be accepted by this constraint.
boolean	validateRemoveValue(java.util.Collection oldCol, java.lang.Object newValue) Return true iff the Collection formed by removing newValue from current would be accepted by this constraint.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionConstraint.Contains

public CollectionConstraint.Contains(PropertyConstraint pc,
                                     Location card)

Method Detail

getPropertyConstraint

public PropertyConstraint getPropertyConstraint()

getCardinalityConstraint

public Location getCardinalityConstraint()

accept

public boolean accept(java.lang.Object o)

Description copied from interface: CollectionConstraint

accept returns true if the value fulfills the constraint.

Specified by:

accept in interface CollectionConstraint

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

validateAddValue

public boolean validateAddValue(java.util.Collection oldCol,
                                java.lang.Object newValue)

Description copied from interface: CollectionConstraint

Return true iff the Collection formed by adding newValue to current would be accepted by this constraint.

Specified by:

validateAddValue in interface CollectionConstraint

validateRemoveValue

public boolean validateRemoveValue(java.util.Collection oldCol,
                                   java.lang.Object newValue)

Description copied from interface: CollectionConstraint

Return true iff the Collection formed by removing newValue from current would be accepted by this constraint.

Specified by:

validateRemoveValue in interface CollectionConstraint

subConstraintOf

public boolean subConstraintOf(CollectionConstraint cc)

Description copied from interface: CollectionConstraint

subConstraintOf returns true if the constraint is a sub-constraint.

A pair of constraints super and sub are in a superConstraint/subConstraint relationship if every object accepted by sub is also accepted by super. To put it another way, if instanceOf was used as a set-membership indicator function over some set of objects, then the set produced by super would be a superset of that produced by sub.

It is not expected that constraints will neccesarily maintain references to super/sub types. It will be more usual to infer this relationship by introspecting the constraints themselves. For example, CollectionConstraint.ByClass will infer subConstraintOf by looking at the possible class of all items matching subConstraint.

Specified by:

subConstraintOf in interface CollectionConstraint

Parameters:

cc - a CollectionConstraint to check.

Returns:

a boolean.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object