org.kepler.gui

Class LibrarySearcher

java.lang.Object

org.kepler.gui.LibrarySearcher

Direct Known Subclasses:

EcogridRepositoryLibrarySearcher, OntLibrarySearcher, SimpleLibrarySearcher

public abstract class LibrarySearcher
extends java.lang.Object

this abstract class is should be extended by all classes that provide a search engine for the actory library. Any local variables in the extending classes should be initialized in the init method because it is called from the constructor of this class.

Since:

February 17, 2005

Author:

berkley

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JTree	_library the library to search
protected java.util.Hashtable<java.lang.String,java.lang.Object>	_properties a user setable properties hash
protected LibrarySearchResults	_results Description of the Field
protected LibrarySearchPane	_searchPane Description of the Field

Constructor Summary

Constructors

Constructor and Description
LibrarySearcher(javax.swing.JTree library, LibrarySearchPane searchPane) constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getProperty(java.lang.String name) returns a user set property
protected abstract void	init() provides any initialization needed prior to searching.
abstract LibrarySearchResults	search(java.lang.String value, boolean authenticate) search for value in the library
void	setProperty(java.lang.String name, java.lang.Object value) set a user setable property

Methods inherited from class java.lang.Object

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

Field Detail

_library

protected javax.swing.JTree _library

the library to search

_results

protected LibrarySearchResults _results

Description of the Field

_searchPane

protected LibrarySearchPane _searchPane

Description of the Field

_properties

protected java.util.Hashtable<java.lang.String,java.lang.Object> _properties

a user setable properties hash

Constructor Detail

LibrarySearcher

public LibrarySearcher(javax.swing.JTree library,
                       LibrarySearchPane searchPane)

constructor

Parameters:

library - Description of the Parameter

searchPane - Description of the Parameter

Method Detail

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

set a user setable property

getProperty

public java.lang.Object getProperty(java.lang.String name)

returns a user set property

search

public abstract LibrarySearchResults search(java.lang.String value,
                                            boolean authenticate)
                                     throws IllegalActionException,
                                            RepositoryException,
                                            AuthenticationException

search for value in the library

Parameters:

value - the value to search for

searchRemotely - true if a remote search should take place.

authenticate - true will prompt user to login if necessary.

Returns:

LibrarySearchResults the results of the search

Throws:

RepositoryException

AuthenticationException

IllegalActionException

init

protected abstract void init()

provides any initialization needed prior to searching. It is called when the class is constructed. Note that any local variables of extending classes should be initialized in init since it is called be the constructor of the super class (LibrarySearcher).