Package com.luciad.ogc.csw.model

Class TLcdCSWGetRecordsRequest

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.ogc.csw.model.TLcdCSWRequestBase
com.luciad.ogc.csw.model.TLcdCSWGetRecordsRequest
All Implemented Interfaces:
ILcdDataObject, ILcdOWSRequest, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdCSWGetRecordsRequest extends TLcdCSWRequestBase implements ILcdOWSRequest
The principal means of searching the catalogue. A valid request should have a version and query object.
Since:
2017.0
See Also:

  • Field Details

    • MAX_RECORDS_PROPERTY

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

    • OUTPUT_FORMAT_PROPERTY

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

    • OUTPUT_SCHEMA_PROPERTY

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

    • REQUEST_ID_PROPERTY

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

    • START_POSITION_PROPERTY

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

    • DISTRIBUTED_SEARCH_PROPERTY

      public static final TLcdDataProperty DISTRIBUTED_SEARCH_PROPERTY
      Data property that maps to the DistributedSearch element. The possible values for this property are instances of TLcdCSWDistributedSearch.

    • RESPONSE_HANDLER_PROPERTY

      public static final TLcdDataProperty RESPONSE_HANDLER_PROPERTY
      Data property that maps to the ResponseHandler element. The possible values for this property are instances of List<URI>.

    • QUERY_PROPERTY

      public static final TLcdDataProperty QUERY_PROPERTY
      Data property that maps to the AbstractQuery element. The possible values for this property are instances of TLcdCSWAbstractQuery.

    • ANY_PROPERTY

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

  • Constructor Details

    • TLcdCSWGetRecordsRequest

      public TLcdCSWGetRecordsRequest(TLcdDataType aType)

    • TLcdCSWGetRecordsRequest

      public TLcdCSWGetRecordsRequest(String aVersion)

  • Method Details

    • getKVPEncoding

      public Map getKVPEncoding()
      Description copied from interface: ILcdOWSRequest
      Returns a key-value pair (KVP) encoding of this request.

      If no key-value pairs are defined, an empty map should be returned. If no key-value pair encoding is supported for this request, null should be returned.

      Specified by:
      getKVPEncoding in interface ILcdOWSRequest
      Returns:
      the key-value pair (KVP) representation of this request.

    • getRestEncoding

      public URI getRestEncoding(URI aBaseURI)
      Description copied from interface: ILcdOWSRequest
      Returns a URI that can be used to perform the request.

      If this request cannot be fulfilled through REST, return null.

      Specified by:
      getRestEncoding in interface ILcdOWSRequest
      Parameters:
      aBaseURI - the base URI to be used to construct the REST encoding
      Returns:
      An URI that can fulfill the request, or null if REST is not supported.

    • getXMLEncoding

      public InputStream getXMLEncoding()
      Description copied from interface: ILcdOWSRequest
      Returns the XML encoding of this request.

      If no XML encoding is supported for this request, nullshould be returned.

      Specified by:
      getXMLEncoding in interface ILcdOWSRequest
      Returns:
      the XML representation of this request.

    • getTransportData

      public Object getTransportData()
      Description copied from interface: ILcdOWSRequest
      Returns an object representing data to be used by the transportation layer (see ILcdOWSTransport) to perform this OGC Web Service request. The type of object and the data contained in it depends on the ILcdOWSTransport object used to perform this request.

      An example in the case of a HTTP transport connection is a map of request properties (see URLConnection.getRequestProperties()) to be used for the request.

      Specified by:
      getTransportData in interface ILcdOWSRequest
      Returns:
      an object representing data to be used by the transportation layer to perform this OGC Web Service request.

    • getMaxRecords

      public long getMaxRecords()
      Returns the value of the property that maps to the maxRecords attribute.
      Returns:
      the value of the MAX_RECORDS_PROPERTY property.

    • setMaxRecords

      public void setMaxRecords(long aValue)
      Sets the value of the property that maps to the maxRecords attribute.
      Parameters:
      aValue - the value to set for the MAX_RECORDS_PROPERTY property.

    • getOutputFormat

      public String getOutputFormat()
      Returns the value of the property that maps to the outputFormat attribute.
      Returns:
      the value of the OUTPUT_FORMAT_PROPERTY property.

    • setOutputFormat

      public void setOutputFormat(String aValue)
      Sets the value of the property that maps to the outputFormat attribute.
      Parameters:
      aValue - the value to set for the OUTPUT_FORMAT_PROPERTY property.

    • getOutputSchema

      public URI getOutputSchema()
      Returns the value of the property that maps to the outputSchema attribute.
      Returns:
      the value of the OUTPUT_SCHEMA_PROPERTY property.

    • setOutputSchema

      public void setOutputSchema(URI aValue)
      Sets the value of the property that maps to the outputSchema attribute.
      Parameters:
      aValue - the value to set for the OUTPUT_SCHEMA_PROPERTY property.

    • getRequestId

      public URI getRequestId()
      Returns the value of the property that maps to the requestId attribute.

      requestId becomes mandatory in the case of a distributed search. Must be a unique Id (i.e. a UUID).

      Returns:
      the value of the REQUEST_ID_PROPERTY property.

    • setRequestId

      public void setRequestId(URI aValue)
      Sets the value of the property that maps to the requestId attribute.

      requestId becomes mandatory in the case of a distributed search. Must be a unique Id (i.e. a UUID).

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

    • getStartPosition

      public long getStartPosition()
      Returns the value of the property that maps to the startPosition attribute.
      Returns:
      the value of the START_POSITION_PROPERTY property.

    • setStartPosition

      public void setStartPosition(long aValue)
      Sets the value of the property that maps to the startPosition attribute.
      Parameters:
      aValue - the value to set for the START_POSITION_PROPERTY property.

    • getDistributedSearch

      public TLcdCSWDistributedSearch getDistributedSearch()
      Returns the value of the property that maps to the DistributedSearch element.
      Returns:
      the value of the DISTRIBUTED_SEARCH_PROPERTY property.

    • setDistributedSearch

      public void setDistributedSearch(TLcdCSWDistributedSearch aValue)
      Sets the value of the property that maps to the DistributedSearch element.
      Parameters:
      aValue - the value to set for the DISTRIBUTED_SEARCH_PROPERTY property.

    • getResponseHandler

      public List<URI> getResponseHandler()
      Returns the value of the property that maps to the ResponseHandler element.
      Returns:
      the value of the RESPONSE_HANDLER_PROPERTY property.

    • getQuery

      public TLcdCSWAbstractQuery getQuery()
      Returns the value of the property that maps to the AbstractQuery element.
      Returns:
      the value of the QUERY_PROPERTY property.

    • setQuery

      public void setQuery(TLcdCSWAbstractQuery aValue)
      Sets the value of the property that maps to the AbstractQuery element.
      Parameters:
      aValue - the value to set for the QUERY_PROPERTY property.

    • getAny

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

    • setAny

      public void setAny(Object aValue)
      Sets the value of the any property.
      Parameters:
      aValue - the value to set for the ANY_PROPERTY property.