org.deegree.ogcwebservices.csw.discovery
Class SearchResults

java.lang.Object
  org.deegree.ogcwebservices.csw.discovery.SearchResults

public class SearchResults
extends java.lang.Object

Class representation of a <csw:SearchResults>-element. The SearchResults is a generic container for the actual response to a GetRecords request. The content of the SearchResults is the set of records returned by the GetRecords operation. The actual records returned by the catalogue should substitute for AbstractRecord.

Version:

2.0, $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18 Jun 2009) $

Author:

Andreas Poth , Torsten Friebe , Markus Schneider , last edited by: $Author: mschneider $

Constructor Summary

SearchResults(java.lang.String requestId, java.lang.String resultSetId, java.lang.String elementSet, java.lang.String recordSchema, int numberOfRecordsReturned, int numberOfRecordsMatched, int nextRecord, org.w3c.dom.Node recordsParentNode, java.lang.String expires)

Method Summary

java.lang.String	getElementSet() The element set returned (brief, summary or full).
java.util.Date	getExpires()
int	getNextRecord() Start position of next record.
int	getNumberOfRecordsMatched() Number of records found by the GetRecords operation
int	getNumberOfRecordsReturned() Number of records actually returned to client.
org.w3c.dom.Node	getRecords() Returns the contents of the <SearchResults>-element.
java.net.URI	getRecordSchema() A reference to the type or schema of the records returned.
java.net.URI	getRequestId()
java.net.URI	getResultSetId() A server-generated identifier for the result set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchResults

SearchResults(java.lang.String requestId,
              java.lang.String resultSetId,
              java.lang.String elementSet,
              java.lang.String recordSchema,
              int numberOfRecordsReturned,
              int numberOfRecordsMatched,
              int nextRecord,
              org.w3c.dom.Node recordsParentNode,
              java.lang.String expires)
        throws InvalidParameterValueException

Parameters:

requestId -

resultSetId -

elementSet -

recordSchema -

numberOfRecordsReturned -

nextRecord -

recordsParentNode -

Throws:

InvalidParameterValueException

Method Detail

getRequestId

public java.net.URI getRequestId()

Returns:

the id

getResultSetId

public java.net.URI getResultSetId()

A server-generated identifier for the result set. May be used in subsequent GetRecords operations to further refine the result set. If the server does not implement this capability then the attribute should be omitted.

Returns:

the id

getElementSet

public java.lang.String getElementSet()

The element set returned (brief, summary or full). This is null if getElementNames of GetRecord!= null; Optional

Returns:

brief, summary or full

getRecordSchema

public java.net.URI getRecordSchema()

A reference to the type or schema of the records returned. Optional

Returns:

schema

getNumberOfRecordsMatched

public int getNumberOfRecordsMatched()

Number of records found by the GetRecords operation

Returns:

the number

getNumberOfRecordsReturned

public int getNumberOfRecordsReturned()

Number of records actually returned to client. This may not be the entire result set since some servers may limit the number of records returned to limit the size of the response package transmitted to the client. Subsequent queries may be executed to see more of the result set. The nextRecord attribute will indicate to the client where to begin the next query

Returns:

the number

getNextRecord

public int getNextRecord()

Start position of next record. A value of 0 means all records have been returned.

Returns:

the position

getRecords

public org.w3c.dom.Node getRecords()

Returns the contents of the <SearchResults>-element.

Returns:

a node

getExpires

public java.util.Date getExpires()

Returns:

the expiration date