Class SimilarityPairBuilder
- java.lang.Object
-
- org.biojava.bio.program.ssbind.ViewSequenceFactory
-
- org.biojava.bio.program.ssbind.SimilarityPairBuilder
-
- All Implemented Interfaces:
SearchContentHandler
public class SimilarityPairBuilder extends ViewSequenceFactory implements SearchContentHandler
SimilarityPairBuilderannotates query and subjectSequencewithSimilarityPairFeatures created from SAX events supplied via aSeqSimilarityAdapter. The objective is to describe a simple pairwise relationship between the two sequences. This differs slightly from usingHomologyFeatures which are slightly heavier, have to contain a full alignment and don't have an explicit distinction between query and subject sequences in the alignment. The SAX events should describe elements conforming to the BioJava BlastLikeDataSetCollection DTD. Suitable sources areBlastLikeSAXParserorFastaSAXParser.Annotated
ViewSequences wrapping both query and subject sequences are created.The current implementation should be used with care on streams containing more than one search output. This is because the builder will not stop after each report has been processed and as a result all the subject sequences get instantiated and a large object network could be created during processing.
- Since:
- 1.2
- Author:
- Keith James, Greg Cox
-
-
Field Summary
Fields Modifier and Type Field Description static StringSIMILARITY_PAIR_FEATURE_TYPEConstantSIMILARITY_PAIR_FEATURE_TYPEthe type String used bySimilarityPairBuilderwhen creatingSimilarityPairFeatures.-
Fields inherited from class org.biojava.bio.program.ssbind.ViewSequenceFactory
databaseID, querySeqHolder, queryViewCache, subjectDBs, subjectViewCache
-
-
Constructor Summary
Constructors Constructor Description SimilarityPairBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddHitProperty(Object key, Object value)TheaddHitPropertymethod adds a key/value pair containing some property of a particular hit.voidaddSearchProperty(Object key, Object value)TheaddSearchPropertymethod adds a key/value pair containing some property of the overall search result.voidaddSubHitProperty(Object key, Object value)TheaddSubHitPropertymethod adds a key/value pair containing some property of a particular subhit.voidendHeader()TheendHeadermethod indicates the end of a formatted header.voidendHit()TheendHitmethod indicates the end of a formatted hit.voidendSearch()TheendSearchmethod indicates the end of useful search information.voidendSubHit()TheendSubHitmethod indicates the end of a formatted subhit.SequencegetAnnotatedQuerySeq(String queryID)SequencegetAnnotatedSubjectSeq(String subjectID)booleangetMoreSearches()getMoreSearchesreturns the state of theSearchContentHandlerwith respect to further searches from its data source.voidsetMoreSearches(boolean value)setMoreSearchessets the state of theSearchContentHandler's expectation of receiving more results.voidsetQueryID(String queryID)setQueryIDidentifies the query sequence by a name, ID or URN.voidstartHeader()ThestartHeadermethod indicates the start of a formatted header.voidstartHit()ThestartHitmethod indicates the start of a formatted hit.voidstartSearch()ThestartSearchmethod indicates the start of useful search information.voidstartSubHit()ThestartSubHitmethod indicates the start of a formatted subhit.-
Methods inherited from class org.biojava.bio.program.ssbind.ViewSequenceFactory
getQuerySeqHolder, getSubjectDBInstallation, makeQueryViewSequence, makeSubjectViewSequence, setDatabaseID, setQuerySeqHolder, setSubjectDBInstallation
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.biojava.bio.search.SearchContentHandler
setDatabaseID
-
-
-
-
Field Detail
-
SIMILARITY_PAIR_FEATURE_TYPE
public static final String SIMILARITY_PAIR_FEATURE_TYPE
ConstantSIMILARITY_PAIR_FEATURE_TYPEthe type String used bySimilarityPairBuilderwhen creatingSimilarityPairFeatures. This is the String which is returned when aSimilarityPairFeature'sgetType()method is called.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SimilarityPairBuilder
public SimilarityPairBuilder()
-
-
Method Detail
-
getAnnotatedQuerySeq
public Sequence getAnnotatedQuerySeq(String queryID) throws IllegalIDException
- Throws:
IllegalIDException
-
getAnnotatedSubjectSeq
public Sequence getAnnotatedSubjectSeq(String subjectID) throws IllegalIDException
- Throws:
IllegalIDException
-
setQueryID
public void setQueryID(String queryID)
Description copied from interface:SearchContentHandlersetQueryIDidentifies the query sequence by a name, ID or URN.- Specified by:
setQueryIDin interfaceSearchContentHandler- Parameters:
queryID- aStringwhich should be an unique identifer for the sequence.
-
getMoreSearches
public boolean getMoreSearches()
Description copied from interface:SearchContentHandlergetMoreSearchesreturns the state of theSearchContentHandlerwith respect to further searches from its data source. Used for handling streams of search results.- Specified by:
getMoreSearchesin interfaceSearchContentHandler- Returns:
- a
booleanvalue.
-
setMoreSearches
public void setMoreSearches(boolean value)
Description copied from interface:SearchContentHandlersetMoreSearchessets the state of theSearchContentHandler's expectation of receiving more results. Used for handling streams of search results.- Specified by:
setMoreSearchesin interfaceSearchContentHandler- Parameters:
value- abooleanvalue.
-
startSearch
public void startSearch()
Description copied from interface:SearchContentHandlerThestartSearchmethod indicates the start of useful search information.- Specified by:
startSearchin interfaceSearchContentHandler
-
endSearch
public void endSearch()
Description copied from interface:SearchContentHandlerTheendSearchmethod indicates the end of useful search information.- Specified by:
endSearchin interfaceSearchContentHandler
-
startHeader
public void startHeader()
Description copied from interface:SearchContentHandlerThestartHeadermethod indicates the start of a formatted header. This usually contains information relevant to the search as a whole.- Specified by:
startHeaderin interfaceSearchContentHandler
-
endHeader
public void endHeader()
Description copied from interface:SearchContentHandlerTheendHeadermethod indicates the end of a formatted header.- Specified by:
endHeaderin interfaceSearchContentHandler
-
startHit
public void startHit()
Description copied from interface:SearchContentHandlerThestartHitmethod indicates the start of a formatted hit. This could be a single line, or a block of lines.- Specified by:
startHitin interfaceSearchContentHandler
-
endHit
public void endHit()
Description copied from interface:SearchContentHandlerTheendHitmethod indicates the end of a formatted hit.- Specified by:
endHitin interfaceSearchContentHandler
-
startSubHit
public void startSubHit()
Description copied from interface:SearchContentHandlerThestartSubHitmethod indicates the start of a formatted subhit. There may be zero or more of these per hit.- Specified by:
startSubHitin interfaceSearchContentHandler
-
endSubHit
public void endSubHit()
Description copied from interface:SearchContentHandlerTheendSubHitmethod indicates the end of a formatted subhit.- Specified by:
endSubHitin interfaceSearchContentHandler
-
addSearchProperty
public void addSearchProperty(Object key, Object value)
Description copied from interface:SearchContentHandlerTheaddSearchPropertymethod adds a key/value pair containing some property of the overall search result.- Specified by:
addSearchPropertyin interfaceSearchContentHandler- Parameters:
key- anObject.value- anObject.
-
addHitProperty
public void addHitProperty(Object key, Object value)
Description copied from interface:SearchContentHandlerTheaddHitPropertymethod adds a key/value pair containing some property of a particular hit.- Specified by:
addHitPropertyin interfaceSearchContentHandler- Parameters:
key- anObject.value- anObject.
-
addSubHitProperty
public void addSubHitProperty(Object key, Object value)
Description copied from interface:SearchContentHandlerTheaddSubHitPropertymethod adds a key/value pair containing some property of a particular subhit.- Specified by:
addSubHitPropertyin interfaceSearchContentHandler- Parameters:
key- anObject.value- anObject.
-
-