|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Session
This interface defines the methods that a session handler should support. It is used by the abstract client to search and retrieve data from the various session types currently SRW / ZClients
Method Summary | |
---|---|
void |
close()
This method closes the current connection and any underlying binding classes |
java.lang.String |
getGroup()
Returns the group for this session. |
int |
getId()
Return the session Identifier |
java.lang.String |
getName()
Return the name allocatted to this session |
java.lang.String |
getPassword()
Return the password for the user connecting via this session |
java.lang.String |
getUsername()
Return the username for the user connecting via this session |
void |
init(java.lang.String group,
java.lang.String username,
java.lang.String password)
Initalise the session |
java.util.Vector |
present(int nRecord,
int nRecords,
int[] recordOID,
java.lang.String eSpec,
java.lang.String resultSetName)
Obtain the requested records via the sessions connection to the server and return them to the caller |
java.util.Vector |
scan(java.lang.String[] databases,
int nTerms,
int step,
int position,
org.w3c.dom.Node term)
Performs a scan on the sessions connection to the sever to retrieve a list of related terms |
java.util.Vector |
scan(java.lang.String[] databases,
int nTerms,
int step,
int position,
java.lang.Object termObject)
Performs a scan on the sessions connection to the sever to retrieve a list of related terms |
SearchResult[] |
search(java.lang.Object queryObject,
java.lang.String[] databases,
java.lang.String resultSetName)
Performs a search on the sessions connection to the sever to work out how many results would be returned for the search query |
Method Detail |
---|
void close()
java.lang.String getGroup()
int getId()
java.lang.String getName()
java.lang.String getPassword()
java.lang.String getUsername()
void init(java.lang.String group, java.lang.String username, java.lang.String password) throws ConnectionException
group
- The group name for this sessionusername
- The username of the user connecting via this sessionpassword
- The password of the user connecting via this session
ConnectionException
java.util.Vector present(int nRecord, int nRecords, int[] recordOID, java.lang.String eSpec, java.lang.String resultSetName) throws PresentException, ConnectionException
nRecord
- The index of the record that the retrieve should start atnRecords
- The maximum number of records that should be returnedrecordOID
- The record object identifiereSpec
- The element spec attribute of the ZClientresultSetName
- The result set name
PresentException
ConnectionException
java.util.Vector scan(java.lang.String[] databases, int nTerms, int step, int position, org.w3c.dom.Node term) throws JaferException, ConnectionException
databases
- An array of database names that are being scannednTerms
- The maximum number of terms to returnstep
- ?????????????????????????????????????????????????????????position
- ?????????????????????????????????????????????????????term
- ?????????????????????????????????????????????????????????
JaferException
ConnectionException
java.util.Vector scan(java.lang.String[] databases, int nTerms, int step, int position, java.lang.Object termObject) throws JaferException, ConnectionException
databases
- An array of database names that are being scannednTerms
- The maximum number of terms to returnstep
- ?????????????????????????????????????????????????????????position
- ?????????????????????????????????????????????????????termObject
- ???????????????????????????????????????????????????
JaferException
ConnectionException
SearchResult[] search(java.lang.Object queryObject, java.lang.String[] databases, java.lang.String resultSetName) throws JaferException, ConnectionException
queryObject
- The query object to search against. Normally RPNNode
or a simple Node that represents a JaferQuerydatabases
- The list of databases to be searchedresultSetName
- The name to be given to the result set
JaferException
ConnectionException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |