{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Examples of object type customization"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/DOV-Vlaanderen/pydov/master?filepath=docs%2Fnotebooks%2Fcustomizing_object_types.ipynb)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "We believe all pydov types to have the most relevant fields available by default. However, more data might be available and of interest to your use case.\n",
    "\n",
    "The pydov library provides a flexible way to customize the output of your data searches. One of the key features is the ability to customize the object types used in the search process. This notebook will demonstrate the different ways you can customize object types in pydov."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Defining Custom Object Types in pydov\n",
    "\n",
    "The pydov library provides a flexible way to customize the output of your data searches. One of the key features is the ability to define your own custom object types, which allows you to include specific XML fields that are not part of the default object types.\n",
    "\n",
    "This notebook will demonstrate three different ways you can define custom object types in pydov:\n",
    "\n",
    "1. Adding an XML field to an existing main type\n",
    "2. Adding an XML field to an existing subtype\n",
    "3. Creating a new subtype"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Adding an XML field to a main type\n",
    "\n",
    "To add an extra XML field to an existing main type, you can use the `with_extra_fields` method. This allows you to create a custom object type that includes additional fields beyond the default set."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "[000/001] .\n",
      "[000/010] cccccccccc\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>pkey_boring</th>\n",
       "      <th>boornummer</th>\n",
       "      <th>x</th>\n",
       "      <th>y</th>\n",
       "      <th>mv_mtaw</th>\n",
       "      <th>start_boring_mtaw</th>\n",
       "      <th>gemeente</th>\n",
       "      <th>diepte_boring_van</th>\n",
       "      <th>diepte_boring_tot</th>\n",
       "      <th>datum_aanvang</th>\n",
       "      <th>uitvoerder</th>\n",
       "      <th>boorgatmeting</th>\n",
       "      <th>methode_xy</th>\n",
       "      <th>diepte_methode_van</th>\n",
       "      <th>diepte_methode_tot</th>\n",
       "      <th>boormethode</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/boring/2016...</td>\n",
       "      <td>kb29d84e-B574</td>\n",
       "      <td>92424.0</td>\n",
       "      <td>170752.0</td>\n",
       "      <td>40.00</td>\n",
       "      <td>40.00</td>\n",
       "      <td>Wortegem-Petegem</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>NaN</td>\n",
       "      <td>onbekend</td>\n",
       "      <td>False</td>\n",
       "      <td>gedigitaliseerd op topokaart</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>onbekend</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/boring/2016...</td>\n",
       "      <td>kb29d84e-B575</td>\n",
       "      <td>92296.0</td>\n",
       "      <td>170885.0</td>\n",
       "      <td>46.00</td>\n",
       "      <td>46.00</td>\n",
       "      <td>Wortegem-Petegem</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>NaN</td>\n",
       "      <td>onbekend</td>\n",
       "      <td>False</td>\n",
       "      <td>gedigitaliseerd op topokaart</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>onbekend</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/boring/1945...</td>\n",
       "      <td>kb22d55e-B1037</td>\n",
       "      <td>108890.0</td>\n",
       "      <td>188690.0</td>\n",
       "      <td>14.31</td>\n",
       "      <td>14.31</td>\n",
       "      <td>Melle</td>\n",
       "      <td>0.0</td>\n",
       "      <td>15.0</td>\n",
       "      <td>1945-01-01</td>\n",
       "      <td>De Meyer L.-Gent</td>\n",
       "      <td>False</td>\n",
       "      <td>gedigitaliseerd op topokaart</td>\n",
       "      <td>0.0</td>\n",
       "      <td>15.0</td>\n",
       "      <td>droge boring</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/boring/2016...</td>\n",
       "      <td>kb29d84e-B576</td>\n",
       "      <td>92243.0</td>\n",
       "      <td>170939.0</td>\n",
       "      <td>47.50</td>\n",
       "      <td>47.50</td>\n",
       "      <td>Wortegem-Petegem</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>NaN</td>\n",
       "      <td>onbekend</td>\n",
       "      <td>False</td>\n",
       "      <td>gedigitaliseerd op topokaart</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>onbekend</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/boring/2016...</td>\n",
       "      <td>kb29d84e-B577</td>\n",
       "      <td>92475.0</td>\n",
       "      <td>171088.0</td>\n",
       "      <td>39.00</td>\n",
       "      <td>39.00</td>\n",
       "      <td>Wortegem-Petegem</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>NaN</td>\n",
       "      <td>onbekend</td>\n",
       "      <td>False</td>\n",
       "      <td>gedigitaliseerd op topokaart</td>\n",
       "      <td>0.0</td>\n",
       "      <td>0.0</td>\n",
       "      <td>onbekend</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "                                         pkey_boring      boornummer  \\\n",
       "0  https://www.dov.vlaanderen.be/data/boring/2016...   kb29d84e-B574   \n",
       "1  https://www.dov.vlaanderen.be/data/boring/2016...   kb29d84e-B575   \n",
       "2  https://www.dov.vlaanderen.be/data/boring/1945...  kb22d55e-B1037   \n",
       "3  https://www.dov.vlaanderen.be/data/boring/2016...   kb29d84e-B576   \n",
       "4  https://www.dov.vlaanderen.be/data/boring/2016...   kb29d84e-B577   \n",
       "\n",
       "          x         y  mv_mtaw  start_boring_mtaw          gemeente  \\\n",
       "0   92424.0  170752.0    40.00              40.00  Wortegem-Petegem   \n",
       "1   92296.0  170885.0    46.00              46.00  Wortegem-Petegem   \n",
       "2  108890.0  188690.0    14.31              14.31             Melle   \n",
       "3   92243.0  170939.0    47.50              47.50  Wortegem-Petegem   \n",
       "4   92475.0  171088.0    39.00              39.00  Wortegem-Petegem   \n",
       "\n",
       "   diepte_boring_van  diepte_boring_tot datum_aanvang        uitvoerder  \\\n",
       "0                0.0                0.0           NaN          onbekend   \n",
       "1                0.0                0.0           NaN          onbekend   \n",
       "2                0.0               15.0    1945-01-01  De Meyer L.-Gent   \n",
       "3                0.0                0.0           NaN          onbekend   \n",
       "4                0.0                0.0           NaN          onbekend   \n",
       "\n",
       "   boorgatmeting                    methode_xy  diepte_methode_van  \\\n",
       "0          False  gedigitaliseerd op topokaart                 0.0   \n",
       "1          False  gedigitaliseerd op topokaart                 0.0   \n",
       "2          False  gedigitaliseerd op topokaart                 0.0   \n",
       "3          False  gedigitaliseerd op topokaart                 0.0   \n",
       "4          False  gedigitaliseerd op topokaart                 0.0   \n",
       "\n",
       "   diepte_methode_tot   boormethode  \n",
       "0                 0.0      onbekend  \n",
       "1                 0.0      onbekend  \n",
       "2                15.0  droge boring  \n",
       "3                 0.0      onbekend  \n",
       "4                 0.0      onbekend  "
      ]
     },
     "execution_count": 1,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "from pydov.search.boring import BoringSearch\n",
    "from pydov.types.boring import Boring\n",
    "from pydov.types.fields import XmlField\n",
    "\n",
    "# Create a custom Boring type with an extra 'methode_xy' field\n",
    "MyBoring = Boring.with_extra_fields([\n",
    "    XmlField(name='methode_xy',\n",
    "             source_xpath='/boring/ligging/metadata_locatiebepaling/methode',\n",
    "             datatype='string')\n",
    "])\n",
    "\n",
    "# Search using the custom Boring type\n",
    "bs = BoringSearch(objecttype=MyBoring)\n",
    "df = bs.search(max_features=10)\n",
    "df.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In this example, we've created a custom `MyBoring` type that includes an extra `methode_xy` field, which is retrieved from the XML document. We can then use this custom type in our search to include the additional field in the output dataframe."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Adding an XML field to a subtype\n",
    "\n",
    "Similar to adding fields to a main type, you can also add extra XML fields to an existing subtype. This can be useful if you need to include additional data that is related to an existing subtype."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "[000/001] .\n",
      "[000/003] ccc\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>pkey_filter</th>\n",
       "      <th>pkey_grondwaterlocatie</th>\n",
       "      <th>gw_id</th>\n",
       "      <th>filternummer</th>\n",
       "      <th>filtertype</th>\n",
       "      <th>x</th>\n",
       "      <th>y</th>\n",
       "      <th>start_grondwaterlocatie_mtaw</th>\n",
       "      <th>mv_mtaw</th>\n",
       "      <th>gemeente</th>\n",
       "      <th>...</th>\n",
       "      <th>diepte_onderkant_filter</th>\n",
       "      <th>lengte_filter</th>\n",
       "      <th>datum</th>\n",
       "      <th>tijdstip</th>\n",
       "      <th>peil_mtaw</th>\n",
       "      <th>betrouwbaarheid</th>\n",
       "      <th>methode</th>\n",
       "      <th>filterstatus</th>\n",
       "      <th>filtertoestand</th>\n",
       "      <th>opmeter</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/filter/2003...</td>\n",
       "      <td>https://www.dov.vlaanderen.be/data/put/2017-00...</td>\n",
       "      <td>611/72/11</td>\n",
       "      <td>2</td>\n",
       "      <td>peilfilter</td>\n",
       "      <td>223063.2</td>\n",
       "      <td>172028.31</td>\n",
       "      <td>56.82</td>\n",
       "      <td>56.82</td>\n",
       "      <td>Kortessem</td>\n",
       "      <td>...</td>\n",
       "      <td>6.55</td>\n",
       "      <td>0.5</td>\n",
       "      <td>2004-04-06</td>\n",
       "      <td>NaN</td>\n",
       "      <td>55.02</td>\n",
       "      <td>goed</td>\n",
       "      <td>peillint</td>\n",
       "      <td>in rust</td>\n",
       "      <td>1</td>\n",
       "      <td>Labo</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/filter/2003...</td>\n",
       "      <td>https://www.dov.vlaanderen.be/data/put/2017-00...</td>\n",
       "      <td>611/72/11</td>\n",
       "      <td>2</td>\n",
       "      <td>peilfilter</td>\n",
       "      <td>223063.2</td>\n",
       "      <td>172028.31</td>\n",
       "      <td>56.82</td>\n",
       "      <td>56.82</td>\n",
       "      <td>Kortessem</td>\n",
       "      <td>...</td>\n",
       "      <td>6.55</td>\n",
       "      <td>0.5</td>\n",
       "      <td>2004-05-19</td>\n",
       "      <td>NaN</td>\n",
       "      <td>54.45</td>\n",
       "      <td>goed</td>\n",
       "      <td>peillint</td>\n",
       "      <td>in rust</td>\n",
       "      <td>1</td>\n",
       "      <td>VMM - Afdeling Operationeel Waterbeheer</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/filter/2003...</td>\n",
       "      <td>https://www.dov.vlaanderen.be/data/put/2017-00...</td>\n",
       "      <td>611/72/11</td>\n",
       "      <td>2</td>\n",
       "      <td>peilfilter</td>\n",
       "      <td>223063.2</td>\n",
       "      <td>172028.31</td>\n",
       "      <td>56.82</td>\n",
       "      <td>56.82</td>\n",
       "      <td>Kortessem</td>\n",
       "      <td>...</td>\n",
       "      <td>6.55</td>\n",
       "      <td>0.5</td>\n",
       "      <td>2004-12-14</td>\n",
       "      <td>NaN</td>\n",
       "      <td>55.11</td>\n",
       "      <td>goed</td>\n",
       "      <td>peillint</td>\n",
       "      <td>in rust</td>\n",
       "      <td>1</td>\n",
       "      <td>Labo</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/filter/2003...</td>\n",
       "      <td>https://www.dov.vlaanderen.be/data/put/2017-00...</td>\n",
       "      <td>611/72/11</td>\n",
       "      <td>2</td>\n",
       "      <td>peilfilter</td>\n",
       "      <td>223063.2</td>\n",
       "      <td>172028.31</td>\n",
       "      <td>56.82</td>\n",
       "      <td>56.82</td>\n",
       "      <td>Kortessem</td>\n",
       "      <td>...</td>\n",
       "      <td>6.55</td>\n",
       "      <td>0.5</td>\n",
       "      <td>2005-02-24</td>\n",
       "      <td>NaN</td>\n",
       "      <td>55.97</td>\n",
       "      <td>goed</td>\n",
       "      <td>peillint</td>\n",
       "      <td>in rust</td>\n",
       "      <td>1</td>\n",
       "      <td>Labo</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/filter/2003...</td>\n",
       "      <td>https://www.dov.vlaanderen.be/data/put/2017-00...</td>\n",
       "      <td>611/72/11</td>\n",
       "      <td>2</td>\n",
       "      <td>peilfilter</td>\n",
       "      <td>223063.2</td>\n",
       "      <td>172028.31</td>\n",
       "      <td>56.82</td>\n",
       "      <td>56.82</td>\n",
       "      <td>Kortessem</td>\n",
       "      <td>...</td>\n",
       "      <td>6.55</td>\n",
       "      <td>0.5</td>\n",
       "      <td>2005-09-29</td>\n",
       "      <td>NaN</td>\n",
       "      <td>53.46</td>\n",
       "      <td>goed</td>\n",
       "      <td>peillint</td>\n",
       "      <td>in rust</td>\n",
       "      <td>1</td>\n",
       "      <td>Labo</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "<p>5 rows × 24 columns</p>\n",
       "</div>"
      ],
      "text/plain": [
       "                                         pkey_filter  \\\n",
       "0  https://www.dov.vlaanderen.be/data/filter/2003...   \n",
       "1  https://www.dov.vlaanderen.be/data/filter/2003...   \n",
       "2  https://www.dov.vlaanderen.be/data/filter/2003...   \n",
       "3  https://www.dov.vlaanderen.be/data/filter/2003...   \n",
       "4  https://www.dov.vlaanderen.be/data/filter/2003...   \n",
       "\n",
       "                              pkey_grondwaterlocatie      gw_id filternummer  \\\n",
       "0  https://www.dov.vlaanderen.be/data/put/2017-00...  611/72/11            2   \n",
       "1  https://www.dov.vlaanderen.be/data/put/2017-00...  611/72/11            2   \n",
       "2  https://www.dov.vlaanderen.be/data/put/2017-00...  611/72/11            2   \n",
       "3  https://www.dov.vlaanderen.be/data/put/2017-00...  611/72/11            2   \n",
       "4  https://www.dov.vlaanderen.be/data/put/2017-00...  611/72/11            2   \n",
       "\n",
       "   filtertype         x          y  start_grondwaterlocatie_mtaw  mv_mtaw  \\\n",
       "0  peilfilter  223063.2  172028.31                         56.82    56.82   \n",
       "1  peilfilter  223063.2  172028.31                         56.82    56.82   \n",
       "2  peilfilter  223063.2  172028.31                         56.82    56.82   \n",
       "3  peilfilter  223063.2  172028.31                         56.82    56.82   \n",
       "4  peilfilter  223063.2  172028.31                         56.82    56.82   \n",
       "\n",
       "    gemeente  ... diepte_onderkant_filter lengte_filter       datum tijdstip  \\\n",
       "0  Kortessem  ...                    6.55           0.5  2004-04-06      NaN   \n",
       "1  Kortessem  ...                    6.55           0.5  2004-05-19      NaN   \n",
       "2  Kortessem  ...                    6.55           0.5  2004-12-14      NaN   \n",
       "3  Kortessem  ...                    6.55           0.5  2005-02-24      NaN   \n",
       "4  Kortessem  ...                    6.55           0.5  2005-09-29      NaN   \n",
       "\n",
       "   peil_mtaw  betrouwbaarheid   methode filterstatus  filtertoestand  \\\n",
       "0      55.02             goed  peillint      in rust               1   \n",
       "1      54.45             goed  peillint      in rust               1   \n",
       "2      55.11             goed  peillint      in rust               1   \n",
       "3      55.97             goed  peillint      in rust               1   \n",
       "4      53.46             goed  peillint      in rust               1   \n",
       "\n",
       "                                   opmeter  \n",
       "0                                     Labo  \n",
       "1  VMM - Afdeling Operationeel Waterbeheer  \n",
       "2                                     Labo  \n",
       "3                                     Labo  \n",
       "4                                     Labo  \n",
       "\n",
       "[5 rows x 24 columns]"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "from pydov.search.grondwaterfilter import GrondwaterFilterSearch\n",
    "from pydov.types.grondwaterfilter import GrondwaterFilter, Peilmeting\n",
    "from pydov.types.fields import XmlField\n",
    "from pydov.util.location import WithinDistance, Point\n",
    "\n",
    "# Create a custom Peilmeting subtype with an extra 'opmeter' field\n",
    "MyPeilmeting = Peilmeting.with_extra_fields([\n",
    "    XmlField(name='opmeter',\n",
    "             source_xpath='/opmeter/naam',\n",
    "             datatype='string')\n",
    "])\n",
    "\n",
    "# Create a custom GrondwaterFilter type with the custom Peilmeting subtype\n",
    "MyGrondwaterFilter = GrondwaterFilter.with_subtype(MyPeilmeting)\n",
    "\n",
    "# Search using the custom GrondwaterFilter type\n",
    "fs = GrondwaterFilterSearch(objecttype=MyGrondwaterFilter)\n",
    "df = fs.search(WithinDistance(Point(223063.20, 172028.31, epsg=31370), 10))\n",
    "df.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In this example, we've created a custom `MyPeilmeting` subtype that includes an extra `opmeter` field. We then used this custom subtype to create a new `MyGrondwaterFilter` main type, which we can use in our search."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Creating a new subtype\n",
    "\n",
    "In addition to adding fields to existing object types, you can also define your own custom subtypes from scratch. This allows you to include specific XML fields that are not part of the default object subtypes."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "[000/001] .\n",
      "[000/010] cccccccccc\n"
     ]
    },
    {
     "data": {
      "text/html": [
       "<div>\n",
       "<style scoped>\n",
       "    .dataframe tbody tr th:only-of-type {\n",
       "        vertical-align: middle;\n",
       "    }\n",
       "\n",
       "    .dataframe tbody tr th {\n",
       "        vertical-align: top;\n",
       "    }\n",
       "\n",
       "    .dataframe thead th {\n",
       "        text-align: right;\n",
       "    }\n",
       "</style>\n",
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th></th>\n",
       "      <th>pkey_sondering</th>\n",
       "      <th>sondeernummer</th>\n",
       "      <th>x</th>\n",
       "      <th>y</th>\n",
       "      <th>mv_mtaw</th>\n",
       "      <th>start_sondering_mtaw</th>\n",
       "      <th>diepte_sondering_van</th>\n",
       "      <th>diepte_sondering_tot</th>\n",
       "      <th>datum_aanvang</th>\n",
       "      <th>uitvoerder</th>\n",
       "      <th>sondeermethode</th>\n",
       "      <th>apparaat</th>\n",
       "      <th>datum_gw_meting</th>\n",
       "      <th>diepte_gw_m</th>\n",
       "      <th>techniek_diepte</th>\n",
       "      <th>techniek</th>\n",
       "      <th>techniek_andere</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <th>0</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/sondering/2...</td>\n",
       "      <td>VLA08-3.2-S16</td>\n",
       "      <td>218343.8</td>\n",
       "      <td>211622.9</td>\n",
       "      <td>51.15</td>\n",
       "      <td>51.15</td>\n",
       "      <td>0.0</td>\n",
       "      <td>12.80</td>\n",
       "      <td>2009-02-17</td>\n",
       "      <td>Labo Devlieger - Van Vooren</td>\n",
       "      <td>discontinu mechanisch</td>\n",
       "      <td>200 kN</td>\n",
       "      <td>NaT</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>1</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/sondering/1...</td>\n",
       "      <td>GEO-92/114-S4</td>\n",
       "      <td>105658.0</td>\n",
       "      <td>188808.0</td>\n",
       "      <td>NaN</td>\n",
       "      <td>12.45</td>\n",
       "      <td>0.0</td>\n",
       "      <td>2.70</td>\n",
       "      <td>1992-10-15</td>\n",
       "      <td>MVG - Afdeling Geotechniek</td>\n",
       "      <td>discontinu mechanisch</td>\n",
       "      <td>25 kN</td>\n",
       "      <td>NaT</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "      <td>NaN</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>2</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/sondering/2...</td>\n",
       "      <td>GEO-01/169-S23</td>\n",
       "      <td>189313.7</td>\n",
       "      <td>203475.9</td>\n",
       "      <td>NaN</td>\n",
       "      <td>21.40</td>\n",
       "      <td>1.2</td>\n",
       "      <td>15.15</td>\n",
       "      <td>2002-03-06</td>\n",
       "      <td>MVG - Afdeling Geotechniek</td>\n",
       "      <td>continu elektrisch</td>\n",
       "      <td>200 kN - MAN2</td>\n",
       "      <td>2002-03-06 14:45:00</td>\n",
       "      <td>1.25</td>\n",
       "      <td>1.2</td>\n",
       "      <td>V</td>\n",
       "      <td>NaN</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>3</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/sondering/2...</td>\n",
       "      <td>GEO-01/169-S16</td>\n",
       "      <td>189633.5</td>\n",
       "      <td>203331.5</td>\n",
       "      <td>NaN</td>\n",
       "      <td>21.22</td>\n",
       "      <td>1.4</td>\n",
       "      <td>30.00</td>\n",
       "      <td>2002-03-11</td>\n",
       "      <td>MVG - Afdeling Geotechniek</td>\n",
       "      <td>discontinu mechanisch</td>\n",
       "      <td>200 kN - MAN2</td>\n",
       "      <td>2002-03-11 13:50:00</td>\n",
       "      <td>1.22</td>\n",
       "      <td>9.2</td>\n",
       "      <td>V</td>\n",
       "      <td>NaN</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <th>4</th>\n",
       "      <td>https://www.dov.vlaanderen.be/data/sondering/2...</td>\n",
       "      <td>GEO-01/169-S16</td>\n",
       "      <td>189633.5</td>\n",
       "      <td>203331.5</td>\n",
       "      <td>NaN</td>\n",
       "      <td>21.22</td>\n",
       "      <td>1.4</td>\n",
       "      <td>30.00</td>\n",
       "      <td>2002-03-11</td>\n",
       "      <td>MVG - Afdeling Geotechniek</td>\n",
       "      <td>discontinu mechanisch</td>\n",
       "      <td>200 kN - MAN2</td>\n",
       "      <td>2002-03-11 13:50:00</td>\n",
       "      <td>1.22</td>\n",
       "      <td>9.2</td>\n",
       "      <td>V</td>\n",
       "      <td>NaN</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>\n",
       "</div>"
      ],
      "text/plain": [
       "                                      pkey_sondering   sondeernummer  \\\n",
       "0  https://www.dov.vlaanderen.be/data/sondering/2...   VLA08-3.2-S16   \n",
       "1  https://www.dov.vlaanderen.be/data/sondering/1...   GEO-92/114-S4   \n",
       "2  https://www.dov.vlaanderen.be/data/sondering/2...  GEO-01/169-S23   \n",
       "3  https://www.dov.vlaanderen.be/data/sondering/2...  GEO-01/169-S16   \n",
       "4  https://www.dov.vlaanderen.be/data/sondering/2...  GEO-01/169-S16   \n",
       "\n",
       "          x         y  mv_mtaw  start_sondering_mtaw  diepte_sondering_van  \\\n",
       "0  218343.8  211622.9    51.15                 51.15                   0.0   \n",
       "1  105658.0  188808.0      NaN                 12.45                   0.0   \n",
       "2  189313.7  203475.9      NaN                 21.40                   1.2   \n",
       "3  189633.5  203331.5      NaN                 21.22                   1.4   \n",
       "4  189633.5  203331.5      NaN                 21.22                   1.4   \n",
       "\n",
       "   diepte_sondering_tot datum_aanvang                   uitvoerder  \\\n",
       "0                 12.80    2009-02-17  Labo Devlieger - Van Vooren   \n",
       "1                  2.70    1992-10-15   MVG - Afdeling Geotechniek   \n",
       "2                 15.15    2002-03-06   MVG - Afdeling Geotechniek   \n",
       "3                 30.00    2002-03-11   MVG - Afdeling Geotechniek   \n",
       "4                 30.00    2002-03-11   MVG - Afdeling Geotechniek   \n",
       "\n",
       "          sondeermethode       apparaat     datum_gw_meting  diepte_gw_m  \\\n",
       "0  discontinu mechanisch         200 kN                 NaT          NaN   \n",
       "1  discontinu mechanisch          25 kN                 NaT          NaN   \n",
       "2     continu elektrisch  200 kN - MAN2 2002-03-06 14:45:00         1.25   \n",
       "3  discontinu mechanisch  200 kN - MAN2 2002-03-11 13:50:00         1.22   \n",
       "4  discontinu mechanisch  200 kN - MAN2 2002-03-11 13:50:00         1.22   \n",
       "\n",
       "   techniek_diepte techniek  techniek_andere  \n",
       "0              NaN      NaN              NaN  \n",
       "1              NaN      NaN              NaN  \n",
       "2              1.2        V              NaN  \n",
       "3              9.2        V              NaN  \n",
       "4              9.2        V              NaN  "
      ]
     },
     "execution_count": 3,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "from pydov.search.sondering import SonderingSearch\n",
    "from pydov.types.sondering import Sondering\n",
    "from pydov.types.abstract import AbstractDovSubType\n",
    "from pydov.types.fields import XmlField\n",
    "\n",
    "# Define a custom Technieken subtype\n",
    "class Technieken(AbstractDovSubType):\n",
    "    rootpath = './/sondering/sondeonderzoek/penetratietest/technieken'\n",
    "    fields = [\n",
    "        XmlField(name='techniek_diepte',\n",
    "                 source_xpath='/diepte_techniek',\n",
    "                 datatype='float'),\n",
    "        XmlField(name='techniek',\n",
    "                 source_xpath='/techniek',\n",
    "                 datatype='string'),\n",
    "        XmlField(name='techniek_andere',\n",
    "                 source_xpath='/techniek_andere',\n",
    "                 datatype='string')\n",
    "    ]\n",
    "\n",
    "# Create a custom Sondering type with the Technieken subtype\n",
    "MySondering = Sondering.with_subtype(Technieken)\n",
    "\n",
    "# Search using the custom Sondering type\n",
    "ms = SonderingSearch(objecttype=MySondering)\n",
    "df = ms.search(max_features=10)\n",
    "df.head()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In this example, we've defined a custom `Technieken` subtype that includes three new XML fields: `techniek_diepte`, `techniek`, and `techniek_andere`. These fields will be retrieved from the XML document and included in the output dataframe.\n",
    "\n",
    "We then used the `with_subtype` method to create a custom `MySondering` object type that includes the `Technieken` subtype. This allows us to search for sonderingen (cone penetration tests) and retrieve the additional subtype fields in the output.\n",
    "\n",
    "By defining custom subtypes, you can tailor the output dataframe to include the specific data that is most relevant for your use case. This provides a high degree of flexibility and control over the data you retrieve from the pydov data sources."
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": ".venv (3.13.5)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.13.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}