Package com.raritantechnologies.searchApp

Contains the interfaces and base classes for the Raritan Abstract Search Application Framework.

See:
          Description

Interface Summary
IAssignableLoginInfo
IConfigurable
IConfigurableFactory Base interface for Factory objects that can instantiate IConfigurable objects.
IDataElementDescriptor  
IDataRowDescriptor  
IDataTableDescriptor  
IFieldFormatter Interface for objects which reformat IResult field(s).
ILoginInfo Interface providing login information.
ILoginInfoComparator Basic interface for objects that can match ILoginInfo objects - used for security screening.
INavigator Basic Interface for Result Sets that support Faceted Navigation.
INavigatorFacet Basic Interface for individual 'Facets' in a ResultSet that supports Faceted Navigation.
InitializableSystemObject Defines a SystemObject that needs to be initialized after initial configuration initialization is done.
InMemoryInitializer
IQueryBuilder  
IQueryParser Query Parser Interface: Allows a common language to be parsed into the native tongue of a SearchSource.
IQueryProcessor Abstract Query Processor Interface: Executes a query against some back end search process (e.g.
IQueryResultMatcher
IResult Interface for result objects.
IResultComparator Base interface for objects that can compare two IResult objects for relative ordering.
IResultMatcher Specialized matching interface for IResult objects.
IResultParser Base interface for a parser that can convert a data String into an IResult object.
IResultSet Interface for a general result set.
IResultSetFilter Base interface for objects that filter IResultSets.
IResultSetProcessor Base interface for objects that process IResultSets.
ISearchFieldMap Implements global field mapping strategy for a Raritan Search Application.
ISearchFieldMapFactory Interface for ISearchFieldMap factory objects.
ISearchHistory Base Search History interface.
ISearchSourceInfo Base interface for objects that can provide information about a SearchSource.
ISecurityManager Basic interface for a Security manager.
ISorter Base Interface for sorting IResult objects.
IStreamFactory  
IXMLSearchSourceFactory Interface for a factory class that can create a SearchSource object from XML Configuration file.
 

Class Summary
AbstractQueryOperator Defines a query operator/value pair at a general or abstract level - IQueryProcessors must translate the query operator into their own query language.
AbstractSearchField Used to hold abstract field data in Raritan QuickStart and Federated Search Applications.
AbstractSortMap Provides a default sort map for a SearchSource.
AbstractSortSpec Provides a basic sorting specification - fieldID and sort direction.
BasicDataElement  
BasicDataRow  
BasicDataTable  
BasicResult Basic implementation of IResult interface.
BasicResultSet Basic implementation of IResultSet: a "plain vanilla" ResultSet.
BeanPropertyResult Uses Java Reflection to convert an Object into an IResult object.
BooleanComboField Bean wrapper class for nested Boolean searches.
CompositeSearchSource Builds a single, composite IResultSet from multiple search sources.
ConfigurableObjectFactory General factory for IConfigurable objects.
ConfigurableObjectFactoryBean  
ConfigurationManager Manages all configuration issues for a Raritan Technologies Framework application.
DynamicSearchSourceInfo Enables source properties to be described dynamically in another data source.
FacetStatistics  
FieldComparator Compare two IResult objects by a field in the record.
FileSystemConfigurableObjectFactory Provides a Configurable Object Factory given a set of Configuration XML files on a fileshare.
FileSystemSearchSource Simple File System search source.
FlatFileMemorySourceFactory Creates an InMemorySearchSource from a set of flat files.
FlatFileSearchSource A SearchSource that reads from a Flat File or files.
InMemorySearchSource Implements an In Memory search source.
Logger Provides basic logging functionality for ConfigurationManager.
LoginInfo Basic implementation of ILoginInfo.
MapResult  
PropertiesConfigurationManager Implementation of ConfigurationManager that uses a PropertyResourceBundle to set configuration properties.
PropertiesSecurityManager Simple implementation of ISecurityManager uses LoginInfo.properties to look up user name and searchSource.
QueryProcessorFilter Base class for QueryProcessor filters which are used to construct query / result processing pipelines.
QueryProcessorFilterFactory Factory class for QueryProcessorFilters.
QueryProcessorFilterSource SearchSource which wraps its QueryProcessor into a QueryProcessorFilter.
QueryProcessorMemorySourceFactory Creates an InMemorySearchSource from a SearchSource by executing a set of queries.
ResultSetQueryProcessor Wraps a Query into a single element result set.
ResultSetSorter Sort a result set using a specified IResultComparator.
SearchField Represents a field in a SearchSource.
SearchFieldMap General implementation of an ISearchFieldMap.
SearchFormField Defines a field within an HTML search form.
SearchHistoryBean ISearchHistory object that can be used as a Session-scoped Bean.
SearchHistoryJdbcManager Contains JDBC-specific logic for the Search History functionality.
SearchHistorySource Creates an IResultSet from a search history.
SearchHistorySourceFactory Factory class for SearchHistorySource.
SearchSource Represents a search source: can be a web site, database, SOAP source, etc.
SecurityManager Handles all security decisions for an application.
SecurityManagerFactory Initializes a SecurityManager from a configuration element.
SecurityModel Encapsulates information about the Security model used to connect to a search site.
SelectedRecordsSearchSource Provides a SearchSource for the selected records in a user session.
SourceLoginInfo Binds a SearchSource to the ILoginInfo for a valid user of the source.
StaticSearchSourceInfo Enables source properties to be described in the XML Configuration file.
XMLConfigurationManager Subclass of ConfigurationManager that initializes application configuration information from an XML file.
XMLMemorySearchSourceFactory Creates an InMemorySearchSource from an XML source.
XMLSearchFieldMapFactory Constructs a SearchFieldMap from an XML source.
XMLSearchSourceFactory Abstract base implementation of IXMLSearchSourceFactory.
 

Exception Summary
ConfigurationException
QueryException
QueryParseException
QueryProcessorException
SearchSourceException SearchSourceException is thrown from various Source-related methods.
UnsupportedLanguageException Thrown when the translator doesn't recognize the target language.
 

Package com.raritantechnologies.searchApp Description

Contains the interfaces and base classes for the Raritan Abstract Search Application Framework.