com.luciad.ogc.wfs

LuciadFusionInterface ILcdWFSModelSchemaEncoder

public interface ILcdWFSModelSchemaEncoder

Interface for classes that handle DescribeFeatureType requests in the WFS. The default behaviour is to encode an XML schema describing a feature collection. The methods of this interface are analogous to ILcdModelEncoder.

Since:

6.0

Method Summary

Modifier and Type	Method and Description
boolean	canExportSchema(ILcdModel aModel, String aDestinationName) Checks whether this encoder can export a schema for the given model.
void	exportSchema(ILcdModel aModel, String aDestinationName) Exports a schema for the given model.
String	getContentType() Gets the content type (MIME type) of the encoded schema that will be used for the HTTP response to a WFS DescribeFeatureType request.
String	getDisplayName() Returns the displayable name of this ILcdWFSModelSchemaEncoder.

Method Detail

canExportSchema

boolean canExportSchema(ILcdModel aModel,
                        String aDestinationName)

Checks whether this encoder can export a schema for the given model.

Parameters:

aModel - the model to be checked

aDestinationName - a specification of the location where the schema should be saved

Returns:

true if this encoder can save a schema for the given model in the specified location, false otherwise

exportSchema

void exportSchema(ILcdModel aModel,
                  String aDestinationName)
           throws IOException

Exports a schema for the given model.

Parameters:

aModel - the model for which a schema is to be exported

aDestinationName - a specification of the location where the schema should be saved

Throws:

IOException - for any I/O errors

getDisplayName

String getDisplayName()

Returns the displayable name of this ILcdWFSModelSchemaEncoder.

Returns:

the displayable name of this ILcdWFSModelSchemaEncoder

getContentType

String getContentType()

Gets the content type (MIME type) of the encoded schema that will be used for the HTTP response to a WFS DescribeFeatureType request. When the content type is null, the content type is undefined and no content type will be set on the response. It is recommended to always explicitly define a content type because browsers and clients often depend on it for correct and well-defined behavior.

A typical content type is "text/xml" for XML schemas.

Returns:

the content type (MIME type) of the encoded schema, which may be null

Since:

2015.0