org.biojava.bio.seq

Class FeatureFilter.ByAncestor

java.lang.Object

org.biojava.bio.seq.FeatureFilter.ByAncestor

All Implemented Interfaces:

java.io.Serializable, FeatureFilter, OptimizableFilter

Enclosing interface:

FeatureFilter

public static class FeatureFilter.ByAncestor
extends java.lang.Object
implements OptimizableFilter

Filter by applying a nested FeatureFilter to all ancestor features. Returns true if at least one of them matches the filter. Always false if the parent is not a feature (e.g. top-level features, where the parent is a sequence).

Since:

1.2

Author:

Thomas Down

See Also:

Serialized Form

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

Constructors

Constructor and Description
ByAncestor(FeatureFilter ff)

Method Summary

Modifier and Type	Method and Description
boolean	accept(Feature f) This method determines whether a feature is to be accepted.
boolean	equals(java.lang.Object o)
FeatureFilter	getFilter()
int	hashCode()
boolean	isDisjoint(FeatureFilter ff) Returns true if this filter is disjoint from filt - that is, there is no Feature that is accepted by both filters.
boolean	isProperSubset(FeatureFilter ff) Returns true if this filter is a proper subset of sup - that is, for every feature that matches this, it also matches sup.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ByAncestor

public ByAncestor(FeatureFilter ff)

Method Detail

getFilter

public FeatureFilter getFilter()

accept

public boolean accept(Feature f)

Description copied from interface: FeatureFilter

This method determines whether a feature is to be accepted.

Specified by:

accept in interface FeatureFilter

Parameters:

f - the Feature to evaluate

Returns:

true if this feature is to be selected in, or false if it is to be ignored

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

isProperSubset

public boolean isProperSubset(FeatureFilter ff)

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 interface OptimizableFilter

Parameters:

ff - the potential super set

Returns:

true if sup contains all features contained by this filter

isDisjoint

public boolean isDisjoint(FeatureFilter ff)

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 interface OptimizableFilter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object