|
Open SiteSearch 4.1.1 Final |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ORG.oclc.db.Db | +--ORG.oclc.db.DbRemoteZ
DbRemoteZ searches/retrieves/scans a remote Z39.50 database.
DbRemoteZUserData
Fields inherited from class ORG.oclc.db.Db |
CLOSED,
dbNames,
dbVersion,
dumpConfigInfo,
globals,
modeNames,
OPEN,
opsClient,
parents,
sortMap,
UPDATE,
users,
WAITINGTOCLOSE |
Method Summary | |
void |
accessAllowed(Object dbUserData)
Checks to see if the user has access to the database and throws the appropriate exception if not. |
void |
accessControl(Object accessControlResponse,
Object dbUserData)
Process the information from an AccessControl response to set user specific authorization information. |
DbAttributes |
attributes()
Retrieve the DbAttributes object. |
TermInfo[] |
browse(String query,
int preferredPosition,
int numTerms,
DataDir Z39attributesPlusTerm,
DataDir resultSetAttributes,
int stepSize,
Object userData)
Perform a browse. |
protected Key[] |
buildSortKeys(String hitlist,
String[] keys,
int[] order,
Object dedupCriteria,
Object userData)
Return sort keys for the records in the hitlist. |
void |
close()
Free up any resources. |
void |
connect(Object userInformation,
Object dbUserData)
Create a connection to this Db for a user. |
void |
deleteHitlist(String hitlist,
Object userData)
Delete the specified hitlist. |
void |
disconnect(Object userData)
Destroy a connection to this Db for a user. |
ExtSvcData |
extsvc(ExtSvcData esData,
ExtSvcHandler esHandler,
Object userData)
Processes an Extended Services Request for the input task package and returns a response task package DataDir object. |
TermComponentPostings[] |
getComponentResults(String hitlist,
Object userData)
Get the componentResults for the specified hitlist. |
DbResults[] |
getDbResults(String hitlist,
Object userData)
Get the restrictor summaries for the specified hitlist. |
String |
getStats()
|
String[] |
getZTargetInitMsgs(Object userData)
Retrieves a String containing the init msg from the remote Z-target. |
int |
getZTargetInitStatus(Object userData)
Retrieves an integer containing the init status value to the remote Z-target. |
protected boolean |
init(IniFile inifile,
String which)
|
Object |
initDbUserData(String sessionId,
Object access,
Log log,
Object userDbMap)
Creates a database User data object for searching the database - Each database has it's own unique DbUserData object. |
boolean |
OK()
|
int |
postings(String hitlist,
Object userData)
Get postings for a specified hitlist. |
DbPresentData[] |
present(String hitlist,
int startPoint,
int numRecs,
String elementSetName,
String syntax,
Object userData)
Get the specified records from the specified hitlist. |
int |
search(String query,
String hitlist,
boolean replaceFlag,
DataDir Z39attributesPlusTerm,
boolean doRestrictorSummary,
Object additionalSearchInfo,
Object userData)
Send search to remote site. |
void |
sort(String hitlist,
String sortHitlist,
String[] keys,
int[] order,
boolean fUseSortAttributes,
boolean sortAccrossDbs,
Object dupCriteria,
Object userData)
If a local sort has been specified, do it; otherwise, send the sort request to the remote server. |
protected boolean |
supportsScan()
|
protected boolean |
supportsSort()
|
String |
toString()
|
protected void |
unsort(String hitlist,
Object userData)
Unsort the hitlist. |
Methods inherited from class ORG.oclc.db.Db |
browse,
closewhenidle,
dbnames,
deleteHitlist,
filterName,
getDb,
getDbNames,
getDbs,
getGlobals,
getName,
getOpenedFilesCount,
getOutstandingCount,
hasUsers,
numUsers,
openDb,
openDbs,
present,
rolldatabase,
rolldatabaseusers,
search,
setOps,
setSearchMode,
SetupDatabase,
SetupDatabase,
sort,
sort,
updateOpenedFiles |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Method Detail |
public String toString()
protected boolean init(IniFile inifile, String which) throws Exception
inifile
- for parameterswhich
- the section name to read frompublic void close()
public boolean OK()
public DbAttributes attributes()
public DbPresentData[] present(String hitlist, int startPoint, int numRecs, String elementSetName, String syntax, Object userData) throws Diagnostic1, Exception
hitlist
- result set namestartPoint
- starts at 1numRecs
- to retrieveelementSetName
- view of record to retrievesyntax
- in which to return recorddbUserData
- user data containing hitlistspublic int postings(String hitlist, Object userData)
hitlist
- result set namedbUserData
- user data object containing hitlistspublic int search(String query, String hitlist, boolean replaceFlag, DataDir Z39attributesPlusTerm, boolean doRestrictorSummary, Object additionalSearchInfo, Object userData) throws Exception, Diagnostic1, AccessControl
query
- type 0 query or null if this is not type 0hitlist
- result set name to createreplaceFlag
- can this hitlist overwrite a previous one?Z39attributesPlusTerm
- non-type 0 querydoRestrictorSummary
- flag to return a summary of recordsdbUserData
- user data containing hitlistspublic void sort(String hitlist, String sortHitlist, String[] keys, int[] order, boolean fUseSortAttributes, boolean sortAccrossDbs, Object dupCriteria, Object userData) throws Exception, Diagnostic1
hitlist
- result set namesortedList
- result set name for sorted resultskeys
- sort key parametersorder
- ascending or descendingfUseSortAttributes
- flag to sort by use attributessortAccrossDbs
- flag to indicate whether in a cross-db search,
the sort results are merged into 1 list.dupCriteria
- the dedup criteria to use for a dedup sort.
for each record.userData
- user data containing hitlistsprotected void unsort(String hitlist, Object userData)
hitlist
- result set name
userData user data containing hitlistsprotected Key[] buildSortKeys(String hitlist, String[] keys, int[] order, Object dedupCriteria, Object userData) throws Exception, Diagnostic1
hitlist
- result set namekeys
- sort key parametersorder
- ascending or descendingdedupCriteria
- object containing the duplicate criteriauserData
- user data containing hitlistspublic void deleteHitlist(String hitlist, Object userData) throws Exception, Diagnostic1
hitlist
- the one to deletedbUserData
- user data containing hitlistspublic TermInfo[] browse(String query, int preferredPosition, int numTerms, DataDir Z39attributesPlusTerm, DataDir resultSetAttributes, int stepSize, Object userData) throws Exception, Diagnostic1, AccessControl
term
- preferredPosition
- of the query term in the returned listnumTerms
- to returnZ39attributesPlusTerm
- term plus starting point attributesresultSetAttributes
- result set attributes if they are different
from the starting point attributesstepSize
- number of terms between termsdbUserData
- user data containing hitlistspublic DbResults[] getDbResults(String hitlist, Object userData)
hitlist
- result set namedbUserData
- user data containing hitlistspublic TermComponentPostings[] getComponentResults(String hitlist, Object userData)
hitlist
- result set namedbUserData
- user data containing hitlistspublic String getStats()
protected boolean supportsScan()
protected boolean supportsSort()
public Object initDbUserData(String sessionId, Object access, Log log, Object userDbMap)
sessionId
- assigned by something elseaccess
- the object containing access info to connect to an
access serverlog
- the Log object for the user for tracinguserDbMap
- Object containing all the user's database
information objects.public void accessAllowed(Object dbUserData) throws Diagnostic1, AccessControl
userData
- user context data for the databasepublic void connect(Object userInformation, Object dbUserData) throws Diagnostic1
userInformation
- the User Information from the Z39.50 init.public void disconnect(Object userData)
dbUserData
- created by connectpublic ExtSvcData extsvc(ExtSvcData esData, ExtSvcHandler esHandler, Object userData) throws Exception, Diagnostic1, AccessControl
function
- the ES function valuepackageType
- the ES package typeesTask
- the ES task packageuserId
- the userId associated with the ES requestdescription
- the description of the ES requestpackageName
- the name of the ES packagewaitAction
- the ES wait action valueuserData
- the user context informationpublic void accessControl(Object accessControlResponse, Object dbUserData)
accessControlResponse
- object containing the access control
responsedbUserData
- user data containing hitlistspublic String[] getZTargetInitMsgs(Object userData)
public int getZTargetInitStatus(Object userData)
|
Open SiteSearch 4.1.1 Final |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |