public class TLcdCSWGetRecordsRequest extends TLcdCSWRequestBase implements ILcdOWSRequest
version
and query object
.TLcdCSWQuery
Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
ANY_PROPERTY
Data any property.
|
static TLcdDataProperty |
DISTRIBUTED_SEARCH_PROPERTY
Data property that maps to the
DistributedSearch element. |
static TLcdDataProperty |
MAX_RECORDS_PROPERTY
Data property that maps to the
maxRecords attribute. |
static TLcdDataProperty |
OUTPUT_FORMAT_PROPERTY
Data property that maps to the
outputFormat attribute. |
static TLcdDataProperty |
OUTPUT_SCHEMA_PROPERTY
Data property that maps to the
outputSchema attribute. |
static TLcdDataProperty |
QUERY_PROPERTY
Data property that maps to the
AbstractQuery element. |
static TLcdDataProperty |
REQUEST_ID_PROPERTY
Data property that maps to the
requestId attribute. |
static TLcdDataProperty |
RESPONSE_HANDLER_PROPERTY
Data property that maps to the
ResponseHandler element. |
static TLcdDataProperty |
START_POSITION_PROPERTY
Data property that maps to the
startPosition attribute. |
SERVICE_PROPERTY, VERSION_PROPERTY
Constructor and Description |
---|
TLcdCSWGetRecordsRequest(String aVersion) |
TLcdCSWGetRecordsRequest(TLcdDataType aType) |
Modifier and Type | Method and Description |
---|---|
Object |
getAny()
Returns the value of the any property.
|
TLcdCSWDistributedSearch |
getDistributedSearch()
Returns the value of the property that maps to the
DistributedSearch element. |
Map |
getKVPEncoding()
Returns a key-value pair (KVP) encoding of this request.
|
long |
getMaxRecords()
Returns the value of the property that maps to the
maxRecords attribute. |
String |
getOutputFormat()
Returns the value of the property that maps to the
outputFormat attribute. |
URI |
getOutputSchema()
Returns the value of the property that maps to the
outputSchema attribute. |
TLcdCSWAbstractQuery |
getQuery()
Returns the value of the property that maps to the
AbstractQuery element. |
URI |
getRequestId()
Returns the value of the property that maps to the
requestId attribute. |
List<URI> |
getResponseHandler()
Returns the value of the property that maps to the
ResponseHandler element. |
URI |
getRestEncoding(URI aBaseURI)
Returns a URI that can be used to perform the request.
|
long |
getStartPosition()
Returns the value of the property that maps to the
startPosition attribute. |
Object |
getTransportData()
Returns an object representing data to be used by the transportation layer (see
ILcdOWSTransport )
to perform this OGC Web Service request. |
InputStream |
getXMLEncoding()
Returns the XML encoding of this request.
|
void |
setAny(Object aValue)
Sets the value of the any property.
|
void |
setDistributedSearch(TLcdCSWDistributedSearch aValue)
Sets the value of the property that maps to the
DistributedSearch element. |
void |
setMaxRecords(long aValue)
Sets the value of the property that maps to the
maxRecords attribute. |
void |
setOutputFormat(String aValue)
Sets the value of the property that maps to the
outputFormat attribute. |
void |
setOutputSchema(URI aValue)
Sets the value of the property that maps to the
outputSchema attribute. |
void |
setQuery(TLcdCSWAbstractQuery aValue)
Sets the value of the property that maps to the
AbstractQuery element. |
void |
setRequestId(URI aValue)
Sets the value of the property that maps to the
requestId attribute. |
void |
setStartPosition(long aValue)
Sets the value of the property that maps to the
startPosition attribute. |
getService, getVersion, setService, setVersion
public static final TLcdDataProperty MAX_RECORDS_PROPERTY
maxRecords
attribute.
The possible values for this property are instances of long
.public static final TLcdDataProperty OUTPUT_FORMAT_PROPERTY
outputFormat
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty OUTPUT_SCHEMA_PROPERTY
outputSchema
attribute.
The possible values for this property are instances of URI
.public static final TLcdDataProperty REQUEST_ID_PROPERTY
requestId
attribute.
The possible values for this property are instances of URI
.public static final TLcdDataProperty START_POSITION_PROPERTY
startPosition
attribute.
The possible values for this property are instances of long
.public static final TLcdDataProperty DISTRIBUTED_SEARCH_PROPERTY
DistributedSearch
element.
The possible values for this property are instances of TLcdCSWDistributedSearch
.public static final TLcdDataProperty RESPONSE_HANDLER_PROPERTY
ResponseHandler
element.
The possible values for this property are instances of List<URI>
.public static final TLcdDataProperty QUERY_PROPERTY
AbstractQuery
element.
The possible values for this property are instances of TLcdCSWAbstractQuery
.public static final TLcdDataProperty ANY_PROPERTY
Object
.public TLcdCSWGetRecordsRequest(TLcdDataType aType)
public TLcdCSWGetRecordsRequest(String aVersion)
public Map getKVPEncoding()
ILcdOWSRequest
null
should be returned.getKVPEncoding
in interface ILcdOWSRequest
public URI getRestEncoding(URI aBaseURI)
ILcdOWSRequest
If this request cannot be fulfilled through REST, return null
.
getRestEncoding
in interface ILcdOWSRequest
aBaseURI
- the base URI to be used to construct the REST encodingnull
if REST is not supported.public InputStream getXMLEncoding()
ILcdOWSRequest
null
should be returned.getXMLEncoding
in interface ILcdOWSRequest
public Object getTransportData()
ILcdOWSRequest
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.getTransportData
in interface ILcdOWSRequest
public long getMaxRecords()
maxRecords
attribute.MAX_RECORDS_PROPERTY
property.public void setMaxRecords(long aValue)
maxRecords
attribute.aValue
- the value to set for the MAX_RECORDS_PROPERTY
property.public String getOutputFormat()
outputFormat
attribute.OUTPUT_FORMAT_PROPERTY
property.public void setOutputFormat(String aValue)
outputFormat
attribute.aValue
- the value to set for the OUTPUT_FORMAT_PROPERTY
property.public URI getOutputSchema()
outputSchema
attribute.OUTPUT_SCHEMA_PROPERTY
property.public void setOutputSchema(URI aValue)
outputSchema
attribute.aValue
- the value to set for the OUTPUT_SCHEMA_PROPERTY
property.public URI getRequestId()
requestId
attribute.
requestId becomes mandatory in the case of a distributed search. Must be a unique Id (i.e. a UUID).
REQUEST_ID_PROPERTY
property.public void setRequestId(URI aValue)
requestId
attribute.
requestId becomes mandatory in the case of a distributed search. Must be a unique Id (i.e. a UUID).
aValue
- the value to set for the REQUEST_ID_PROPERTY
property.public long getStartPosition()
startPosition
attribute.START_POSITION_PROPERTY
property.public void setStartPosition(long aValue)
startPosition
attribute.aValue
- the value to set for the START_POSITION_PROPERTY
property.public TLcdCSWDistributedSearch getDistributedSearch()
DistributedSearch
element.DISTRIBUTED_SEARCH_PROPERTY
property.public void setDistributedSearch(TLcdCSWDistributedSearch aValue)
DistributedSearch
element.aValue
- the value to set for the DISTRIBUTED_SEARCH_PROPERTY
property.public List<URI> getResponseHandler()
ResponseHandler
element.RESPONSE_HANDLER_PROPERTY
property.public TLcdCSWAbstractQuery getQuery()
AbstractQuery
element.QUERY_PROPERTY
property.public void setQuery(TLcdCSWAbstractQuery aValue)
AbstractQuery
element.aValue
- the value to set for the QUERY_PROPERTY
property.public Object getAny()
ANY_PROPERTY
property.public void setAny(Object aValue)
aValue
- the value to set for the ANY_PROPERTY
property.