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

Variable Index

 o displayTerm
Array of terms.
 o errorCode
Error code if Scan failed.
 o errorMsg
Error message if Scan failed.
 o numberOfEntriesReturned
Number of terms returned.
 o postings
Array of postings for each term.
 o referenceId
Value passed to Request and returned by a target Z39.50 server and Response stores it here.
 o scanStatus
Status.
 o term
Array of terms.

Constructor Index

 o Z39scan()

Method Index

 o GetScanTerms(DataDir)
Build term, displayTerm and postings arrays from ScanResponse.
 o Request(int, String, String, int, int, int, int, int)
Creates a Z39.50 ScanRequest.
 o Response(BerString)
Processes a Z39.50 ScanResponse.
 o Response(DataDir)
Processes a Z39.50 ScanResponse.
 o termsToString()
Format a newline separated String of terms and postings.
 o toString()

Variables

 o referenceId
  public int referenceId
Value passed to Request and returned by a target Z39.50 server and Response stores it here.
 o numberOfEntriesReturned
  public int numberOfEntriesReturned
Number of terms returned.
 o scanStatus
  public int scanStatus
Status.
 o errorCode
  public int errorCode
Error code if Scan failed.
 o errorMsg
  public String errorMsg
Error message if Scan failed.
 o term
  public String term[]
Array of terms.
 o displayTerm
  public String displayTerm[]
Array of terms.
 o postings
  public int postings[]
Array of postings for each term.

Constructors

 o Z39scan
  public Z39scan()

Methods

 o 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.
 o Response
  public void Response(BerString response)
Processes a Z39.50 ScanResponse.
Parameters:
response - BerString containing response.
 o Response
  public void Response(DataDir response)
Processes a Z39.50 ScanResponse.
Parameters:
response - DataDir containing response.
 o GetScanTerms
  protected void GetScanTerms(DataDir parm)
Build term, displayTerm and postings arrays from ScanResponse.
Parameters:
parm - ScanResponse z3950_entries field.
 o toString
  public String toString()
Overrides:
toString in class Object
 o termsToString
  public String termsToString()
Format a newline separated String of terms and postings.

All Packages  Class Hierarchy  This Package  Previous  Next  Index