Class oclc.z39.Z39scan
All Packages Class Hierarchy This Package Previous Next Index
Class oclc.z39.Z39scan
java.lang.Object
|
+----oclc.z39.Z39api
|
+----oclc.z39.Z39scan
- public class Z39scan
- extends Z39api
Z39scan creates ScanRequests and translates ScanResponses.
- Version:
- @(#)Z39scan.java 1.8 06/27/96
- Author:
- Jenny Colvard
-
displayTerm
- Array of terms.
-
errorCode
- Error code if Scan failed.
-
errorMsg
- Error message if Scan failed.
-
numberOfEntriesReturned
- Number of terms returned.
-
postings
- Array of postings for each term.
-
referenceId
- Value passed to Request and returned by a target Z39.50 server and
Response stores it here.
-
scanStatus
- Status.
-
term
- Array of terms.
-
Z39scan()
-
-
GetScanTerms(DataDir)
- Build term, displayTerm and postings arrays from ScanResponse.
-
Request(int, 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.
-
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.
term
public String term[]
- Array of terms.
displayTerm
public String displayTerm[]
- Array of terms.
postings
public int postings[]
- Array of postings for each term.
Z39scan
public Z39scan()
Request
public BerString Request(int referenceId,
String databaseName,
String term,
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.
GetScanTerms
protected void GetScanTerms(DataDir parm)
- Build term, displayTerm and postings arrays from ScanResponse.
- Parameters:
- parm - ScanResponse z3950_entries field.
toString
public String toString()
- Overrides:
- toString in class Object
termsToString
public String termsToString()
- Format a newline separated String of terms and postings.
All Packages Class Hierarchy This Package Previous Next Index