com.usefullittlethings.saw.controller
Interface SearchControllerIfc

All Known Implementing Classes:

AbstractSearchController, FileSearchController

public interface SearchControllerIfc

Interface for a Search and Whatever search controller class. Classes implementing this interface can be dynamically loaded by the Search and Whatever application to perform search operations. Implementations of this interface correspond to each available search "Edition". For more information on developing plug-ins, refer to the Search and Whatever home page, [Developers] link.

See Also:

getResultClass()

Field Summary

static java.lang.String

CLASS_NAME

Method Summary

void	begin()
void	configure(java.lang.String[] args)
java.lang.String	getAppTitle()
java.lang.Object	getBase()
java.lang.Class	getResultClass()
int[]	getSearchPatternPreferences()
java.lang.String	getSearchPatternSummary()
SearchRootUIIfc	getSearchRootUI()
java.lang.String	getUnixName()
boolean	hasMoreResults()
java.lang.Object	next()
void	search(int pattern)
void	setAppController(AppControllerIfc appController)
void	setSearchPatternPreferences(int[] preferences)
boolean	supports(int pattern)
java.lang.String	toXMLString(int pad)
void	update(java.lang.String xml)

Field Detail

CLASS_NAME

public static final java.lang.String CLASS_NAME

See Also:

Constant Field Values

Method Detail

setAppController

public void setAppController(AppControllerIfc appController)

getResultClass

public java.lang.Class getResultClass()

getSearchPatternPreferences

public int[] getSearchPatternPreferences()

getSearchPatternSummary

public java.lang.String getSearchPatternSummary()

setSearchPatternPreferences

public void setSearchPatternPreferences(int[] preferences)
                                 throws java.lang.Exception

java.lang.Exception

getSearchRootUI

public SearchRootUIIfc getSearchRootUI()

getAppTitle

public java.lang.String getAppTitle()

search

public void search(int pattern)
            throws UnsupportedPatternException

UnsupportedPatternException

hasMoreResults

public boolean hasMoreResults()

next

public java.lang.Object next()
                      throws java.lang.Exception

java.lang.Exception

getBase

public java.lang.Object getBase()

toXMLString

public java.lang.String toXMLString(int pad)

getUnixName

public java.lang.String getUnixName()

update

public void update(java.lang.String xml)
            throws java.text.ParseException

java.text.ParseException

configure

public void configure(java.lang.String[] args)
               throws ArgumentException

ArgumentException

begin

public void begin()
           throws java.lang.Exception

java.lang.Exception

supports

public boolean supports(int pattern)