Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | 1x 1x 1x 1x 1x | import CommonService from "../CommonService";
import DefaultUrlService from "../DefaultUrlService";
import AutoCompleteResponseFactory from "./Response/AutoCompleteResponseFactory";
import Logger from "../../Utils/LoggerByDefault";
import MR from "../../Utils/MessagesResources";
import Helper from "../../Utils/Helper";
import ErrorService from "../../Exceptions/ErrorService";
/**
* @classdesc
* Appel du service d'autocomplétion du Géoportail :
* envoi de la requête construite selon les paramètres en options,
* éventuellement parsing et analyse de la réponse,
* retour d'une réponse en paramètre de la fonction onSuccess.
* @constructor
* @extends {Gp.Services.CommonService}
* @alias Gp.Services.AutoComplete
*
* @param {Object} options - options spécifiques au service (+ les options heritées)
*
* @param {String} options.text - La chaîne de caractère à compléter.
* Cette chaîne n'est pas "URL encodée".
* C'est l'API qui s'occupe de l'encoder pour l'inclure dans la requête.
*
* @param {Array.<String>} [options.type = ["StreetAddress"]] - Type de l'objet recherché.
* Le service d'autocomplétion du Géoportail permet de rechercher des toponymes 'PositionOfInterest' et/ou des adresses postales 'StreetAddress'.
* D'autres types pourront être rajoutés selon l'évolution du service.
* Par défaut, type = ['StreetAddress'].
*
* @param {String} [options.territory] - Limitation de la zone de recherche de localisants.
* Le service d'autocomplétion du Géoportail permet de limiter la recherche à la métropole et la Corse : options.territory = 'METROPOLE',
* DOMS TOMS : options.territory = 'DOMTOM', ou à un département : options.territory = '31'
* Pas de valeur par défaut.
* La valeur par défaut est donc celle du service.
* Le service d'autocomplétion du Géoportail renvoie toutes les informations quand aucun territoire n'est spécifié.
*
* @param {Number} [options.maximumResponses = 10] - Nombre de réponses maximal que l'on souhaite recevoir.
* Pas de valeur par défaut.
* La valeur par défaut sera donc celle du service : 10.
*
* @example
* var options = {
* // options communes aux services
* apiKey : null,
* serverUrl : 'http://localhost/service/',
* protocol : 'JSONP', // JSONP|XHR
* proxyURL : null,
* httpMethod : 'GET', // GET|POST
* timeOut : 10000, // ms
* rawResponse : false, // true|false
* scope : null, // this
* onSuccess : function (response) {},
* onFailure : function (error) {},
* // spécifique au service
* text : "",
* type : "StreetAddress",
* territory : 'METROPOLE',
* maximumResponses : 10
* };
*/
function AutoComplete (options_) {
if (!(this instanceof AutoComplete)) {
throw new TypeError(MR.getMessage("CLASS_CONSTRUCTOR", "AutoComplete"));
}
/**
* Nom de la classe (heritage)
* FIXME instance ou classe ?
*/
this.CLASSNAME = "AutoComplete";
this.logger = Logger.getLogger("Gp.Services.AutoComplete");
this.logger.trace("[Constructeur AutoComplete (options)]");
var options = this.patchOptionConvertor(options_);
if (!options.serverUrl) {
options.serverUrl = DefaultUrlService.AutoComplete.newUrl();
}
// appel du constructeur par heritage
CommonService.apply(this, arguments);
if (!options.text) {
throw new Error(MR.getMessage("PARAM_MISSING", "text"));
}
// ajout des options spécifiques au service
this.options.text = options.text;
// on definit des parametres par defaut
if (!options.type) {
options.type = ["StreetAddress,PositionOfInterest"];
}
this.options.type = options.type;
this.options.territory = options.terr || "";
this.options.maximumResponses = options.maximumResponses || 10;
// INFO
// le service ne repond pas en mode POST (405 Method Not Allowed)
if (this.options.protocol === "XHR" && this.options.httpMethod === "POST") {
this.logger.warn("Le service ne gére pas le mode d'interrogation en POST, on bascule sur du GET !");
this.options.httpMethod = "GET"; // on surcharge !
}
// attributs d'instances
/**
* Format forcé de la réponse du service : "json"
* sauf si l'on souhaite une reponse brute (options.rawResponse)
*/
this.options.outputFormat = (this.options.rawResponse) ? "" : "json";
}
/**
* @lends module:AutoComplete#
*/
AutoComplete.prototype = Object.create(CommonService.prototype, {
// todo
// getter/setter
});
/*
* Constructeur (alias)
*/
AutoComplete.prototype.constructor = AutoComplete;
/**
* Patch pour la convertion des options vers le nouveau formalisme.
*
* @param {Object} options_ - options du service
* @return {Object} - options
*/
AutoComplete.prototype.patchOptionConvertor = function (options_) {
const options = options_;
if (options.filterOptions) {
this.logger.warn("The parameter 'filterOptions' is deprecated");
if (options.filterOptions.type) {
this.logger.warn("The parameter 'filterOptions.type' is deprecated");
if (!options.type) {
options.type = options.filterOptions.type;
}
}
if (options.filterOptions.territory) {
this.logger.warn("The parameter 'filterOptions.territory' is deprecated");
if (!options.terr) {
options.terr = options.filterOptions.territory;
}
}
delete options.filterOptions;
}
return options;
};
/**
* (overwrite)
* Création de la requête
*
* @param {Function} error - callback des erreurs
* @param {Function} success - callback
*/
AutoComplete.prototype.buildRequest = function (error, success) {
// ex.
// http://wxs.ign.fr/CLEF/ols/apis/completion?
// text=Brie-Comt&
// type=StreetAddress,PositionOfInterest&
// territory=METROPOLE&
// maximumResponses=10
// traitement des param KPV sous forme de tableau
var territory = "";
if (this.options.territory) {
territory = this.options.territory;
}
var type = "";
if (this.options.type) {
type = this.options.type.join(",");
}
// normalisation de la requete avec param KPV
this.request = Helper.normalyzeParameters({
text : encodeURIComponent(this.options.text),
type : type,
terr : territory,
maximumResponses : this.options.maximumResponses
});
(!this.request)
? error.call(this, new ErrorService(MR.getMessage("SERVICE_REQUEST_BUILD")))
: success.call(this, this.request);
};
/**
* (overwrite)
* Analyse de la reponse
*
* @param {Function} error - callback des erreurs
* @param {Function} success - callback de succès de l'analyse de la réponse
*/
AutoComplete.prototype.analyzeResponse = function (error, success) {
if (this.response) {
var options = {
response : this.response,
rawResponse : this.options.rawResponse,
onSuccess : success,
onError : error,
scope : this
};
AutoCompleteResponseFactory.build(options);
} else {
error.call(this, new ErrorService(MR.getMessage("SERVICE_RESPONSE_EMPTY")));
}
};
export default AutoComplete;
|