## Uses of Class
com.gisgraphy.domain.geoloc.entity.Adm

- Packages that use Adm
  Package | Description
  --- | ---
  com.gisgraphy.domain.geoloc.entity |
  com.gisgraphy.domain.repository |
  com.gisgraphy.domain.valueobject | Gisgraphy Project This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
  com.gisgraphy.importer |

- - ### Uses of Adm in com.gisgraphy.domain.geoloc.entity

    Methods in com.gisgraphy.domain.geoloc.entity that return Adm
    Modifier and Type | Method and Description
    --- | ---
    `Adm` | GisFeature.`getAdm()`
    `Adm` | Adm.`getParent()` Returns The parent Adm in the Adm tree structure

    Methods in com.gisgraphy.domain.geoloc.entity that return types with arguments of type Adm
    Modifier and Type | Method and Description
    --- | ---
    `List<Adm>` | Adm.`getChildren()` Return the Adms of a directly higher Level in the adm the tree structure

    Methods in com.gisgraphy.domain.geoloc.entity with parameters of type Adm
    Modifier and Type | Method and Description
    --- | ---
    `void` | Adm.`addChild(Adm child)` Do a double set : Add (not replace !
    `void` | GisFeature.`setAdm(Adm adm)`
    `void` | Adm.`setParent(Adm parent)` Set the parent Adm in the tree structure

    Method parameters in com.gisgraphy.domain.geoloc.entity with type arguments of type Adm
    Modifier and Type | Method and Description
    --- | ---
    `void` | Adm.`addChildren(List<Adm> children)` Do a double set : Add (not replace !)
    `void` | Adm.`setChildren(List<Adm> children)` Set the Adms of a directly higher level

  - ### Uses of Adm in com.gisgraphy.domain.repository

    Methods in com.gisgraphy.domain.repository that return Adm
    Modifier and Type | Method and Description
    --- | ---
    `Adm` | AdmDao.`get(Long id)`
    `Adm` | IAdmDao.`getAdm(String countryCode, String adm1Code, String adm2Code, String adm3Code, String adm4Code)` Retrieve the Adm of the highest level according to the AdmXcode.
    `Adm` | AdmDao.`getAdm(String countryCode, String adm1Code, String adm2Code, String adm3Code, String adm4Code)`
    `Adm` | IAdmDao.`getAdm1(String countryCode, String adm1Code)`
    `Adm` | AdmDao.`getAdm1(String countryCode, String adm1Code)`
    `Adm` | IAdmDao.`getAdm2(String countryCode, String adm1Code, String adm2Code)`
    `Adm` | AdmDao.`getAdm2(String countryCode, String adm1Code, String adm2Code)`
    `Adm` | IAdmDao.`getAdm3(String countryCode, String adm1Code, String adm2Code, String adm3Code)`
    `Adm` | AdmDao.`getAdm3(String countryCode, String adm1Code, String adm2Code, String adm3Code)`
    `Adm` | IAdmDao.`getAdm4(String countryCode, String adm1Code, String adm2Code, String adm3Code, String adm4Code)`
    `Adm` | AdmDao.`getAdm4(String countryCode, String adm1Code, String adm2Code, String adm3Code, String adm4Code)`
    `Adm` | IAdmDao.`getAdmOrFirstValidParentIfNotFound(String countryCode, String adm1Code, String adm2Code, String adm3Code, String adm4Code)` Return The Adm for the specified Code in the same way of `IAdmDao.getAdm(String, String, String, String, String)` or the first valid parent if no Adm is found with the specified codes.
    `Adm` | AdmDao.`getAdmOrFirstValidParentIfNotFound(String countryCode, String adm1Code, String adm2Code, String adm3Code, String adm4Code)`
    `Adm` | AdmDao.`save(Adm adm)` Check that codes are consistent according the level (see `isConsistentForLevel()` and save it in the datastore
    `Adm` | IAdmDao.`suggestMostAccurateAdm(String countryCode, String adm1Code, String adm2Code, String adm3Code, String adm4Code, GisFeature gisFeature)` This method is used when `ImporterConfig.isTryToDetectAdmIfNotFound()` is true or when error correction is needed. the algorithm will return an Adm according the specified rules: If an Adm with the specified code is found (see `IAdmDao.getAdm(String, String, String, String, String)`) : retrun it If an Adm with the highest not null level is found for the specified country (e.g : if adm1,2,3 are specified and adm4 is null and it exist an adm with level 3 for the specified adm3Code then it will be return) If no parent Adm is found (see `IAdmDao.getAdmOrFirstValidParentIfNotFound(String, String, String, String, String)` : return Adm with the highest not null level If a parent Adm is found (see `IAdmDao.getAdmOrFirstValidParentIfNotFound(String, String, String, String, String)` : If the difference beetween the Adm and The parent Adm is <=2 : we assume that it is an error with only one code and return the Adm with the highest not null level If the difference is >1 we assume that there is too much error and return the nearest parent If No Adm with the highest not null level is found for the specified country If a parent Adm is found (see `IAdmDao.getAdmOrFirstValidParentIfNotFound(String, String, String, String, String)` : return Adm with the highest not null level : return the Parent If no parent is found : return null
    `Adm` | AdmDao.`suggestMostAccurateAdm(String countryCode, String adm1Code, String adm2Code, String adm3Code, String adm4Code, GisFeature gisfeature)`

    Methods in com.gisgraphy.domain.repository that return types with arguments of type Adm
    Modifier and Type | Method and Description
    --- | ---
    `List<Adm>` | IAdmDao.`getAdmByCountryAndCodeAndLevel(String countryCode, String admCode, int level)` Returns The Adm with the specified code and the specified level for the specified country code.
    `List<Adm>` | AdmDao.`getAdmByCountryAndCodeAndLevel(String countryCode, String admCode, int level)`
    `List<Adm>` | IAdmDao.`getAllbyLevel(int level)`
    `List<Adm>` | AdmDao.`getAllbyLevel(int level)`
    `List<Adm>` | AdmDao.`getDirties()`
    `List<Adm>` | IAdmDao.`getUnused()`
    `List<Adm>` | AdmDao.`getUnused()`

    Methods in com.gisgraphy.domain.repository with parameters of type Adm
    Modifier and Type | Method and Description
    --- | ---
    `Adm` | AdmDao.`save(Adm adm)` Check that codes are consistent according the level (see `isConsistentForLevel()` and save it in the datastore

  - ### Uses of Adm in com.gisgraphy.domain.valueobject

    Methods in com.gisgraphy.domain.valueobject with parameters of type Adm
    Modifier and Type | Method and Description
    --- | ---
    `com.gisgraphy.domain.valueobject.GisFeatureDistance` | GisFeatureDistanceFactory.`fromAdm(Adm adm, Double distance)`

  - ### Uses of Adm in com.gisgraphy.importer

    Methods in com.gisgraphy.importer that return Adm
    Modifier and Type | Method and Description
    --- | ---
    `protected Adm` | GeonamesFeatureSimpleImporter.`processAdm(String[] fields, GisFeature gisFeature)`

Copyright © 2015. All rights reserved.