Package org.biojava.bio.search

Class SearchContentHandlerDebugger

java.lang.Object
org.biojava.bio.search.SearchContentHandlerDebugger
All Implemented Interfaces:
SearchContentHandler
public class SearchContentHandlerDebugger extends Object implements SearchContentHandler
This class prints to a PrintStream calls to the SearchContentHandler interface in human readable form. Use to debug parser/adaptor classes that output to the SearchContentHandler interface.
Author:
David Huen

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchContentHandlerDebugger()
    Create an instance that dumps to System.out.
    SearchContentHandlerDebugger(PrintStream pStream)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addHitProperty(Object key, Object value)
    The addHitProperty method adds a key/value pair containing some property of a particular hit.
    void
    addSearchProperty(Object key, Object value)
    The addSearchProperty method adds a key/value pair containing some property of the overall search result.
    void
    addSubHitProperty(Object key, Object value)
    The addSubHitProperty method adds a key/value pair containing some property of a particular subhit.
    void
    endHeader()
    The endHeader method indicates the end of a formatted header.
    void
    endHit()
    The endHit method indicates the end of a formatted hit.
    void
    endSearch()
    The endSearch method indicates the end of useful search information.
    void
    endSubHit()
    The endSubHit method indicates the end of a formatted subhit.
    boolean
    getMoreSearches()
    getMoreSearches returns the state of the SearchContentHandler with respect to further searches from its data source.
    void
    setDatabaseID(String databaseID)
    setDatabaseID identifies the database searched by a name, ID or URN.
    void
    setMoreSearches(boolean value)
    setMoreSearches sets the state of the SearchContentHandler's expectation of receiving more results.
    void
    setQueryID(String queryID)
    setQueryID identifies the query sequence by a name, ID or URN.
    void
    startHeader()
    The startHeader method indicates the start of a formatted header.
    void
    startHit()
    The startHit method indicates the start of a formatted hit.
    void
    startSearch()
    The startSearch method indicates the start of useful search information.
    void
    startSubHit()
    The startSubHit method indicates the start of a formatted subhit.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait