nl.b3p.csw.jaxb.csw

Class SearchResultsType

java.lang.Object

nl.b3p.csw.jaxb.csw.SearchResultsType

public class SearchResultsType
extends Object

Includes representations of result set members if maxRecords > 0. The items must conform to one of the csw:Record views or a profile-specific representation. resultSetId - id of the result set (a URI). elementSet - The element set that has been returned (i.e., "brief", "summary", "full") recordSchema - schema reference for included records(URI) numberOfRecordsMatched - number of records matched by the query numberOfRecordsReturned - number of records returned to client nextRecord - position of next record in the result set (0 if no records remain). expires - the time instant when the result set expires and is discarded (ISO 8601 format)

Java class for SearchResultsType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="SearchResultsType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <element ref="{http://www.opengis.net/cat/csw/2.0.2}AbstractRecord" maxOccurs="unbounded" minOccurs="0"/>
           <any processContents='skip' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
         </choice>
       </sequence>
       <attribute name="resultSetId" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="elementSet" type="{http://www.opengis.net/cat/csw/2.0.2}ElementSetType" />
       <attribute name="recordSchema" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="numberOfRecordsMatched" use="required" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" />
       <attribute name="numberOfRecordsReturned" use="required" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" />
       <attribute name="nextRecord" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" />
       <attribute name="expires" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<JAXBElement<? extends AbstractRecordType>>	abstractRecord
protected List<Element>	any
protected ElementSetType	elementSet
protected XMLGregorianCalendar	expires
protected BigInteger	nextRecord
protected BigInteger	numberOfRecordsMatched
protected BigInteger	numberOfRecordsReturned
protected String	recordSchema
protected String	resultSetId

Constructor Summary

Constructors

Constructor and Description
SearchResultsType() Default no-arg constructor
SearchResultsType(List<JAXBElement<? extends AbstractRecordType>> abstractRecord, List<Element> any, String resultSetId, ElementSetType elementSet, String recordSchema, BigInteger numberOfRecordsMatched, BigInteger numberOfRecordsReturned, BigInteger nextRecord, XMLGregorianCalendar expires) Fully-initialising value constructor

Method Summary

Modifier and Type	Method and Description
List<JAXBElement<? extends AbstractRecordType>>	getAbstractRecord() Gets the value of the abstractRecord property.
List<Element>	getAny() Gets the value of the any property.
ElementSetType	getElementSet() Gets the value of the elementSet property.
XMLGregorianCalendar	getExpires() Gets the value of the expires property.
BigInteger	getNextRecord() Gets the value of the nextRecord property.
BigInteger	getNumberOfRecordsMatched() Gets the value of the numberOfRecordsMatched property.
BigInteger	getNumberOfRecordsReturned() Gets the value of the numberOfRecordsReturned property.
String	getRecordSchema() Gets the value of the recordSchema property.
String	getResultSetId() Gets the value of the resultSetId property.
void	setElementSet(ElementSetType value) Sets the value of the elementSet property.
void	setExpires(XMLGregorianCalendar value) Sets the value of the expires property.
void	setNextRecord(BigInteger value) Sets the value of the nextRecord property.
void	setNumberOfRecordsMatched(BigInteger value) Sets the value of the numberOfRecordsMatched property.
void	setNumberOfRecordsReturned(BigInteger value) Sets the value of the numberOfRecordsReturned property.
void	setRecordSchema(String value) Sets the value of the recordSchema property.
void	setResultSetId(String value) Sets the value of the resultSetId property.

Methods inherited from class java.lang.Object

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

Field Detail

abstractRecord

protected List<JAXBElement<? extends AbstractRecordType>> abstractRecord

any

protected List<Element> any

resultSetId

protected String resultSetId

elementSet

protected ElementSetType elementSet

recordSchema

protected String recordSchema

numberOfRecordsMatched

protected BigInteger numberOfRecordsMatched

numberOfRecordsReturned

protected BigInteger numberOfRecordsReturned

nextRecord

protected BigInteger nextRecord

expires

protected XMLGregorianCalendar expires

Constructor Detail

SearchResultsType

public SearchResultsType()

Default no-arg constructor

SearchResultsType

public SearchResultsType(List<JAXBElement<? extends AbstractRecordType>> abstractRecord,
                         List<Element> any,
                         String resultSetId,
                         ElementSetType elementSet,
                         String recordSchema,
                         BigInteger numberOfRecordsMatched,
                         BigInteger numberOfRecordsReturned,
                         BigInteger nextRecord,
                         XMLGregorianCalendar expires)

Fully-initialising value constructor

Method Detail

getAbstractRecord

public List<JAXBElement<? extends AbstractRecordType>> getAbstractRecord()

Gets the value of the abstractRecord property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the abstractRecord property.

For example, to add a new item, do as follows:

    getAbstractRecord().add(newItem);
 

Objects of the following type(s) are allowed in the list AbstractRecord SummaryRecord BriefRecord DCMIRecord Record

getAny

public List<Element> getAny()

Gets the value of the any property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the any property.

For example, to add a new item, do as follows:

    getAny().add(newItem);
 

Objects of the following type(s) are allowed in the list Element

getResultSetId

public String getResultSetId()

Gets the value of the resultSetId property.

Returns:

possible object is String

setResultSetId

public void setResultSetId(String value)

Sets the value of the resultSetId property.

Parameters:

value - allowed object is String

getElementSet

public ElementSetType getElementSet()

Gets the value of the elementSet property.

Returns:

possible object is ElementSetType

setElementSet

public void setElementSet(ElementSetType value)

Sets the value of the elementSet property.

Parameters:

value - allowed object is ElementSetType

getRecordSchema

public String getRecordSchema()

Gets the value of the recordSchema property.

Returns:

possible object is String

setRecordSchema

public void setRecordSchema(String value)

Sets the value of the recordSchema property.

Parameters:

value - allowed object is String

getNumberOfRecordsMatched

public BigInteger getNumberOfRecordsMatched()

Gets the value of the numberOfRecordsMatched property.

Returns:

possible object is BigInteger

setNumberOfRecordsMatched

public void setNumberOfRecordsMatched(BigInteger value)

Sets the value of the numberOfRecordsMatched property.

Parameters:

value - allowed object is BigInteger

getNumberOfRecordsReturned

public BigInteger getNumberOfRecordsReturned()

Gets the value of the numberOfRecordsReturned property.

Returns:

possible object is BigInteger

setNumberOfRecordsReturned

public void setNumberOfRecordsReturned(BigInteger value)

Sets the value of the numberOfRecordsReturned property.

Parameters:

value - allowed object is BigInteger

getNextRecord

public BigInteger getNextRecord()

Gets the value of the nextRecord property.

Returns:

possible object is BigInteger

setNextRecord

public void setNextRecord(BigInteger value)

Sets the value of the nextRecord property.

Parameters:

value - allowed object is BigInteger

getExpires

public XMLGregorianCalendar getExpires()

Gets the value of the expires property.

Returns:

possible object is XMLGregorianCalendar

setExpires

public void setExpires(XMLGregorianCalendar value)

Sets the value of the expires property.

Parameters:

value - allowed object is XMLGregorianCalendar