Package com.luciad.ogc.csw.model
Class TLcdCSWGetRecordByIdRequest
java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.ogc.csw.model.TLcdCSWRequestBase
com.luciad.ogc.csw.model.TLcdCSWGetRecordByIdRequest
- All Implemented Interfaces:
ILcdDataObject
,ILcdOWSRequest
,ILcdCloneable
,ILcdDeepCloneable
,Cloneable
Convenience operation to retrieve default record representations by
Aside from this identifier, a valid request should specify a
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 Summary
Modifier and TypeFieldDescriptionstatic final TLcdDataProperty
Data property that maps to theElementSetName
element.static final TLcdDataProperty
Data property that maps to theId
element.static final TLcdDataProperty
Data property that maps to theoutputFormat
attribute.static final TLcdDataProperty
Data property that maps to theoutputSchema
attribute.Fields inherited from class com.luciad.ogc.csw.model.TLcdCSWRequestBase
SERVICE_PROPERTY, VERSION_PROPERTY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the value of the property that maps to theElementSetName
element.getId()
Returns the value of the property that maps to theId
element.Returns a key-value pair (KVP) encoding of this request.Returns the value of the property that maps to theoutputFormat
attribute.Returns the value of the property that maps to theoutputSchema
attribute.getRestEncoding
(URI aBaseURI) Returns a URI that can be used to perform the request.Returns an object representing data to be used by the transportation layer (seeILcdOWSTransport
) to perform this OGC Web Service request.Returns the XML encoding of this request.void
Sets the value of the property that maps to theElementSetName
element.void
Sets the value of the property that maps to theId
element.void
setOutputFormat
(String aValue) Sets the value of the property that maps to theoutputFormat
attribute.void
setOutputSchema
(URI aValue) Sets the value of the property that maps to theoutputSchema
attribute.Methods inherited from class com.luciad.ogc.csw.model.TLcdCSWRequestBase
getService, getVersion, setService, setVersion
-
Field Details
-
OUTPUT_FORMAT_PROPERTY
Data property that maps to theoutputFormat
attribute. The possible values for this property are instances ofString
. -
OUTPUT_SCHEMA_PROPERTY
Data property that maps to theoutputSchema
attribute. The possible values for this property are instances ofURI
. -
ID_PROPERTY
Data property that maps to theId
element. The possible values for this property are instances ofURI
. -
ELEMENT_SET_NAME_PROPERTY
Data property that maps to theElementSetName
element. The possible values for this property are instances ofTLcdCSWElementSetName
.
-
-
Constructor Details
-
TLcdCSWGetRecordByIdRequest
-
TLcdCSWGetRecordByIdRequest
-
-
Method Details
-
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 interfaceILcdOWSRequest
- Returns:
- the key-value pair (KVP) representation of this request.
-
getRestEncoding
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 interfaceILcdOWSRequest
- 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
Description copied from interface:ILcdOWSRequest
Returns the XML encoding of this request. If no XML encoding is supported for this request,null
should be returned.- Specified by:
getXMLEncoding
in interfaceILcdOWSRequest
- Returns:
- the XML representation of this request.
-
getTransportData
Description copied from interface:ILcdOWSRequest
Returns an object representing data to be used by the transportation layer (seeILcdOWSTransport
) to perform this OGC Web Service request. The type of object and the data contained in it depends on theILcdOWSTransport
object used to perform this request. An example in the case of a HTTP transport connection is a map of request properties (seeURLConnection.getRequestProperties()
) to be used for the request.- Specified by:
getTransportData
in interfaceILcdOWSRequest
- Returns:
- an object representing data to be used by the transportation layer to perform this OGC Web Service request.
-
getOutputFormat
Returns the value of the property that maps to theoutputFormat
attribute.- Returns:
- the value of the
OUTPUT_FORMAT_PROPERTY
property.
-
setOutputFormat
Sets the value of the property that maps to theoutputFormat
attribute.- Parameters:
aValue
- the value to set for theOUTPUT_FORMAT_PROPERTY
property.
-
getOutputSchema
Returns the value of the property that maps to theoutputSchema
attribute.- Returns:
- the value of the
OUTPUT_SCHEMA_PROPERTY
property.
-
setOutputSchema
Sets the value of the property that maps to theoutputSchema
attribute.- Parameters:
aValue
- the value to set for theOUTPUT_SCHEMA_PROPERTY
property.
-
getId
Returns the value of the property that maps to theId
element.- Returns:
- the value of the
ID_PROPERTY
property.
-
setId
Sets the value of the property that maps to theId
element.- Parameters:
aValue
- the value to set for theID_PROPERTY
property.
-
getElementSetName
Returns the value of the property that maps to theElementSetName
element.- Returns:
- the value of the
ELEMENT_SET_NAME_PROPERTY
property.
-
setElementSetName
Sets the value of the property that maps to theElementSetName
element.- Parameters:
aValue
- the value to set for theELEMENT_SET_NAME_PROPERTY
property.
-