| Home >> All |
| | recoin.container.* (7) | | recoin.exception.* (11) | | recoin.group.* (26) | | recoin.gui.* (13) |
| | recoin.system.* (13) | | recoin.util.* (3) | | recoin.web.* (4) | | recoinx.clef.* (26) |
| | recoinx.query.* (1) |
Package Samples:
recoin.container
recoin.exception
recoin.group.adapter
recoin.group.connector
recoin.group.postresult
recoin.group
recoin.gui
recoin.system.session
recoin.system
recoin.util
recoin.web
recoinx.clef.irs.lucene
recoinx.clef.irs.mysql
recoinx.clef
recoinx.query
Classes:
RetrievalContainer: A RetrievalContainer is a very simple container object that can be used in a RetrievalCycle to store data that is used during retrieval. This data could be anything from input to the retrieval process like a query, output that has been created, result lists for example, or any other data that aids in the retrieval process. The RetrievalContainer is passed along different ModuleGroup objects and it lets the Component objects of a particular group access, process and store information inside the container. A RetrievalContainer object can switch between two different states to signal if there still ...
Module: A Module represents a simple container that is used to group a number of Component objects together. Furthermore a Module can be deployed and undeployed at runtime, thus providing a plug-in mechanism for a group of Component objects. A Component can only function properly inside a Module object and only one Component with the same ID should be contained in any single Module, because the ID of the Module and of the Component are used to identify the unique Component-Module relationship at runtime. If the same Component has to be loaded more than once, each of the Component instances should be contained ...
ComponentOrder: A ComponentOrder is used to to tell a Component what it should do with a RetrievalContainer in terms of the objects it should try to process and their order. Therefore it contains information as to what objects in the container should be processed, whether any results should be stored inside the container, and if these results - together with a corresponding ComponentOrder - should be forwarded to another component inside the ModuleGroup. A ComponentOrder can have another single ComponentOrder as its parent order and any number of them as child order thus creating a tree structure to implement ...
RepositoryManager: The RepositoryManager is an abstract superclass for all classes implementing an interface to a RECOIN repository. Non abstract subclasses have to implement the methods declared in this class. This ensures the compatibility of different RepositoryManager implementations. Furthermore, any subclasses have to provide an empty constructor method in order to be dynamically loaded via the Reflection-API at runtime. All methods that access and manipulate data in the repository should throw a RepositoryException if there are any errors or inconsistencies between the representation of the object in the repository ...
CLEFAnalyzer: The CLEFAnalyzer class is the base class used for formatting, stemming, stop word removal, etc. It uses a SnowballAnalyzer for stemming and stopword removal and is capable of processing the languages English, German, French and Spanish. The names of the stopword files must follow the naming convention <LanguagePrefix>_stopwords.txt to be considered for stopword removal. Example: EN_stopwords.txt for the English stopword file. The language prefixes are: EN (English), DE (German), FR (French), ES (Spanish). The single stopwords in the files must appear separately on different lines.
AdminCommand: The AdminCommand encapsulates the access to administrative functions of RECOIN in order to be used by different objects. It serves as a bridge to the remote administration service to shield any objects from the implementation of the remote connection. Any commands are forwarded to an implementation of a RemoteAdminConnector . It implements the RemoteAdminConnector interface itself to function as a substitute. This may change in future versions.
ComponentSupport: The ComponentSupport interface forms the superclass for all support interfaces in RECOIN. These support interfaces are used to provide methods which allow Component objects to access and manipulate the data of the classes implementing these interfaces. Any class that needs to be processed by a Component object has to implement a subclass of this interface in order to be recognized and for the ComponentWorker to extract the necessary data. The class implements the java.io.Serializable interface in order to be transmitted over a network.
Component: A Component represents an object that takes part in and contributes to the information retrieval process. This can be, for example, a component that handles the connection to a database or IR system or a component that carries out result merging. The Component interface describes the basic functionality of a Component that is used in the RECOIN framework. It specifies methods to access and manipulate a Component's attributes and methods which are used when the Component is loaded in the framework.
ModuleView: A ModuleView implements the Module interface, but doesn't implement the runtime methods like prepareContainer 55 . It merely encapsulates information about the Module which can also be transmitted across a network, because a ModuleView implements the Serializable interface. ModuleView objects are used, for example, by the administration web application to transport and store data about the Module.
ComponentView: A ComponentView is used to encapsulate and transport data about a Component over a network. It implements the Component interface in order to make it look like a Component. Nevertheless, it does not implement the same behavior as, for example, the ComponentImpl class, because a ComponentView object is not supposed to be used as a 'working' object in the RECOIN framework, but merely appears like a Component with all its attributes so it can be used to display the information.
DurationStamp: A DurationStamp can be used to measure a process that has a starting point and an end point. The DurationStamp is given a name to identify the object or process that whose context this DurationStamp was created. This name is supposed to be used as a label for this DurationStamp. Start and end of the process are stored internally as the number of milliseconds since January 1, 1970, 00:00:00 GMT.
ViewRepository: The ViewRepository servlet is the single entry point to the webpages of the administration web application that administers the RECOIN repository. This servlet possesses a AdminCommand through which it can communicate with the administration service inside the RECOIN framework. It serves as a controller that executes or forwards user commands and delegates the client to the appropriate pages.
InOutSupport: The class InOutSupport describes the behavior of a Component in terms of what ComponentSupport objects it can process and what the resulting outcome is. This class is used, for example, in the hasSupportFor 55 method to determine the Component's capabilities.
GUIManager: The GUIManager represents the component that controls and delivers all GUI components of the application. It uses a ProcFrame to execute different procedures like start and stop procedures. Any parameters provided by the user during these procedures are collected in a Hashtable in the GUIManager and used, for example, to start the RuntimeManager.
ClassLoadingException: A ClassLoadingException can be thrown whenever a Class is supposed to be loaded and instantiated dynamically with the help of its classname. Because this mechanism covers several steps, a ClassLoadingException represents different exceptions that can occur during the process, e.g. an InstantiationException or a ClassNotFoundException.
ProcFrame: The ProcFrame provides a setting to execute procedures that represent a dialog with the user consisting of a number of masks or pages that have to be displayed. In the upper portion of the ProcFrame the different pages can be presented while the lower portion contains means to move through the pages, e.g. a NEXT- and BACK-Button.
ComponentSupportException: A ComponentSupportException generally is thrown if there occur any problems related to the processing of a ComponentSupport object. It can be thrown, for example, when a ComponentSupport that is specified in a ComponentChain can't be found or if an appropriate ComponentSupport is present, but does not work as expected.
RuntimeManager: The RuntimeManager administrates and observes the runtime components of the application. A RuntimeManager executes orders received from an ApplicationManager object. Because the RuntimeManager is a central object that holds references to all runtime components, all exceptions and logging is handled here.
ComponentWorker: The ComponentWorker is the abstract super class for all classes that need to be loaded into a component. Any classes that implement customized behavior as part of the retrieval process need to extend this class. All that is expected of this class is that it creates and returns a ComponentRunnable.
JDBCSingleAdapter: The JDBCSingleAdapter provides methods to create connections to a datasource. The connections are closed after each transaction which means new connections have to be generated for every task. It extends the JDBCAdapter class that prepares the necessary attributes needed to establish the connection.
ModuleGroup: The ModuleGroup class provides basic functionality to add and remove Module objects. It also provides means to accept and distribute a RetrievalContainer to the Module objects contained in it. A ModuleGroup has to be of a certain type to distinguish itself from other groups in the RetrievalCycle.
TimeLog: A TimeLog can be used to record a sequence of phases or processes. To do so an unlimitited number of DurationStamp objects can be added. The first DurationStamp added to the TimeLog should be used to represent the overall process. There is also a special constructor for this case.
MissingDataException: A MissingDataException can be thrown whenever a certain order or operation cannot be processed because of insufficient or missing data. This can be the case when the necessary attributes of a dynamically loaded object have not been set and the object therefore cannot function properly.
SubmitSubPanel: The SubmitSubPanel displays a summary of the parameters chosen in the procedure it is part of. It is therefore the last panel to be shown to the user in a certain procedure. It implements the Writable interface to add the content before being displayed.
JDBCPooledAdapter: The JDBCPooledAdapter provides methods to get connections from a connection pool that it can share with other JDBCPooledAdapter objects. Different subclasses of JDBCPooledAdapter can use a single ConnectionPool object if they reside in the same Module.
| Home | Contact Us | Privacy Policy | Terms of Service |