public class DASSequence extends AbstractChangeable
This is an first-pass implementation. In future, I hope to add query optimization for better performance on large sequences, and pluggable transducers to parameterize the creation of BioJava features.
Annotatable.AnnotationForwarder
FeatureHolder.EmptyFeatureHolder
Modifier and Type | Field and Description |
---|---|
protected ChangeForwarder |
annotationForwarder |
static ChangeType |
ANNOTATIONS
Change type which indicates that the set of annotation servers used
by this DASSequence has been changed.
|
static java.lang.String |
PROPERTY_ANNOTATIONSERVER |
static java.lang.String |
PROPERTY_FEATUREID |
static java.lang.String |
PROPERTY_FEATURELABEL |
static java.lang.String |
PROPERTY_LINKS |
static java.lang.String |
PROPERTY_SEQUENCEVERSION |
static int |
SIZE_THRESHOLD |
EDIT, EMPTY_LIST
ANNOTATION
EMPTY_FEATURE_HOLDER, FEATURES, SCHEMA
Modifier and Type | Method and Description |
---|---|
void |
addAnnotationSource(java.net.URL dataSourceURL) |
boolean |
containsFeature(Feature f)
Check if the feature is present in this holder.
|
int |
countFeatures()
Count how many features are contained.
|
Feature |
createFeature(Feature.Template temp)
Create a new Feature, and add it to this FeatureHolder.
|
java.util.Set |
dataSourceURLs() |
void |
edit(Edit e)
Apply an edit to the SymbolList as specified by the edit object.
|
java.util.Iterator |
features()
Iterate over the features in no well defined order.
|
FeatureHolder |
filter(FeatureFilter ff)
Query this set of features using a supplied
FeatureFilter . |
FeatureHolder |
filter(FeatureFilter ff,
boolean recurse)
Return a new FeatureHolder that contains all of the children of this one
that passed the filter fc.
|
Alphabet |
getAlphabet()
The alphabet that this SymbolList is over.
|
Annotation |
getAnnotation()
Should return the associated annotation object.
|
protected ChangeSupport |
getChangeSupport(ChangeType ct)
Called to retrieve the ChangeSupport for this object.
|
java.lang.String |
getName()
The name of this sequence.
|
DASSequenceDB |
getParentDB() |
FeatureFilter |
getSchema()
Return a schema-filter for this
FeatureHolder . |
protected SymbolList |
getSymbols() |
java.lang.String |
getURN()
A Uniform
Resource Identifier (URI) which identifies the sequence
represented by this object.
|
java.util.Iterator |
iterator()
An Iterator over all Symbols in this SymbolList.
|
int |
length()
The number of symbols in this SymbolList.
|
Feature |
realizeFeature(FeatureHolder dest,
Feature.Template temp)
Realize a feature template.
|
void |
removeAnnotationSource(java.net.URL dataSourceURL) |
void |
removeFeature(Feature f)
Remove a feature from this FeatureHolder.
|
java.lang.String |
seqString()
Stringify this symbol list.
|
SymbolList |
subList(int start,
int end)
Return a new SymbolList for the symbols start to end inclusive.
|
java.lang.String |
subStr(int start,
int end)
Return a region of this symbol list as a String.
|
Symbol |
symbolAt(int pos)
Return the symbol at index, counting from 1.
|
java.util.List |
toList()
Returns a List of symbols.
|
addChangeListener, addChangeListener, generateChangeSupport, hasListeners, hasListeners, isUnchanging, removeChangeListener, removeChangeListener
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener
public static final ChangeType ANNOTATIONS
public static final java.lang.String PROPERTY_ANNOTATIONSERVER
public static final java.lang.String PROPERTY_FEATUREID
public static final java.lang.String PROPERTY_FEATURELABEL
public static final java.lang.String PROPERTY_LINKS
public static final java.lang.String PROPERTY_SEQUENCEVERSION
public static final int SIZE_THRESHOLD
protected transient ChangeForwarder annotationForwarder
public DASSequenceDB getParentDB()
public java.util.Set dataSourceURLs()
public void addAnnotationSource(java.net.URL dataSourceURL) throws BioException, ChangeVetoException
BioException
ChangeVetoException
protected ChangeSupport getChangeSupport(ChangeType ct)
AbstractChangeable
Your implementation of this method should have the following structure:
It is usual for the forwarding listeners (someForwarder in this example) to
be transient and lazily instantiated. Be sure to register & unregister the
forwarder in the code that does the ChangeEvent handling in setter methods.
ChangeSupport cs = super.getChangeSupport(ct);
if(someForwarder == null && ct.isMatching(SomeInterface.SomeChangeType)) {
someForwarder = new ChangeForwarder(...
this.stateVariable.addChangeListener(someForwarder, VariableInterface.AChange);
}
return cs;
getChangeSupport
in class AbstractChangeable
public void removeAnnotationSource(java.net.URL dataSourceURL) throws ChangeVetoException, BioException
ChangeVetoException
BioException
public Alphabet getAlphabet()
SymbolList
Every symbol within this SymbolList is a member of this alphabet.
alphabet.contains(symbol) == true
for each symbol that is within this sequence.
public java.util.Iterator iterator()
SymbolList
This is an ordered iterator over the Symbols. It cannot be used to edit the underlying symbols.
public int length()
SymbolList
public java.lang.String seqString()
SymbolList
It is expected that this will use the symbol's token to render each symbol. It should be parsable back into a SymbolList using the default token parser for this alphabet.
public java.lang.String subStr(int start, int end)
SymbolList
This should use the same rules as seqString.
start
- the first symbol to includeend
- the last symbol to includepublic SymbolList subList(int start, int end)
SymbolList
The resulting SymbolList will count from 1 to (end-start + 1) inclusive, and refer to the symbols start to end of the original sequence.
start
- the first symbol of the new SymbolListend
- the last symbol (inclusive) of the new SymbolListpublic Symbol symbolAt(int pos)
SymbolList
pos
- the offset into this SymbolListpublic java.util.List toList()
SymbolList
This is an immutable list of symbols. Do not edit it.
public void edit(Edit e) throws ChangeVetoException
SymbolList
All edits can be broken down into a series of operations that change contiguous blocks of the sequence. This represent a one of those operations.
When applied, this Edit will replace 'length' number of symbols starting a position 'pos' by the SymbolList 'replacement'. This allow to do insertions (length=0), deletions (replacement=SymbolList.EMPTY_LIST) and replacements (length>=1 and replacement.length()>=1).
The pos and pos+length should always be valid positions on the SymbolList to:
SymbolList seq = DNATools.createDNA("atcaaaaacgctagc");
System.out.println(seq.seqString());
// delete 5 bases from position 4
Edit ed = new Edit(4, 5, SymbolList.EMPTY_LIST);
seq.edit(ed);
System.out.println(seq.seqString());
// delete one base from the start
ed = new Edit(1, 1, SymbolList.EMPTY_LIST);
seq.edit(ed);
// delete one base from the end
ed = new Edit(seq.length(), 1, SymbolList.EMPTY_LIST);
seq.edit(ed);
System.out.println(seq.seqString());
// overwrite 2 bases from position 3 with "tt"
ed = new Edit(3, 2, DNATools.createDNA("tt"));
seq.edit(ed);
System.out.println(seq.seqString());
// add 6 bases to the start
ed = new Edit(1, 0, DNATools.createDNA("aattgg");
seq.edit(ed);
System.out.println(seq.seqString());
// add 4 bases to the end
ed = new Edit(seq.length() + 1, 0, DNATools.createDNA("tttt"));
seq.edit(ed);
System.out.println(seq.seqString());
// full edit
ed = new Edit(3, 2, DNATools.createDNA("aatagaa");
seq.edit(ed);
System.out.println(seq.seqString());
e
- the Edit to performChangeVetoException
- if either the SymboList does not support the
edit, or if the change was vetoedprotected SymbolList getSymbols() throws BioException
BioException
public java.lang.String getName()
Sequence
The name may contain spaces or odd characters.
public java.lang.String getURN()
Sequence
urn:sequence/embl:AL121903It may also be a URL identifying a specific resource, either locally or over the network
file:///home/thomas/myseq.fa|seq22 http://www.mysequences.net/chr22.seq
public java.util.Iterator features()
FeatureHolder
public boolean containsFeature(Feature f)
FeatureHolder
f
- the Feature to checkpublic FeatureHolder filter(FeatureFilter ff)
FeatureHolder
FeatureFilter
.ff
- the FeatureFilter
to apply.filter
.public FeatureHolder filter(FeatureFilter ff, boolean recurse)
FeatureHolder
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.public FeatureFilter getSchema()
FeatureHolder
FeatureHolder
. This is a filter
which all Feature
s immediately contained by this FeatureHolder
will match. It need not directly match their child features, but it can (and should!) provide
information about them using FeatureFilter.OnlyChildren
filters. In cases where there
is no feature hierarchy, this can be indicated by including FeatureFilter.leaf
in
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, Sequence
objects should, at a minimum, return FeatureFilter.top_level
. Feature
objects
should, as a minimum, return FeatureFilter.ByParent(new FeatureFilter.ByFeature(this))
.
public int countFeatures()
FeatureHolder
public Feature createFeature(Feature.Template temp) throws ChangeVetoException
FeatureHolder
ChangeVetoException
- if this FeatureHolder does not support
creation of new features, or if the change was vetoedpublic void removeFeature(Feature f) throws ChangeVetoException
FeatureHolder
ChangeVetoException
- if this FeatureHolder does not support
feature removal or if the change was vetoedpublic Feature realizeFeature(FeatureHolder dest, Feature.Template temp) throws BioException
RealizingFeatureHolder
createFeature
method of either
this FeatureHolder
or one of our child Features.BioException
public Annotation getAnnotation()
Annotatable