All Packages Class Hierarchy This Package Previous Next Index
Class ORG.oclc.z39.client.Z39sort
java.lang.Object
|
+----ORG.oclc.z39.client.Z39sort
- public class Z39sort
- extends Object
Z39sort creates SortRequests and translates SortResponses.
- Version:
- @(#)Z39sort.java 1.22 02/24/97
-
errorCode
-
-
errorMsg
- Error message if Sort failed.
-
referenceId
- Value passed to Request and returned by a target Z39.50 server and
Response stores it here.
-
sortStatus
- Status.
-
Z39sort()
-
-
Z39sort(Z39session)
-
-
doSort(int, String, String, String[], int[], boolean)
- Creates and sends a Z39.50 SortRequest, gets and processes the Z39.50 response
-
Request(int, String, String, String[], int[], boolean)
- Creates a Z39.50 SortRequest.
-
Request(int, String, String, String[], int[], boolean, int, int)
- Creates a Z39.50 SortRequest.
-
Response(BerString)
-
-
Response(DataDir)
-
-
toString()
-
referenceId
public int referenceId
- Value passed to Request and returned by a target Z39.50 server and
Response stores it here.
sortStatus
public int sortStatus
- Status.
errorCode
public int errorCode
errorMsg
public String errorMsg
- Error message if Sort failed.
Z39sort
public Z39sort(Z39session z)
Z39sort
public Z39sort()
doSort
public boolean doSort(int referenceId,
String resultSetName,
String sortResultSetName,
String sortKeys[],
int sortOrder[],
boolean fUseSortAttributes) throws Exception
- Creates and sends a Z39.50 SortRequest, gets and processes the Z39.50 response
- Parameters:
- referenceId - Will be returned on Response.
- resultSetName - name of the resultSet to sort
- sortResultSetName - name of the sorted resultSet
- sortKeys - array of sort keys
- sortOrder - array of the order to sort corresponding to the sort keys
- fUseSortAttributes - flag to indicate how to build the sort request. true=request uses the sortAttributes encoding. see the Z39.50 specification
- Returns:
- boolean indicating success or failure of request
Request
public BerString Request(int referenceId,
String resultSetName,
String sortResultSetName,
String sortKeys[],
int sortOrder[],
boolean fUseSortAttributes)
- Creates a Z39.50 SortRequest.
- Parameters:
- referenceId - Will be returned on Response.
- resultSetName - name of the resultSet to sort
- sortResultSetName - name of the sorted resultSet
- sortKeys - array of sort keys
- sortOrder - array of the order to sort corresponding to the sort keys
- fUseSortAttributes - flag to indicate how to build the sort request. true=request uses the sortAttributes encoding. see the Z39.50 specification
- Returns:
- BerString containing Request or null if space was unavailable
Request
public BerString Request(int referenceId,
String resultSetName,
String sortResultSetName,
String sortKeys[],
int sortOrder[],
boolean fUseSortAttributes,
int extraLen,
int offset)
- Creates a Z39.50 SortRequest.
- Parameters:
- referenceId - Will be returned on Response.
- resultSetName - name of the resultSet to sort
- sortResultSetName - name of the sorted resultSet
- sortKeys - array of sort keys up to 6
- sortOrder - array of the order to sort corresponding to the sort keys
- fUseSortAttributes - flag to indicate how to build the sort request. true=request uses the sortAttributes encoding. see the Z39.50 specification
- 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)
Response
public void Response(DataDir response)
toString
public String toString()
- Overrides:
- toString in class Object
All Packages Class Hierarchy This Package Previous Next Index