WFS schema mapping¶

Schema customization¶

The GeoServer WFS supports a limited amount of schema output customization. A custom schema may be useful for the following:

• Limiting the attributes which are exposed in the feature type schema

• Changing the types of attributes in the schema

• Changing the structure of the schema (for example, changing the base feature type)

For example, it may be useful to limit the exposed attributes in the example dataset described above. Start by retrieving the default output as a benchmark of the complete schema. With the feature type schema listed above, the GetFeature request would be as follows:

<topp:myDataset gml:id="myDataset.1">
 <topp:intProperty>1</topp:intProperty>
  <topp:stringProperty>one</topp:stringProperty>
  <topp:floatProperty>1.1</topp:floatProperty>
  <topp:geometry>
    <gml:Point srsName="urn:x-ogc:def:crs:EPSG:4326">
      <gml:pos>1.0 1.0</gml:pos>
    </gml:Point>
  </topp:geometry>
</topp:myDataset>

To remove floatProperty from the list of attributes, the following steps would be required:

1. The original schema is modified to remove the floatProperty, resulting in the following type definition:

   <xsd:complexType name="myDatasetType">
     <xsd:complexContent>
       <xsd:extension base="gml:AbstractFeatureType">
         <xsd:sequence>
           <xsd:element maxOccurs="1" minOccurs="0" name="intProperty" nillable="true" type="xsd:int"/>
           <xsd:element maxOccurs="1" minOccurs="0" name="stringProperty" nillable="true" type="xsd:string"/>
           <!-- remove the floatProperty element
           <xsd:element maxOccurs="1" minOccurs="0" name="floatProperty" nillable="true" type="xsd:double"/>
           -->
           <xsd:element maxOccurs="1" minOccurs="0" name="geometry" nillable="true" type="gml:PointPropertyType"/>
         </xsd:sequence>
       </xsd:extension>
       </xsd:complexContent>
   </xsd:complexType>
   

2. The modification is saved in a file named schema.xsd.

3. The schema.xsd file is copied into the feature type directory for the topp:myDataset which is:

   $GEOSERVER_DATA_DIR/workspaces/<workspace>/<datastore>/myDataset/
   

   where <workspace> is the name of the workspace containing your data store and <datastore> is the name of the data store which contains myDataset

The modified schema will only be available to GeoServer when the configuration is reloaded or GeoServer is restarted.

A subsequent DescribeFeatureType request for topp:myDataset confirms the floatProperty element is absent:

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:gml="http://www.opengis.net/gml"
 xmlns:topp="http://www.openplans.org/topp"
 targetNamespace="http://www.openplans.org/topp"
 elementFormDefault="qualified">

  <xsd:import namespace="http://www.opengis.net/gml"
   schemaLocation="http://localhost:8080/geoserver/schemas/gml/3.1.1/base/gml.xsd"/>

  <xsd:complexType name="myDatasetType">
    <xsd:complexContent>
      <xsd:extension base="gml:AbstractFeatureType">
        <xsd:sequence>
          <xsd:element maxOccurs="1" minOccurs="0" name="intProperty" nillable="true" type="xsd:int"/>
          <xsd:element maxOccurs="1" minOccurs="0" name="stringProperty" nillable="true" type="xsd:string"/>
          <xsd:element maxOccurs="1" minOccurs="0" name="geometry" nillable="true" type="gml:PointPropertyType"/>
        </xsd:sequence>
      </xsd:extension>
    </xsd:complexContent>
  </xsd:complexType>

  <xsd:element name="myDataset" substitutionGroup="gml:_Feature" type="topp:myDatasetType"/>

</xsd:schema>

A GetFeature request will now return features that don’t include the floatProperty attribute:

<topp:myDataset gml:id="myDataset.1">
  <topp:intProperty>1</topp:intProperty>
  <topp:stringProperty>one</topp:stringProperty>
  <topp:geometry>
    <gml:Point srsName="urn:x-ogc:def:crs:EPSG:4326">
      <gml:pos>1.0 1.0</gml:pos>
    </gml:Point>
  </topp:geometry>
</topp:myDataset>

Type changing¶

Schema customization may be used to perform some type changing, although this is limited by the fact that a changed type must be in the same domain as the original type. For example, integer types must be changed to integer types, temporal types to temporal types, and so on.

The most common change type requirement is for geometry attributes. In many cases the underlying data set does not have the necessary metadata to report the specific geometry type of a geometry attribute. The automatic schema mapping would result in an element definition similar to the following:

<xsd:element maxOccurs="1" minOccurs="0" name="geometry" nillable="true" type="gml:GeometryPropertyType"/>

However if the specific type of the geometry is known, the element definition above could be altered. For point geometry, the element definition could be altered to :

<xsd:element maxOccurs="1" minOccurs="0" name="geometry" nillable="true" type="gml:PointPropertyType"/>