Class TLcdCSWGetRecordByIdRequest

All Implemented Interfaces:
ILcdDataObject, ILcdOWSRequest, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdCSWGetRecordByIdRequest extends TLcdCSWRequestBase implements ILcdOWSRequest
Convenience operation to retrieve default record representations by identifier.
Aside from this identifier, a valid request should specify a version and an element set name to specify which properties of the output record to include in the response.
Since:
2017.0
See Also:
  • Field Details

    • 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.
    • ID_PROPERTY

      public static final TLcdDataProperty ID_PROPERTY
      Data property that maps to the Id element. The possible values for this property are instances of URI.
    • ELEMENT_SET_NAME_PROPERTY

      public static final TLcdDataProperty ELEMENT_SET_NAME_PROPERTY
      Data property that maps to the ElementSetName element. The possible values for this property are instances of TLcdCSWElementSetName.
  • Constructor Details

    • TLcdCSWGetRecordByIdRequest

      public TLcdCSWGetRecordByIdRequest(TLcdDataType aType)
    • TLcdCSWGetRecordByIdRequest

      public TLcdCSWGetRecordByIdRequest(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.
    • 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.
    • getId

      public URI getId()
      Returns the value of the property that maps to the Id element.
      Returns:
      the value of the ID_PROPERTY property.
    • setId

      public void setId(URI aValue)
      Sets the value of the property that maps to the Id element.
      Parameters:
      aValue - the value to set for the ID_PROPERTY property.
    • getElementSetName

      public TLcdCSWElementSetName getElementSetName()
      Returns the value of the property that maps to the ElementSetName element.
      Returns:
      the value of the ELEMENT_SET_NAME_PROPERTY property.
    • setElementSetName

      public void setElementSetName(TLcdCSWElementSetName aValue)
      Sets the value of the property that maps to the ElementSetName element.
      Parameters:
      aValue - the value to set for the ELEMENT_SET_NAME_PROPERTY property.