Package org.biojava.bio.seq
Class FeatureFilter.FrameFilter
java.lang.Object
org.biojava.bio.seq.FeatureFilter.FrameFilter
- All Implemented Interfaces:
Serializable
,FeatureFilter
,OptimizableFilter
- Enclosing interface:
FeatureFilter
Accept features with a given reading frame.
- Since:
- 1.2
- Author:
- Mark Schreiber
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.biojava.bio.seq.FeatureFilter
FeatureFilter.And, FeatureFilter.AnnotationContains, FeatureFilter.ByAncestor, FeatureFilter.ByAnnotation, FeatureFilter.ByAnnotationType, FeatureFilter.ByChild, FeatureFilter.ByClass, FeatureFilter.ByComponentName, FeatureFilter.ByDescendant, FeatureFilter.ByFeature, FeatureFilter.ByPairwiseScore, FeatureFilter.ByParent, FeatureFilter.BySequenceName, FeatureFilter.BySource, FeatureFilter.ByType, FeatureFilter.ContainedByLocation, FeatureFilter.FrameFilter, FeatureFilter.HasAnnotation, FeatureFilter.Not, FeatureFilter.OnlyChildren, FeatureFilter.OnlyDescendants, FeatureFilter.Or, FeatureFilter.OverlapsLocation, FeatureFilter.ShadowContainedByLocation, FeatureFilter.ShadowOverlapsLocation, FeatureFilter.StrandFilter
-
Field Summary
Fields inherited from interface org.biojava.bio.seq.FeatureFilter
all, leaf, none, top_level
-
Constructor Summary
ConstructorsConstructorDescriptionBuild a new filter that matches all features of a reading frame. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Accept the Feature if it is an instance of FramedFeature and matches the value of getFrame().boolean
getFrame()
Retrieve the reading frame this filter matches.int
hashCode()
boolean
isDisjoint
(FeatureFilter filt) Returns true if this filter is disjoint from filt - that is, there is no Feature that is accepted by both filters.boolean
Returns true if this filter is a proper subset of sup - that is, for every feature that matches this, it also matches sup.
-
Constructor Details
-
FrameFilter
Build a new filter that matches all features of a reading frame.- Parameters:
frame
- the ReadingFrame to match
-
-
Method Details
-
getFrame
Retrieve the reading frame this filter matches. -
accept
Accept the Feature if it is an instance of FramedFeature and matches the value of getFrame().- Specified by:
accept
in interfaceFeatureFilter
- Parameters:
f
- the Feature to check- Returns:
- true if the frame matches, or false otherwise
-
hashCode
-
equals
-
isProperSubset
Description copied from interface:OptimizableFilter
Returns true if this filter is a proper subset of sup - that is, for every feature that matches this, it also matches sup. The empty filter is a proper subset of all filters. All filters are a proper subset of the all filter. All filters are proper subsets of themselves.- Specified by:
isProperSubset
in interfaceOptimizableFilter
- Parameters:
sup
- the potential super set- Returns:
- true if sup contains all features contained by this filter
-
isDisjoint
Description copied from interface:OptimizableFilter
Returns true if this filter is disjoint from filt - that is, there is no Feature that is accepted by both filters. The empty filter is disjoint from all other filters. The all filter is disjoint from none.- Specified by:
isDisjoint
in interfaceOptimizableFilter
-