Package com.luciad.ogc.wfs

Class TLcdWFSClientModelEncoderFactory

java.lang.Object

com.luciad.ogc.wfs.TLcdWFSClientModelEncoderFactory

All Implemented Interfaces:

ILcdWFSClientModelEncoderFactory

public class TLcdWFSClientModelEncoderFactory
extends Object
implements ILcdWFSClientModelEncoderFactory

Default implementation of ILcdWFSClientModelEncoderFactory. Supports GML 2, GML 3.1, GML 3.2, GeoJSON and SHP (zipped) output formats.

Constructor Summary

Constructors

Constructor	Description
TLcdWFSClientModelEncoderFactory()	Creates a new TLcdWFSClientModelEncoderFactory.

Method Summary

Modifier and Type	Method	Description
protected TLcdFeatureMetaDataProvider	createFeatureMetaDataProvider(ILcdOGCFeatureIDRetriever aFeatureIDRetriever, TLcdWFSRequestContext aRequestContext)	Creates a new TLcdFeatureMetaDataProvider that is used to retrieve feature-specific information when encoding the features to GeoJSON.
ILcdWFSModelEncoder	createModelEncoder(ILcdOutputStreamFactory aOutputStreamFactory, String aOutputFormat, TLcdWFSRequestContext aContext)	Returns a model encoder that can encode models in the requested format to an output stream provided by the given factory.
ILcdWFSModelSchemaEncoder	createModelSchemaEncoder(ILcdOutputStreamFactory aOutputStreamFactory, String aOutputFormat, TLcdWFSRequestContext aContext)	Returns a model schema encoder that can produce the appropriate response to a DescribeFeatureType request.
ILcdModelReferenceFormatter	getModelReferenceFormatter()	Returns the model reference formatter that is used when encoding models.
String	getSupportedOutputFormat(int aIndex, TLcdWFSRequestContext aContext)	Returns the output format at the given index for which this factory can produce a model encoder.
int	getSupportedOutputFormatCount(TLcdWFSRequestContext aContext)	Returns the number of output formats for which this factory can produce model encoders.
String	getSupportedSchemaOutputFormat(int aIndex, TLcdWFSRequestContext aContext)	Returns the schema output format at the given index for which this factory can produce a model schema encoder.
int	getSupportedSchemaOutputFormatCount(TLcdWFSRequestContext aContext)	Returns the number of schema output formats for which this factory can produce model schema encoders.
void	setModelReferenceFormatter(ILcdModelReferenceFormatter aReferenceFormatter)	Sets the model reference formatter to be used when encoding models.

Methods inherited from class java.lang.Object

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

Constructor Details

TLcdWFSClientModelEncoderFactory

public TLcdWFSClientModelEncoderFactory()

Creates a new TLcdWFSClientModelEncoderFactory.

Method Details

setModelReferenceFormatter

public void setModelReferenceFormatter(ILcdModelReferenceFormatter aReferenceFormatter)

Sets the model reference formatter to be used when encoding models.

Parameters:

aReferenceFormatter - the model reference formatter to be used when encoding models.

getModelReferenceFormatter

public ILcdModelReferenceFormatter getModelReferenceFormatter()

Returns the model reference formatter that is used when encoding models.

Returns:

the model reference formatter that is used when encoding models.

Since:

2020.1

createModelEncoder

public ILcdWFSModelEncoder createModelEncoder(ILcdOutputStreamFactory aOutputStreamFactory,
 String aOutputFormat,
 TLcdWFSRequestContext aContext)

Description copied from interface: ILcdWFSClientModelEncoderFactory

Returns a model encoder that can encode models in the requested format to an output stream provided by the given factory. WFS-T servers that want to support locking need to return ILcdModelEncoder instances which also implement ILcdWFSLockModelEncoder.

Specified by:

createModelEncoder in interface ILcdWFSClientModelEncoderFactory

Parameters:

aOutputStreamFactory - An ILcdOutputStreamFactory.

aOutputFormat - A string describing the requested output format, e.g. "GML2".

aContext - context information regarding the WFS request being handled

Returns:

An ILcdModelEncoder.

