All Packages Class Hierarchy This Package Previous Next Index
Class ORG.oclc.z39.client.Z39present
java.lang.Object
|
+----ORG.oclc.z39.client.Z39present
- public class Z39present
- extends Object
Z39present creates PresentRequests and translates PresentResponses.
- Version:
- %W% %G%
-
errorCode
- Error code if Present failed.
-
errorMsg
- Error message if Present failed.
-
nextResultsSetPosition
- Starting point for next PresentRequest.
-
numberOfRecordsReturned
- Number of records returned in Response.
-
presentStatus
- Status.
-
recDirs
- Array of dataDirs filled in by decodeRecords.
-
records
- Array of records returned in Response.
-
recordSyntax
- Syntax of returned records.
-
referenceId
- Value passed to Request and returned by a target Z39.50 server and
Response stores it here.
-
Z39present()
-
-
Z39present(Z39session)
-
-
decodeRecords()
-
-
doPresent(int, String, int, int, int, String, String, boolean)
- Creates, sends and proceeses a Z39.50 PresentRequest until the number of Records
requested is returned or there is a failure
-
Request(int, String, int, int, String, String)
- Creates a Z39.50 PresentRequest.
-
Request(int, String, int, int, String, String, int, int)
- Creates a Z39.50 PresentRequest.
-
Response(BerString)
- Processes a Z39.50 PresentResponse.
-
Response(DataDir)
- Processes a Z39.50 PresentResponse.
-
toString()
-
referenceId
public int referenceId
- Value passed to Request and returned by a target Z39.50 server and
Response stores it here.
numberOfRecordsReturned
public int numberOfRecordsReturned
- Number of records returned in Response.
nextResultsSetPosition
public int nextResultsSetPosition
- Starting point for next PresentRequest.
presentStatus
public int presentStatus
- Status.
errorCode
public int errorCode
- Error code if Present failed.
errorMsg
public String errorMsg
- Error message if Present failed.
recordSyntax
public String recordSyntax
- Syntax of returned records.
records
public BerString records[]
- Array of records returned in Response.
recDirs
public Vector recDirs
- Array of dataDirs filled in by decodeRecords.
Z39present
public Z39present()
Z39present
public Z39present(Z39session z)
doPresent
public boolean doPresent(int referenceId,
String resultSetName,
int resultSetStartPoint,
int numberOfRecordsRequested,
int resultSetEndPoint,
String ElementSetNames,
String preferredRecordSyntax,
boolean fMakeDataDir) throws Exception
- Creates, sends and proceeses a Z39.50 PresentRequest until the number of Records
requested is returned or there is a failure
- Parameters:
- referenceId - Will be returned on Response.
- resultSetName - Identifies the results from a SearchRequest.
- resultSetStartPoint - Relative number of first record to Present.
- numberOfRecordsRequested - Number of records to return.
- resultSetEndPoint - number of postings Plus the relative number of the first record to present
- ElementSetNames - Requested data in returned records.
- preferredRecordSyntax - Requested syntax of returned records.
- fMakeDataDir - flag to indicate whether decode to decode record
data into a DataDir which fills in the recDirs Vector
- Returns:
- boolean containing the result of the present request.
- Throws: Exception
- exceptions from Z39Connect
Request
public BerString Request(int referenceId,
String resultSetName,
int resultSetStartPoint,
int numberOfRecordsRequested,
String ElementSetNames,
String preferredRecordSyntax)
- Creates a Z39.50 PresentRequest.
- Parameters:
- referenceId - Will be returned on Response.
- resultSetName - Identifies the results from a SearchRequest.
- resultSetStartPoint - Relative number of first record to Present.
- numberOfRecordsRequested - Number of records to return.
- ElementSetNames - Requested data in returned records.
- preferredRecordSyntax - Requested syntax of returned records.
- Returns:
- BerString containing Request or null if space was unavailable
Request
public BerString Request(int referenceId,
String resultSetName,
int resultSetStartPoint,
int numberOfRecordsRequested,
String ElementSetNames,
String preferredRecordSyntax,
int extraLen,
int offset)
- Creates a Z39.50 PresentRequest.
- Parameters:
- referenceId - Will be returned on Response.
- resultSetName - Identifies the results from a SearchRequest.
- resultSetStartPoint - Relative number of first record to Present.
- numberOfRecordsRequested - Number of records to return.
- ElementSetNames - Requested data in returned records.
- preferredRecordSyntax - Requested syntax of returned records.
- 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 PresentResponse.
- Parameters:
- response - BerString containing response.
Response
public void Response(DataDir response)
- Processes a Z39.50 PresentResponse.
- Parameters:
- response - DataDir containing response
toString
public String toString()
- Overrides:
- toString in class Object
decodeRecords
public boolean decodeRecords()
All Packages Class Hierarchy This Package Previous Next Index