com.luciad.ogc.wfs.client

LuciadLightspeedClass TLcdWFSDescribeFeatureTypeRequest

java.lang.Object

com.luciad.ogc.wfs.client.TLcdWFSDescribeFeatureTypeRequest

All Implemented Interfaces:

ILcdOWSRequest

public class TLcdWFSDescribeFeatureTypeRequest
extends Object
implements ILcdOWSRequest

A WFS DescribeFeatureType request. Instances of this class can be created using the TLcdWFSClient.createDescribeFeatureTypeRequest() method. This method will ensure a request object is created that is compatible with the WFS version implemented by the WFS server.

Since:

8.2

Method Summary

Modifier and Type	Method and Description
Map	getKVPEncoding() Returns a key-value pair (KVP) encoding of this request.
URI	getRestEncoding(URI aBaseURI) Returns null, REST encoding is not supported.
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	setOutputFormat(String aOutputFormat) Sets the output format that the WFS should use to encode a response to a query.
void	setTransportData(Object aTransportData) Sets an object representing data to be used by the transportation layer (see ILcdOWSTransport) to perform this OGC Web Service request.
void	setTypeName(QName aTypeName) Sets the feature type name for which a description should be retrieved.
void	setTypeNames(QName[] aTypeNames) Sets the feature type names for which descriptions should be retrieved All previously set names will be cleared.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTransportData

public Object getTransportData()

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.

setTransportData

public void setTransportData(Object aTransportData)

Sets 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.

Parameters:

aTransportData - an object representing data to be used by the transportation layer to perform this OGC Web Service request.

See Also:

getTransportData()

setTypeName

public void setTypeName(QName aTypeName)

Sets the feature type name for which a description should be retrieved. All previously set names will be cleared.

Parameters:

aTypeName - a feature type name

Throws:

NullPointerException - if the feature type name is null

See Also:

setTypeNames(javax.xml.namespace.QName[])

setTypeNames

public void setTypeNames(QName[] aTypeNames)

Sets the feature type names for which descriptions should be retrieved All previously set names will be cleared.

Parameters:

aTypeNames - the feature type names

Throws:

NullPointerException - if the type name array is null or contains null values

See Also:

setTypeName(javax.xml.namespace.QName)

setOutputFormat

public void setOutputFormat(String aOutputFormat)

Sets the output format that the WFS should use to encode a response to a query.

Parameters:

aOutputFormat - the output format that the WFS should use to encode a response to a query.

Throws:

NullPointerException - if the output format is null

getKVPEncoding

public Map getKVPEncoding()

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.

getXMLEncoding

public InputStream getXMLEncoding()

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.

getRestEncoding

public URI getRestEncoding(URI aBaseURI)

Returns null, REST encoding is not supported.

Specified by:

getRestEncoding in interface ILcdOWSRequest

Parameters:

aBaseURI -

Returns:

null

Since:

2013.0