SearchContentHandlerDebugger (biojava-legacy 1.9.5 API)

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)

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

Method Summary

All Methods Instance Methods Concrete Methods
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

- Constructor Detail
  - SearchContentHandlerDebugger
```
public SearchContentHandlerDebugger()
```
    Create an instance that dumps to System.out.
  - SearchContentHandlerDebugger
```
public SearchContentHandlerDebugger(PrintStream pStream)
```
    Parameters:
    
    pStream - Stream to dump output to.
- Method Detail
  - addHitProperty
```
public void addHitProperty(Object key,
                           Object value)
```
    The addHitProperty method adds a key/value pair containing some property of a particular hit.
    
    Specified by:
    
    addHitProperty in interface SearchContentHandler
    
    Parameters:
    
    key - an Object.
    
    value - an Object.
  - addSubHitProperty
```
public void addSubHitProperty(Object key,
                              Object value)
```
    The addSubHitProperty method adds a key/value pair containing some property of a particular subhit.
    
    Specified by:
    
    addSubHitProperty in interface SearchContentHandler
    
    Parameters:
    
    key - an Object.
    
    value - an Object.
  - addSearchProperty
```
public void addSearchProperty(Object key,
                              Object value)
```
    The addSearchProperty method adds a key/value pair containing some property of the overall search result.
    
    Specified by:
    
    addSearchProperty in interface SearchContentHandler
    
    Parameters:
    
    key - an Object.
    
    value - an Object.
  - setMoreSearches
```
public void setMoreSearches(boolean value)
```
    setMoreSearches sets the state of the SearchContentHandler's expectation of receiving more results. Used for handling streams of search results.
    
    Specified by:
    
    setMoreSearches in interface SearchContentHandler
    
    Parameters:
    
    value - a boolean value.
  - getMoreSearches
```
public boolean getMoreSearches()
```
    getMoreSearches returns the state of the SearchContentHandler with respect to further searches from its data source. Used for handling streams of search results.
    
    Specified by:
    
    getMoreSearches in interface SearchContentHandler
    
    Returns:
    
    a boolean value.
  - endHeader
```
public void endHeader()
```
    The endHeader method indicates the end of a formatted header.
    
    Specified by:
    
    endHeader in interface SearchContentHandler
  - endHit
```
public void endHit()
```
    The endHit method indicates the end of a formatted hit.
    
    Specified by:
    
    endHit in interface SearchContentHandler
  - endSearch
```
public void endSearch()
```
    The endSearch method indicates the end of useful search information.
    
    Specified by:
    
    endSearch in interface SearchContentHandler
  - endSubHit
```
public void endSubHit()
```
    The endSubHit method indicates the end of a formatted subhit.
    
    Specified by:
    
    endSubHit in interface SearchContentHandler
  - setDatabaseID
```
public void setDatabaseID(String databaseID)
```
    setDatabaseID identifies the database searched by a name, ID or URN.
    
    Specified by:
    
    setDatabaseID in interface SearchContentHandler
    
    Parameters:
    
    databaseID - a String which should be an unique identifier for the database searched.
  - setQueryID
```
public void setQueryID(String queryID)
```
    setQueryID identifies the query sequence by a name, ID or URN.
    
    Specified by:
    
    setQueryID in interface SearchContentHandler
    
    Parameters:
    
    queryID - a String which should be an unique identifer for the sequence.
  - startHeader
```
public void startHeader()
```
    The startHeader method indicates the start of a formatted header. This usually contains information relevant to the search as a whole.
    
    Specified by:
    
    startHeader in interface SearchContentHandler
  - startHit
```
public void startHit()
```
    The startHit method indicates the start of a formatted hit. This could be a single line, or a block of lines.
    
    Specified by:
    
    startHit in interface SearchContentHandler
  - startSearch
```
public void startSearch()
```
    The startSearch method indicates the start of useful search information.
    
    Specified by:
    
    startSearch in interface SearchContentHandler
  - startSubHit
```
public void startSubHit()
```
    The startSubHit method indicates the start of a formatted subhit. There may be zero or more of these per hit.
    
    Specified by:
    
    startSubHit in interface SearchContentHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchContentHandlerDebugger

SearchContentHandlerDebugger

Method Detail

addHitProperty

addSubHitProperty

addSearchProperty

setMoreSearches

getMoreSearches

endHeader

endHit

endSearch

endSubHit

setDatabaseID

setQueryID

startHeader

startHit

startSearch

startSubHit