All Packages Class Hierarchy This Package Previous Next Index
Class ORG.oclc.z39.client.Z39scan
java.lang.Object
|
+----ORG.oclc.z39.client.Z39scan
- public class Z39scan
- extends Object
Z39scan creates ScanRequests and translates ScanResponses.
- Version:
- @(#)Z39scan.java 1.1 07/09/97
-
errorCode
- Error code if Scan failed.
-
errorMsg
- Error message if Scan failed.
-
numberOfEntriesReturned
- Number of terms returned.
-
referenceId
- Value passed to Request and returned by a target Z39.50 server and
Response stores it here.
-
scanStatus
- Status.
-
terms
- Scan results
-
zsession
- Z39session
-
Z39scan()
-
-
Z39scan(Z39session)
-
-
doScan(int, String, String, String, int, int, int)
- Creates and sends a Z39.50 ScanRequest, processes a Z39.50 Scan Response
-
Request(int, String, String, String, int, int, int)
- Creates a Z39.50 ScanRequest.
-
Request(int, String, String, String, int, int, int, int, int)
- Creates a Z39.50 ScanRequest.
-
Response(BerString)
- Processes a Z39.50 ScanResponse.
-
Response(DataDir)
- Processes a Z39.50 ScanResponse.
-
sortTerms(TermInfo[])
-
-
termsToString()
- Format a newline separated String of terms and postings.
-
toString()
-
referenceId
public int referenceId
- Value passed to Request and returned by a target Z39.50 server and
Response stores it here.
numberOfEntriesReturned
public int numberOfEntriesReturned
- Number of terms returned.
scanStatus
public int scanStatus
- Status.
errorCode
public int errorCode
- Error code if Scan failed.
errorMsg
public String errorMsg
- Error message if Scan failed.
terms
public TermInfo terms[]
- Scan results
zsession
public Z39session zsession
- Z39session
Z39scan
public Z39scan()
Z39scan
public Z39scan(Z39session z)
doScan
public boolean doScan(int referenceId,
String databaseName,
String term,
String resultsAttributes,
int stepSize,
int numberOfTermsRequested,
int preferredPositionInResponse) throws Exception
- Creates and sends a Z39.50 ScanRequest, processes a Z39.50 Scan Response
- Parameters:
- referenceId - Will be returned on Response.
- databaseName - Database to be Scanned.
- term - Starting point for Scan.
- stepSize - 'N' means Newton indexes ???.
- numberOfTermsRequested - How many terms to return.
- preferredPositionInResponse - Where the Scan term should appear in the
list.
- Returns:
- boolean. Failures occur when the request cannot be built or response
cannot be processed
- Throws: Exception
- exceptions from Z39Connect
Request
public BerString Request(int referenceId,
String databaseName,
String term,
String resultsAttributes,
int stepSize,
int numberOfTermsRequested,
int preferredPositionInResponse)
- Creates a Z39.50 ScanRequest.
- Parameters:
- referenceId - Will be returned on Response.
- databaseName - Database to be Scanned.
- term - Starting point for Scan.
- stepSize - 'N' means Newton indexes ???.
- numberOfTermsRequested - How many terms to return.
- preferredPositionInResponse - Where the Scan term should appear in the
list.
- Returns:
- BerString containing Request or null if space was unavailable.
Request
public BerString Request(int referenceId,
String databaseName,
String term,
String resultsAttributes,
int stepSize,
int numberOfTermsRequested,
int preferredPositionInResponse,
int extraLen,
int offset)
- Creates a Z39.50 ScanRequest.
- Parameters:
- referenceId - Will be returned on Response.
- databaseName - Database to be Scanned.
- term - Starting point for Scan.
- stepSize - 'N' means Newton indexes ???.
- numberOfTermsRequested - How many terms to return.
- preferredPositionInResponse - Where the Scan term should appear in the
list.
- extraLen - Allow this much extra room in the built BER record.
- offset - Build the Request at this offset in the BerString.
- Returns:
- BerString containing Request or null if space was unavailable.
Response
public void Response(BerString response)
- Processes a Z39.50 ScanResponse.
- Parameters:
- response - BerString containing response.
Response
public void Response(DataDir response)
- Processes a Z39.50 ScanResponse.
- Parameters:
- response - DataDir containing response.
toString
public String toString()
- Overrides:
- toString in class Object
termsToString
public String termsToString()
- Format a newline separated String of terms and postings.
'united'('united') 17 (use=21;oluc:3;maps:9)
sortTerms
public void sortTerms(TermInfo sort[])
All Packages Class Hierarchy This Package Previous Next Index