:tocdepth: 3 :py:mod:`gws.plugin.alkis.action` ================================= .. py:module:: gws.plugin.alkis.action .. autoapi-nested-parse:: Backend for the Flurstückssuche (cadaster parlcels search) form. **Source code:** :source:`gws.plugin.alkis.action` Module Contents --------------- .. py:class:: BuchungConfig(*args, **kwargs) Bases: :py:obj:`gws.ConfigWithAccess` Access to the Grundbuch (register) information .. py:class:: BuchungOptions Bases: :py:obj:`gws.Node` Configurable GWS object. .. py:class:: Config(*args, **kwargs) Bases: :py:obj:`gws.ConfigWithAccess` Flurstückssuche action .. py:attribute:: buchung :type: Optional[BuchungConfig] access to the Grundbuch (register) information .. py:attribute:: buchungsblattSearchOptions :type: Optional[gws.TextSearchOptions] .. py:attribute:: crs :type: gws.CrsName CRS for the ALKIS data .. py:attribute:: dataSchema :type: str :value: 'public' schema where ALKIS tables are stored .. py:attribute:: dbUid :type: str :value: '' database provider ID .. py:attribute:: eigentuemer :type: Optional[EigentuemerConfig] access to the Eigentümer (owner) information .. py:attribute:: excludeGemarkung :type: Optional[list[str]] Gemarkung (Administrative Unit) IDs to exclude from search .. py:attribute:: export :type: Optional[Config.export] csv export configuration .. py:attribute:: indexSchema :type: str :value: 'gws8' schema to store GWS internal indexes .. py:attribute:: limit :type: int :value: 100 search results limit .. py:attribute:: nameSearchOptions :type: Optional[gws.TextSearchOptions] .. py:attribute:: printers :type: Optional[list[gws.base.printer.Config]] print configurations .. py:attribute:: storage :type: Optional[gws.base.storage.Config] storage configuration .. py:attribute:: strasseSearchOptions :type: Optional[gws.TextSearchOptions] .. py:attribute:: templates :type: Optional[list[gws.ext.config.template]] templates for Flurstueck details .. py:attribute:: ui :type: Optional[Ui] ui options .. py:class:: EigentuemerConfig(*args, **kwargs) Bases: :py:obj:`gws.ConfigWithAccess` Access to the Eigentümer (owner) information .. py:attribute:: controlMode :type: bool :value: False restricted mode enabled .. py:attribute:: controlRules :type: Optional[list[str]] regular expression for the restricted input control .. py:attribute:: logTable :type: str :value: '' data access protocol table name .. py:class:: EigentuemerOptions Bases: :py:obj:`gws.Node` Configurable GWS object. .. py:attribute:: controlMode :type: bool .. py:attribute:: controlRules :type: list[str] .. py:attribute:: logTable :type: Optional[gws.lib.sa.Table] .. py:attribute:: logTableName :type: str .. py:method:: configure() Configuration hook. .. py:class:: ExportFlurstueckRequest(*args, **kwargs) Bases: :py:obj:`gws.Request` Command request. .. py:attribute:: findRequest :type: FindFlurstueckRequest .. py:attribute:: groupIndexes :type: list[int] .. py:class:: ExportFlurstueckResponse(*args, **kwargs) Bases: :py:obj:`gws.Response` Command response. .. py:attribute:: content :type: str .. py:attribute:: mime :type: str .. py:class:: ExportGroupProps(*args, **kwargs) Bases: :py:obj:`gws.Props` Object properties. .. py:attribute:: index :type: int .. py:attribute:: title :type: str .. py:class:: FindAdresseRequest(*args, **kwargs) Bases: :py:obj:`gws.Request` Command request. .. py:attribute:: bisHausnummer :type: Optional[str] .. py:attribute:: combinedAdresseCode :type: Optional[str] .. py:attribute:: crs :type: Optional[gws.Crs] .. py:attribute:: gemarkung :type: Optional[str] .. py:attribute:: gemarkungCode :type: Optional[str] .. py:attribute:: gemeinde :type: Optional[str] .. py:attribute:: gemeindeCode :type: Optional[str] .. py:attribute:: hausnummer :type: Optional[str] .. py:attribute:: hausnummerNotNull :type: Optional[bool] .. py:attribute:: kreis :type: Optional[str] .. py:attribute:: kreisCode :type: Optional[str] .. py:attribute:: land :type: Optional[str] .. py:attribute:: landCode :type: Optional[str] .. py:attribute:: regierungsbezirk :type: Optional[str] .. py:attribute:: regierungsbezirkCode :type: Optional[str] .. py:attribute:: strasse :type: Optional[str] .. py:attribute:: wantHistorySearch :type: Optional[bool] .. py:class:: FindAdresseResponse(*args, **kwargs) Bases: :py:obj:`gws.Response` Command response. .. py:attribute:: features :type: list[gws.FeatureProps] .. py:attribute:: total :type: int .. py:class:: FindFlurstueckRequest(*args, **kwargs) Bases: :py:obj:`gws.Request` Command request. .. py:attribute:: bblatt :type: Optional[str] .. py:attribute:: combinedFlurstueckCode :type: Optional[str] .. py:attribute:: crs :type: Optional[gws.CrsName] .. py:attribute:: displayThemes :type: Optional[list[gws.plugin.alkis.data.types.DisplayTheme]] .. py:attribute:: eigentuemerControlInput :type: Optional[str] .. py:attribute:: flaecheBis :type: Optional[float] .. py:attribute:: flaecheVon :type: Optional[float] .. py:attribute:: flurnummer :type: Optional[str] .. py:attribute:: flurstuecksfolge :type: Optional[str] .. py:attribute:: fsnummer :type: Optional[str] .. py:attribute:: gemarkung :type: Optional[str] .. py:attribute:: gemarkungCode :type: Optional[str] .. py:attribute:: gemeinde :type: Optional[str] .. py:attribute:: gemeindeCode :type: Optional[str] .. py:attribute:: hausnummer :type: Optional[str] .. py:attribute:: kreis :type: Optional[str] .. py:attribute:: kreisCode :type: Optional[str] .. py:attribute:: land :type: Optional[str] .. py:attribute:: landCode :type: Optional[str] .. py:attribute:: limit :type: Optional[int] .. py:attribute:: nenner :type: Optional[str] .. py:attribute:: personName :type: Optional[str] .. py:attribute:: personVorname :type: Optional[str] .. py:attribute:: regierungsbezirk :type: Optional[str] .. py:attribute:: regierungsbezirkCode :type: Optional[str] .. py:attribute:: shapes :type: Optional[list[gws.base.shape.Props]] .. py:attribute:: strasse :type: Optional[str] .. py:attribute:: uids :type: Optional[list[str]] .. py:attribute:: wantEigentuemer :type: Optional[bool] .. py:attribute:: wantHistoryDisplay :type: Optional[bool] .. py:attribute:: wantHistorySearch :type: Optional[bool] .. py:attribute:: zaehler :type: Optional[str] .. py:class:: FindFlurstueckResponse(*args, **kwargs) Bases: :py:obj:`gws.Response` Command response. .. py:attribute:: features :type: list[gws.FeatureProps] .. py:attribute:: total :type: int .. py:class:: FindFlurstueckResult(*args, **kwargs) Bases: :py:obj:`gws.Data` Basic data object. This object can be instantiated by passing one or or ``dict`` arguments and/or keyword args. All dicts keys and keywords become attributes of the object. Accessing an undefined attribute returns ``None`` and no error is raised, unless the attribute name starts with an underscore. .. py:attribute:: flurstueckList :type: list[gws.plugin.alkis.data.types.Flurstueck] .. py:attribute:: query :type: gws.plugin.alkis.data.types.FlurstueckQuery .. py:attribute:: total :type: int .. py:class:: GemarkungListMode Bases: :py:obj:`gws.Enum` Enumeration type. Despite being declared as extending ``Enum`` (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn't provide any ``Enum``-specific utilities. The rationale behind this is that we need ``Enum`` members (e.g. ``Color.RED``) to be scalars, and not complex objects as in the standard ``Enum``. .. py:attribute:: combined :value: 'combined' "gemarkung (gemeinde) .. py:attribute:: none :value: 'none' do not show the list .. py:attribute:: plain :value: 'plain' only "gemarkung .. py:attribute:: tree :value: 'tree' a tree with level 1 = gemeinde and level 2 = gemarkung .. py:class:: GetToponymsRequest(*args, **kwargs) Bases: :py:obj:`gws.Request` Command request. .. py:class:: GetToponymsResponse(*args, **kwargs) Bases: :py:obj:`gws.Response` Command response. .. py:attribute:: gemarkung :type: list[list[str]] .. py:attribute:: gemeinde :type: list[list[str]] .. py:attribute:: strasse :type: list[list[str]] .. py:class:: Model Bases: :py:obj:`gws.base.model.default_model.Object` .. py:method:: configure() .. py:class:: Object Bases: :py:obj:`gws.base.action.Object` .. py:attribute:: ADRESSE_QUERY_FIELDS :value: ['gemarkung', 'gemarkungCode', 'gemeinde', 'gemeindeCode', 'kreis', 'kreisCode', 'land',... .. py:attribute:: buchung :type: BuchungOptions .. py:attribute:: buchungsblattSearchOptions :type: gws.TextSearchOptions .. py:attribute:: COMBINED_ADRESSE_FIELDS :value: ['strasse', 'hausnummer', 'plz', 'gemeinde', 'bisHausnummer'] .. py:attribute:: COMBINED_FLURSTUECK_FIELDS :value: ['landCode', 'gemarkungCode', 'flurnummer', 'zaehler', 'nenner', 'flurstuecksfolge'] .. py:attribute:: dataSchema :type: str .. py:attribute:: db :type: gws.DatabaseProvider .. py:attribute:: eigentuemer :type: EigentuemerOptions .. py:attribute:: export :type: Optional[Object.export] .. py:attribute:: FLURSTUECK_QUERY_FIELDS :value: ['flurnummer', 'flurstuecksfolge', 'zaehler', 'nenner', 'flurstueckskennzeichen', 'flaecheBis',... .. py:attribute:: ix :type: gws.plugin.alkis.data.index.Object .. py:attribute:: ixStatus :type: gws.plugin.alkis.data.index.Status .. py:attribute:: limit :type: int .. py:attribute:: model :type: gws.Model .. py:attribute:: nameSearchOptions :type: gws.TextSearchOptions .. py:attribute:: printers :type: list[gws.Printer] .. py:attribute:: storage :type: Optional[gws.base.storage.Object] .. py:attribute:: strasseSearchOptions :type: gws.TextSearchOptions .. py:attribute:: templates :type: list[gws.Template] .. py:attribute:: ui :type: Ui .. py:method:: activate() .. py:method:: configure() .. py:method:: export_flurstueck(req: gws.WebRequester, p: ExportFlurstueckRequest) -> ExportFlurstueckResponse .. py:method:: find_adresse(req: gws.WebRequester, p: FindAdresseRequest) -> FindAdresseResponse Perform an Adresse search. .. py:method:: find_adresse_objects(req: gws.WebRequester, p: FindAdresseRequest) -> tuple[list[gws.plugin.alkis.data.types.Adresse], gws.plugin.alkis.data.types.AdresseQuery] .. py:method:: find_flurstueck(req: gws.WebRequester, p: FindFlurstueckRequest) -> FindFlurstueckResponse Perform a Flurstueck search .. py:method:: find_flurstueck_objects(req: gws.WebRequester, p: FindFlurstueckRequest) -> tuple[list[gws.plugin.alkis.data.types.Flurstueck], gws.plugin.alkis.data.types.FlurstueckQuery] .. py:method:: get_toponyms(req: gws.WebRequester, p: GetToponymsRequest) -> GetToponymsResponse Return all Toponyms (Gemeinde/Gemarkung/Strasse) in the area .. py:method:: handle_storage(req: gws.WebRequester, p: gws.base.storage.Request) -> gws.base.storage.Response .. py:method:: print_flurstueck(req: gws.WebRequester, p: PrintFlurstueckRequest) -> gws.PrintJobResponse Print Flurstueck features .. py:method:: props(user) .. py:class:: PrintFlurstueckRequest(*args, **kwargs) Bases: :py:obj:`gws.Request` Command request. .. py:attribute:: featureStyle :type: gws.StyleProps .. py:attribute:: findRequest :type: FindFlurstueckRequest .. py:attribute:: printRequest :type: gws.PrintRequest .. py:class:: Props Bases: :py:obj:`gws.base.action.Props` .. py:attribute:: buchungsblattSearchOptions :type: Optional[gws.TextSearchOptions] .. py:attribute:: exportGroups :type: list[ExportGroupProps] .. py:attribute:: limit :type: int .. py:attribute:: nameSearchOptions :type: Optional[gws.TextSearchOptions] .. py:attribute:: printer :type: Optional[gws.base.printer.Props] .. py:attribute:: storage :type: Optional[gws.base.storage.Props] .. py:attribute:: strasseSearchOptions :type: Optional[gws.TextSearchOptions] .. py:attribute:: ui :type: Ui .. py:attribute:: withBuchung :type: bool .. py:attribute:: withEigentuemer :type: bool .. py:attribute:: withEigentuemerControl :type: bool .. py:attribute:: withFlurnummer :type: bool .. py:class:: StrasseListMode Bases: :py:obj:`gws.Enum` Enumeration type. Despite being declared as extending ``Enum`` (for IDE support), this class is actually just a simple object and intended to be used as a collection of attributes. It doesn't provide any ``Enum``-specific utilities. The rationale behind this is that we need ``Enum`` members (e.g. ``Color.RED``) to be scalars, and not complex objects as in the standard ``Enum``. .. py:attribute:: plain :value: 'plain' just strasse .. py:attribute:: withGemarkung :value: 'withGemarkung' strasse (gemarkung) .. py:attribute:: withGemarkungIfRepeated :value: 'withGemarkungIfRepeated' strasse (gemarkung), when needed for disambiguation .. py:attribute:: withGemeinde :value: 'withGemeinde' strasse (gemeinde) .. py:attribute:: withGemeindeIfRepeated :value: 'withGemeindeIfRepeated' strasse (gemeinde), when needed for disambiguation .. py:class:: Ui(*args, **kwargs) Bases: :py:obj:`gws.Config` Flurstückssuche UI configuration. .. py:attribute:: autoSpatialSearch :type: bool :value: False activate spatial search after submit .. py:attribute:: gemarkungListMode :type: GemarkungListMode :value: 'combined' gemarkung list mode .. py:attribute:: searchSelection :type: bool :value: False search in selection enabled .. py:attribute:: searchSpatial :type: bool :value: False spatial search enabled .. py:attribute:: strasseListMode :type: StrasseListMode :value: 'plain' strasse list entry format .. py:attribute:: useExport :type: bool :value: False export function enabled .. py:attribute:: useHistory :type: bool :value: False history controls enabled .. py:attribute:: usePick :type: bool :value: False pick mode enabled .. py:attribute:: useSelect :type: bool :value: False select mode enabled