org.biojavax.bio.db.biosql
Class BioSQLFeatureFilter.ByRank

java.lang.Object
  extended by org.biojavax.bio.db.biosql.BioSQLFeatureFilter.HibernateFeatureFilter
      extended by org.biojavax.bio.db.biosql.BioSQLFeatureFilter.ByRank
All Implemented Interfaces:
Serializable, FeatureFilter, BioSQLFeatureFilter
Enclosing interface:
BioSQLFeatureFilter

public static final class BioSQLFeatureFilter.ByRank
extends BioSQLFeatureFilter.HibernateFeatureFilter

Construct one of these to filter features by rank.

Since:
1.5
Author:
Richard Holland
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.biojavax.bio.db.biosql.BioSQLFeatureFilter
BioSQLFeatureFilter.And, BioSQLFeatureFilter.ByName, BioSQLFeatureFilter.ByNote, BioSQLFeatureFilter.ByNoteTermOnly, BioSQLFeatureFilter.ByRank, BioSQLFeatureFilter.BySequenceName, BioSQLFeatureFilter.BySourceTerm, BioSQLFeatureFilter.BySourceTermName, BioSQLFeatureFilter.ByStrand, BioSQLFeatureFilter.ByTypeTerm, BioSQLFeatureFilter.ByTypeTermName, BioSQLFeatureFilter.ContainedByRichLocation, BioSQLFeatureFilter.HibernateFeatureFilter, BioSQLFeatureFilter.Not, BioSQLFeatureFilter.Or, BioSQLFeatureFilter.OverlapsRichLocation, BioSQLFeatureFilter.Tools
 
Nested classes/interfaces inherited from interface org.biojava.bio.seq.FeatureFilter
FeatureFilter.AnnotationContains, FeatureFilter.ByAncestor, FeatureFilter.ByAnnotation, FeatureFilter.ByAnnotationType, FeatureFilter.ByChild, FeatureFilter.ByClass, FeatureFilter.ByComponentName, FeatureFilter.ByDescendant, FeatureFilter.ByFeature, FeatureFilter.ByPairwiseScore, FeatureFilter.ByParent, FeatureFilter.BySource, FeatureFilter.ByType, FeatureFilter.ContainedByLocation, FeatureFilter.FrameFilter, FeatureFilter.HasAnnotation, FeatureFilter.OnlyChildren, FeatureFilter.OnlyDescendants, FeatureFilter.OverlapsLocation, FeatureFilter.ShadowContainedByLocation, FeatureFilter.ShadowOverlapsLocation, FeatureFilter.StrandFilter
 
Field Summary
 
Fields inherited from class org.biojavax.bio.db.biosql.BioSQLFeatureFilter.HibernateFeatureFilter
and, conjunctAdd, conjunction, disjunctAdd, disjunction, eq, ge, le, not, or
 
Fields inherited from interface org.biojavax.bio.db.biosql.BioSQLFeatureFilter
all, none
 
Fields inherited from interface org.biojava.bio.seq.FeatureFilter
leaf, top_level
 
Constructor Summary
BioSQLFeatureFilter.ByRank(int rank)
          Create a Rank filter that filters in all features with rank fields equal to rank.
 
Method Summary
 boolean accept(Feature f)
          Returns true if the feature has a matching type property.
 Object asCriterion()
          This method returns a Hibernate Criterion object that can be used to query the database.
 boolean equals(Object o)
           
 int getRank()
           
 int hashCode()
           
 String toString()
           
 
Methods inherited from class org.biojavax.bio.db.biosql.BioSQLFeatureFilter.HibernateFeatureFilter
criterionAliasMap
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BioSQLFeatureFilter.ByRank

public BioSQLFeatureFilter.ByRank(int rank)
Create a Rank filter that filters in all features with rank fields equal to rank.

Parameters:
rank - the rank to match type fields against
Method Detail

getRank

public int getRank()

accept

public boolean accept(Feature f)
Returns true if the feature has a matching type property.

Parameters:
f - the Feature to evaluate
Returns:
true if this feature is to be selected in, or false if it is to be ignored

asCriterion

public Object asCriterion()
Description copied from interface: BioSQLFeatureFilter
This method returns a Hibernate Criterion object that can be used to query the database.

Returns:
a Hibernate Criterion object representing this filter.

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object