Package com.luciad.ogc.csw.model

Class TLcdCSWSearchResults

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.ogc.csw.model.TLcdCSWSearchResults
All Implemented Interfaces:
ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdCSWSearchResults extends TLcdDataObject
Includes representations of result set members if maxRecords > 0. The items must conform to one of the csw30:Record views or a profile-specific representation. 
         resultSetId - id of the result set (a URI).
         elementSet - The element set that has been returned
         (e.g., "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 (ISO8601 format)
         elapsedTime - runtime information of the search
         within the federated catalogue
Since:
2017.0

  • Field Details

    • ELAPSED_TIME_PROPERTY

      public static final TLcdDataProperty ELAPSED_TIME_PROPERTY
      Data property that maps to the elapsedTime attribute. The possible values for this property are instances of Long.

    • ELEMENT_SET_PROPERTY

      public static final TLcdDataProperty ELEMENT_SET_PROPERTY
      Data property that maps to the elementSet attribute. The possible values for this property are instances of

    • EXPIRES_PROPERTY

      public static final TLcdDataProperty EXPIRES_PROPERTY
      Data property that maps to the expires attribute. The possible values for this property are instances of XMLGregorianCalendar.

    • NEXT_RECORD_PROPERTY

      public static final TLcdDataProperty NEXT_RECORD_PROPERTY
      Data property that maps to the nextRecord attribute. The possible values for this property are instances of Long.

    • NUMBER_OF_RECORDS_MATCHED_PROPERTY

      public static final TLcdDataProperty NUMBER_OF_RECORDS_MATCHED_PROPERTY
      Data property that maps to the numberOfRecordsMatched attribute. The possible values for this property are instances of long.

    • NUMBER_OF_RECORDS_RETURNED_PROPERTY

      public static final TLcdDataProperty NUMBER_OF_RECORDS_RETURNED_PROPERTY
      Data property that maps to the numberOfRecordsReturned attribute. The possible values for this property are instances of long.

    • RECORD_SCHEMA_PROPERTY

      public static final TLcdDataProperty RECORD_SCHEMA_PROPERTY
      Data property that maps to the recordSchema attribute. The possible values for this property are instances of URI.

    • RESULT_SET_ID_PROPERTY

      public static final TLcdDataProperty RESULT_SET_ID_PROPERTY
      Data property that maps to the resultSetId attribute. The possible values for this property are instances of URI.

    • STATUS_PROPERTY

      public static final TLcdDataProperty STATUS_PROPERTY
      Data property that maps to the status attribute. The possible values for this property are instances of ELcdCSWResultsStatus.

    • RECORDS_PROPERTY

      public static final TLcdDataProperty RECORDS_PROPERTY
      Data property that maps to the AbstractRecord element. The possible values for this property are instances of List<TLcdCSWAbstractRecord>.

    • ANY_PROPERTY

      public static final TLcdDataProperty ANY_PROPERTY
      Data any property. The possible values for this property are instances of List<Object>.

    • FEDERATED_SEARCH_RESULT_BASE_PROPERTY

      public static final TLcdDataProperty FEDERATED_SEARCH_RESULT_BASE_PROPERTY
      Data property that maps to the FederatedSearchResultBase element. The possible values for this property are instances of List<ILcdDataObject>.

  • Constructor Details

    • TLcdCSWSearchResults

      public TLcdCSWSearchResults()

    • TLcdCSWSearchResults

      public TLcdCSWSearchResults(TLcdDataType aType)

  • Method Details

    • getElapsedTime

      public Long getElapsedTime()
      Returns the value of the property that maps to the elapsedTime attribute.
      Returns:
      the value of the ELAPSED_TIME_PROPERTY property.

    • setElapsedTime

      public void setElapsedTime(Long aValue)
      Sets the value of the property that maps to the elapsedTime attribute.
      Parameters:
      aValue - the value to set for the ELAPSED_TIME_PROPERTY property.

    • getElementSet

      public TLcdCSWElementSet getElementSet()
      Returns the value of the property that maps to the elementSet attribute.

      The possible values for this property are instances of

      Returns:
      the value of the ELEMENT_SET_PROPERTY property.

    • setElementSet

      public void setElementSet(TLcdCSWElementSet aValue)
      Sets the value of the property that maps to the elementSet attribute.

      The possible values for this property are instances of

      Parameters:
      aValue - the value to set for the ELEMENT_SET_PROPERTY property.

    • getExpires

      public XMLGregorianCalendar getExpires()
      Returns the value of the property that maps to the expires attribute.
      Returns:
      the value of the EXPIRES_PROPERTY property.

    • setExpires

      public void setExpires(XMLGregorianCalendar aValue)
      Sets the value of the property that maps to the expires attribute.
      Parameters:
      aValue - the value to set for the EXPIRES_PROPERTY property.

    • getNextRecord

      public Long getNextRecord()
      Returns the value of the property that maps to the nextRecord attribute.
      Returns:
      the value of the NEXT_RECORD_PROPERTY property.

    • setNextRecord

      public void setNextRecord(Long aValue)
      Sets the value of the property that maps to the nextRecord attribute.
      Parameters:
      aValue - the value to set for the NEXT_RECORD_PROPERTY property.

    • getNumberOfRecordsMatched

      public long getNumberOfRecordsMatched()
      Returns the value of the property that maps to the numberOfRecordsMatched attribute.
      Returns:
      the value of the NUMBER_OF_RECORDS_MATCHED_PROPERTY property.

    • setNumberOfRecordsMatched

      public void setNumberOfRecordsMatched(long aValue)
      Sets the value of the property that maps to the numberOfRecordsMatched attribute.
      Parameters:
      aValue - the value to set for the NUMBER_OF_RECORDS_MATCHED_PROPERTY property.

    • getNumberOfRecordsReturned

      public long getNumberOfRecordsReturned()
      Returns the value of the property that maps to the numberOfRecordsReturned attribute.
      Returns:
      the value of the NUMBER_OF_RECORDS_RETURNED_PROPERTY property.

    • setNumberOfRecordsReturned

      public void setNumberOfRecordsReturned(long aValue)
      Sets the value of the property that maps to the numberOfRecordsReturned attribute.
      Parameters:
      aValue - the value to set for the NUMBER_OF_RECORDS_RETURNED_PROPERTY property.

    • getRecordSchema

      public URI getRecordSchema()
      Returns the value of the property that maps to the recordSchema attribute.
      Returns:
      the value of the RECORD_SCHEMA_PROPERTY property.

    • setRecordSchema

      public void setRecordSchema(URI aValue)
      Sets the value of the property that maps to the recordSchema attribute.
      Parameters:
      aValue - the value to set for the RECORD_SCHEMA_PROPERTY property.

    • getResultSetId

      public URI getResultSetId()
      Returns the value of the property that maps to the resultSetId attribute.
      Returns:
      the value of the RESULT_SET_ID_PROPERTY property.

    • setResultSetId

      public void setResultSetId(URI aValue)
      Sets the value of the property that maps to the resultSetId attribute.
      Parameters:
      aValue - the value to set for the RESULT_SET_ID_PROPERTY property.

    • getStatus

      public ELcdCSWResultsStatus getStatus()
      Returns the value of the property that maps to the status attribute.
      Returns:
      the value of the STATUS_PROPERTY property.

    • setStatus

      public void setStatus(ELcdCSWResultsStatus aValue)
      Sets the value of the property that maps to the status attribute.
      Parameters:
      aValue - the value to set for the STATUS_PROPERTY property.

    • getRecords

      public List<TLcdCSWAbstractRecord> getRecords()
      Returns the value of the property that maps to the AbstractRecord element.
      Returns:
      the value of the RECORDS_PROPERTY property.

    • getAny

      public List<Object> getAny()
      Returns the value of the any property.
      Returns:
      the value of the ANY_PROPERTY property.

    • getFederatedSearchResultBase

      public List<ILcdDataObject> getFederatedSearchResultBase()
      Returns the value of the property that maps to the FederatedSearchResultBase element.
      Returns:
      the value of the FEDERATED_SEARCH_RESULT_BASE_PROPERTY property.