See Also:

• ILcdWFSLockModelEncoder

createFeatureMetaDataProvider

protected TLcdFeatureMetaDataProvider createFeatureMetaDataProvider(ILcdOGCFeatureIDRetriever aFeatureIDRetriever,
 TLcdWFSRequestContext aRequestContext)

Creates a new TLcdFeatureMetaDataProvider that is used to retrieve feature-specific information when encoding the features to GeoJSON. This method can be extended to customize the encoding, such as adding additional metadata (foreign members) per feature, changing the name of properties, etc.

Parameters:

aFeatureIDRetriever - The default ID retriever to be used to retrieve the identifier of a feature that is being encoded. See also TLcdFeatureMetaDataProvider.getId(Object).

aRequestContext - The context information regarding the WFS request being handled.

Returns:

a new TLcdFeatureMetaDataProvider that is used to retrieve feature-specific information when encoding the features to GeoJSON.

Since:

2026.0

getSupportedOutputFormatCount

public int getSupportedOutputFormatCount(TLcdWFSRequestContext aContext)

Description copied from interface: ILcdWFSClientModelEncoderFactory

Returns the number of output formats for which this factory can produce model encoders.

Specified by:

getSupportedOutputFormatCount in interface ILcdWFSClientModelEncoderFactory

Parameters:

aContext - context information regarding the WFS request being handled

Returns:

the number of supported output formats.

See Also:

• ILcdWFSClientModelEncoderFactory.getSupportedOutputFormat(int, TLcdWFSRequestContext)

getSupportedOutputFormat

public String getSupportedOutputFormat(int aIndex,
 TLcdWFSRequestContext aContext)

Description copied from interface: ILcdWFSClientModelEncoderFactory

Returns the output format at the given index for which this factory can produce a model encoder. The format name is passed as an argument to the createModelEncoder() method.

Specified by:

getSupportedOutputFormat in interface ILcdWFSClientModelEncoderFactory

Parameters:

aIndex - the index of the requested output format

aContext - context information regarding the WFS request being handled

Returns:

an output format

getSupportedSchemaOutputFormatCount

public int getSupportedSchemaOutputFormatCount(TLcdWFSRequestContext aContext)

Description copied from interface: ILcdWFSClientModelEncoderFactory

Returns the number of schema output formats for which this factory can produce model schema encoders.

Specified by:

getSupportedSchemaOutputFormatCount in interface ILcdWFSClientModelEncoderFactory

Parameters:

aContext - context information regarding the WFS request being handled

Returns:

the number of supported schema output formats.

See Also:

• ILcdWFSClientModelEncoderFactory.getSupportedSchemaOutputFormat(int, TLcdWFSRequestContext)

getSupportedSchemaOutputFormat

public String getSupportedSchemaOutputFormat(int aIndex,
 TLcdWFSRequestContext aContext)

Description copied from interface: ILcdWFSClientModelEncoderFactory

Returns the schema output format at the given index for which this factory can produce a model schema encoder. The format name is passed as an argument to the createModelSchemaEncoder() method.

Specified by:

getSupportedSchemaOutputFormat in interface ILcdWFSClientModelEncoderFactory

Parameters:

aIndex - the index of the requested schema output format

aContext - context information regarding the WFS request being handled

Returns:

an output format

createModelSchemaEncoder

public ILcdWFSModelSchemaEncoder createModelSchemaEncoder(ILcdOutputStreamFactory aOutputStreamFactory,
 String aOutputFormat,
 TLcdWFSRequestContext aContext)

Description copied from interface: ILcdWFSClientModelEncoderFactory

Returns a model schema encoder that can produce the appropriate response to a DescribeFeatureType request. The response must be in the specified format, and must be written to an output stream provided by the given factory.

Specified by:

createModelSchemaEncoder in interface ILcdWFSClientModelEncoderFactory

Parameters:

aOutputStreamFactory - an ILcdOutputStreamFactory

aOutputFormat - A string describing the requested output format, e.g. "XMLSCHEMA".

aContext - context information regarding the WFS request being handled

Returns:

an ILcdWFSModelSchemaEncoder