Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

recoin.system.session
Class RetrievalSession  view RetrievalSession download RetrievalSession.java

java.lang.Object
  extended byrecoin.system.session.RetrievalSession

public class RetrievalSession
extends java.lang.Object

The RetrievalSession represents the context in which a client can execute its requests, i.e. a nuber of tasks that are carried out in a RetrievalCycle. At the end of the cycle the Session reports back the results to the client.

Version:
0.2.9

Field Summary
private  int cycleCounter
          Counter that is used to number the RetrievalCycle objects.
private  int id
          The ID of this RetrievalSession that is created by the SessionManager.
private  SessionManager sessionManager
          The SessionManager.
 
Constructor Summary
RetrievalSession(SessionManager sManager)
          Creates a new RetrievalSession with the specified SessionManager.
 
Method Summary
 RetrievalCycle createRetrievalCycle(recoin.container.Query q)
          Returns a new RetrievalCycle that is initiated with the specified Query.
 RetrievalCycle createRetrievalCycle(recoin.container.Query q, ComponentChain cc)
          Returns a new RetrievalCycle that is initiated with the specified Query and ComponentChain.
 int getID()
          Returns the ID of the RetrievalSession.
 SessionManager getSessionManager()
          Returns the SessionManager.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

cycleCounter

private int cycleCounter
Counter that is used to number the RetrievalCycle objects.


id

private int id
The ID of this RetrievalSession that is created by the SessionManager.


sessionManager

private SessionManager sessionManager
The SessionManager.

Constructor Detail

RetrievalSession

public RetrievalSession(SessionManager sManager)
Creates a new RetrievalSession with the specified SessionManager.

Method Detail

getSessionManager

public SessionManager getSessionManager()
Returns the SessionManager.


createRetrievalCycle

public RetrievalCycle createRetrievalCycle(recoin.container.Query q)
Returns a new RetrievalCycle that is initiated with the specified Query.


createRetrievalCycle

public RetrievalCycle createRetrievalCycle(recoin.container.Query q,
                                           ComponentChain cc)
Returns a new RetrievalCycle that is initiated with the specified Query and ComponentChain.


getID

public int getID()
Returns the ID of the RetrievalSession.