SearchContentAdapter (BioJava-1.5-beta API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.biojava.bio.search
Class SearchContentAdapter

java.lang.Object
  org.biojava.bio.search.SearchContentAdapter

All Implemented Interfaces:: SearchContentHandler

Direct Known Subclasses:: FilteringContentHandler

public class SearchContentAdapter
extends Object
implements SearchContentHandler
extends Object
implements SearchContentHandler

An adapter for SearchContentHandler.

This adapter is in the same spirit as the event handler adapters in java.awt.event, and is intended as a simple base-class for implementations that only want to handle a small number of the possible call-backs. All method implementations are empty except for getMoreSearches() and setMoreSearches(). These two maintain a boolean state between calls. If you over-ride one, you should override the other.

Example

 // a very boring handler
 SearchContentHanlder ignoreEverything = new SearchContentAdapter();

 // just respond to sub hit properties
 SearchContentHander subHitsOnly = new SearchContentAdapter() {
   public void addSubHitProperth(Object key, Object value) {
     System.out.println(key + " -> " + value);
   }
 };

Since:: 1.3
Author:: Matthew Pocock

Constructor Summary
`SearchContentAdapter()`

Method Summary
`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 val)` `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

SearchContentAdapter

public SearchContentAdapter()

Method Detail