| Home >> All >> recoin >> [ group Javadoc ] |
| | recoin.group.adapter.* (4) | | recoin.group.connector.* (6) | | recoin.group.postresult.* (1) |
recoin.group: Javadoc index of package recoin.group.
Package Samples:
recoin.group.adapter
recoin.group.connector
recoin.group.postresult
Classes:
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 ...
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.
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.
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.
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.
AdminConnector: The AdminConnector class is a special class that allows the configuration and administration of the RECOIN framework at runtime. It possesses an inner class that implements the RemoteAdminConnector interface and accepts method calls via RMI.
RMIConnector: The RMIConnector is an abstract class that forms the base for Connector objects implementing server-side RMI functions. RMIConnector provides the RMI server and methods to register a service to the registry.
Mergeable: The interface Mergeable should be implemented by subclasses of the Result class if they are involved in any fusion processes. The interface's getUniqueIdentifier() method can be used for comparison operations.
ComponentRunnable: Abstract superclass for Runnables in Component objects. Any classes that want to implement customized behavior in order to fullfil the role of Component 'jobs' must extend this class.
AdminConnectorTest: A TestCase to test the functionality of the RMIAdminServer using a AdminCommand. This class can be used to ensure the correct implementation of a the remote administration service.
ComponentSupportView: A ComponentSupportView is an implementation of the ComponentSupport interface. It is used to encapsulate and transport information about a ComponentSupport.
JDBCAdapter: The JDBCAdapter is an abstract class which provides basic initiation functions and attributes needed to connect to a database via JDBC.
ComponentTest: A TestCase to test the functionality of a Component. This class can be used to ensure the correct implementation of a Component.
ModuleTest: A TestCase to test the functionality of a Module. This class can be used to ensure the correct implementation of a Module.
NodeAdapter: A Node Adapter behaves like a regular Adapter, but can be used to connect to and communicate with other RECOIN nodes.
UDPConnector: The UDPConnector can be used for the communication via Sockets using datagramms.
RemoteAdminConnector: Remote interface that describes the methods of a remote administration service.
| Home | Contact Us | Privacy Policy | Terms of Service |