Package org.biojava.bio.seq.projection
Class ProjectedFeatureHolder
java.lang.Object
org.biojava.utils.AbstractChangeable
org.biojava.bio.seq.AbstractFeatureHolder
org.biojava.bio.seq.projection.ProjectedFeatureHolder
- All Implemented Interfaces:
Serializable,FeatureHolder,Changeable
public final class ProjectedFeatureHolder
extends AbstractFeatureHolder
implements FeatureHolder, Serializable
Helper class for projecting Feature objects into an alternative
coordinate system. This class offers a view onto a set of features,
projecting them into a different coordinate system, and also changing
their
parent property. The destination coordinate system
can run in the opposite direction from the source, in which case the
strand property of StrandedFeatures is flipped.
The projected features returned by this class are small proxy objects.
Proxy classes are autogenerated on demand for any sub-interface of
Feature by the ProjectionEngine class.
- Since:
- 1.1
- Author:
- Thomas Down, Matthew Pocock
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.biojava.bio.seq.FeatureHolder
FeatureHolder.EmptyFeatureHolder -
Field Summary
Fields inherited from interface org.biojava.bio.seq.FeatureHolder
EMPTY_FEATURE_HOLDER, FEATURES, SCHEMA -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanCheck if the feature is present in this holder.intCount how many features are contained.createFeature(Feature.Template templ) Create a new Feature, and add it to this FeatureHolder.features()Iterate over the features in no well defined order.filter(FeatureFilter ff) Query this set of features using a suppliedFeatureFilter.filter(FeatureFilter ff, boolean recurse) Return a new FeatureHolder that contains all of the children of this one that passed the filter fc.protected ChangeEventCalled internally to generate a forwarded version of a ChangeEvent from our underlying FeatureHolderReturn a schema-filter for thisFeatureHolder.protected FeatureHolderCalled internally to construct a lightweight projected view of a set of featuresvoidremoveFeature(Feature dyingChild) Remove a feature from this FeatureHolder.Methods inherited from class org.biojava.utils.AbstractChangeable
addChangeListener, addChangeListener, generateChangeSupport, getChangeSupport, hasListeners, hasListeners, isUnchanging, removeChangeListener, removeChangeListenerMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.biojava.utils.Changeable
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener
-
Constructor Details
-
ProjectedFeatureHolder
-
-
Method Details
-
getContext
-
features
Description copied from interface:FeatureHolderIterate over the features in no well defined order.- Specified by:
featuresin interfaceFeatureHolder- Returns:
- an Iterator
-
countFeatures
Description copied from interface:FeatureHolderCount how many features are contained.- Specified by:
countFeaturesin interfaceFeatureHolder- Returns:
- a positive integer or zero, equal to the number of features contained
-
containsFeature
Description copied from interface:FeatureHolderCheck if the feature is present in this holder.- Specified by:
containsFeaturein interfaceFeatureHolder- Parameters:
f- the Feature to check- Returns:
- true if f is in this set
-
filter
Description copied from interface:FeatureHolderQuery this set of features using a suppliedFeatureFilter.- Specified by:
filterin interfaceFeatureHolder- Overrides:
filterin classAbstractFeatureHolder- Parameters:
ff- theFeatureFilterto apply.- Returns:
- all features in this container which match
filter.
-
filter
Description copied from interface:FeatureHolderReturn a new FeatureHolder that contains all of the children of this one that passed the filter fc. This method is scheduled for deprecation. Use the 1-arg filter instead.- Specified by:
filterin interfaceFeatureHolder- Overrides:
filterin classAbstractFeatureHolder- Parameters:
ff- the FeatureFilter to applyrecurse- true if all features-of-features should be scanned, and a single flat collection of features returned, or false if just immediate children should be filtered.
-
createFeature
Description copied from interface:FeatureHolderCreate a new Feature, and add it to this FeatureHolder. This method will generally only work on Sequences, and on some Features which have been attached to Sequences.- Specified by:
createFeaturein interfaceFeatureHolder- Overrides:
createFeaturein classAbstractFeatureHolder- Throws:
ChangeVetoException- if this FeatureHolder does not support creation of new features, or if the change was vetoedBioException- if something went wrong during creating the feature
-
removeFeature
Description copied from interface:FeatureHolderRemove a feature from this FeatureHolder.- Specified by:
removeFeaturein interfaceFeatureHolder- Overrides:
removeFeaturein classAbstractFeatureHolder- Throws:
ChangeVetoException- if this FeatureHolder does not support feature removal or if the change was vetoedBioException- if there was an error removing the feature
-
getSchema
Description copied from interface:FeatureHolderReturn a schema-filter for thisFeatureHolder. This is a filter which allFeatures immediately contained by thisFeatureHolderwill match. It need not directly match their child features, but it can (and should!) provide information about them usingFeatureFilter.OnlyChildrenfilters. In cases where there is no feature hierarchy, this can be indicated by includingFeatureFilter.leafin the schema filter.For the truly non-informative case, it is possible to return
FeatureFilter.all. However, it is almost always possible to provide slightly more information that this. For example,Sequenceobjects should, at a minimum, returnFeatureFilter.top_level.Featureobjects should, as a minimum, returnFeatureFilter.ByParent(new FeatureFilter.ByFeature(this)).- Specified by:
getSchemain interfaceFeatureHolder- Returns:
- the schema filter
-
makeProjectionSet
Called internally to construct a lightweight projected view of a set of features -
forwardChangeEvent
Called internally to generate a forwarded version of a ChangeEvent from our underlying FeatureHolder
-