Package org.biojava.bio.seq
Class SimpleFeatureHolder
java.lang.Object
org.biojava.utils.AbstractChangeable
org.biojava.bio.seq.AbstractFeatureHolder
org.biojava.bio.seq.SimpleFeatureHolder
- All Implemented Interfaces:
Serializable,FeatureHolder,Changeable
A no-frills implementation of FeatureHolder.
- Author:
- Matthew Pocock, Thomas Down
- 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
ConstructorsConstructorDescriptionConstruct a new SimpleFeatureHolder with a non-informative schema.SimpleFeatureHolder(FeatureFilter schema) Construct a new SimpleFeatureHolder with the specified schema. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a feature to the featureholderbooleanCheck if the feature is present in this holder.intCount how many features are contained.features()Iterate over the features in no well defined order.protected ListReturns the list of features in this featureholder.Return a schema-filter for thisFeatureHolder.voidRemove a feature from this FeatureHolder.Methods inherited from class org.biojava.bio.seq.AbstractFeatureHolder
createFeature, filter, filterMethods 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
-
SimpleFeatureHolder
public SimpleFeatureHolder()Construct a new SimpleFeatureHolder with a non-informative schema. -
SimpleFeatureHolder
Construct a new SimpleFeatureHolder with the specified schema.
-
-
Method Details
-
getFeatures
Returns the list of features in this featureholder. -
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
-
features
Description copied from interface:FeatureHolderIterate over the features in no well defined order.- Specified by:
featuresin interfaceFeatureHolder- Returns:
- an Iterator
-
addFeature
Add a feature to the featureholder- Throws:
ChangeVetoException
-
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 vetoed
-
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
-
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
-