$csv.makeFormat

Description

Construit un objet de description de format de CSV.

L'objet en question est un ensemble de paramètres qui décrivent les principales caractéristiques du CSV (le type de délimiteur, le type de retour ligne, l'existence d'une ligne d'entête, etc.)

La méthode propose une série de formats prédéfinis (option format). Il s'agit d'ensembles de paramètres prédéfinis propres à différents générateurs de CSV.

format	delimiter	escapeCharacter	quote	quoteMode	recordSeparator	ignoreEmptyLines	duplicateHeaderMode	skipHeaderRecord	nullString	trim	ignoreSurroundingSpaces
default	,		"		\r\n	true	allow_all
excel	,		"		\r\n	false	allow_all
informix_unload	,	\\	"		\n
informix_unload_csv	,		"		\n
mongodb_csv	,	"	"	all_non_null				false
mongodb_tsv	\t	"	"	all_non_null				false
mysql	\t	\\	null	all_non_null	\n	false		false	\\N
oracle	,	\\	"	minimal	system	false			\\N	true
postgresql_csv	,	null	"	all_non_null	\n	true			string vide
postgresql_tsv	\t	\\	null	all_non_null	\n	true			\\N
rfc4180	,		"		\r\n	false
tdf	\t		"		\r\n						true

Syntaxe

$csv.makeFormat( rules )

Paramètres

rules map

Ensemble de règles de formatage d'un CSV. Les règles reconnues sont:

format

Format prédéfini. Cette option permet de spécfier un ensemble de paramètres prédéfinis au moyen d'un terme unique. Les formats reconnus sont:

• default
• excel
• informix_unload
• informix_unload_csv
• mongodb_csv
• mongodb_tsv
• mysql
• oracle
• postgresql_csv
• postgresql_text
• rfc4180
• tdf

Voir le tableau donné dans la description pour le détail des paramètres.

Il est possible de spécifier un format prédéfini tel que ci-dessus et de passer des règles supplémentaires (telles que ci-dessous) pour surcharger le format. Les règles explicites priment sur le format prédéfini.

allowMissingColumnNames

Valeur true/false qui définit le comportement em cas de mom de colonne manquant. La valeur true autorise le nom de colonne manquant alors que false provoque une exception.

autoFlush

Valeur true/false indiquant s'il faut effectuer un flush à la fermeture.

commentMarker

Définit le caractère qui marque un début de commentaire. Doit être un caractère unique. Passer null ou une chaîne vide pour désactiver (c'est-à-dire pour annuler un paramètre par défaut activé par un format pré-défini).

delimiter

Délimiteur de colonne sous forme de string

duplicateHeaderMode

Indique le comportement en cas de doublon sur les noms de colonne. Les valeurs possibles sont allow_all, allow_empty, disallow

escapeCharacter

Caractère d'échappement. Doit être un caractère unique.

headerComments

Définit les commentaires d'entête. Par exemple le fait de passer un tableau [ "Generated by Ewt", $cal.date() ] va ajouter des commentaires avant la ligne d'entête.

headers

Indique le nom des enêtes. La valeur doit être un tableau de string.

ignoreEmptyLines

Valeur true/false qui décrit le comportement de saut de ligne vide. La valeur true permet d'ignorer les lignes vides alors que false convertit la ligne vide en enregistrement vide.

ignoreHeaderCase

Valeur true/false qui définit le comportement de l'analyseur en matière de correspondance de majuscules/minuscules. Indiquer true pour accéder aux noms/valeurs, false pour laisser la correspondance telle quelle.

ignoreSurroundingSpaces

Valeur true/false qui définit le comportement de découpage de l'analyseur. Indiquer true pour supprimer les espaces environnants, false pour laisser les espaces tels quels.

nullString

Valeur à utiliser en remplacement de valeur null.

quoteCharacter

Caractère de délimitation de texte. Ne doit contenir qu'un seul caractère.

quoteMode

Mode de cotation à utiliser lors de la génération de CSV. Les valeurs possibles sont all, all_non_null, minimal, non_numeric, none.

recordSeparator

Séparateur d'enregistrements à utiliser en sortie.

Utiliser la valeur system pour indiquer d'utiliser le séparateur par défaut lié au système.

skipHeaderRecord

Valeur true/false indiquant d'ignorer l'entête.

trailingDelimiter

Valeur true/false qui indique s'il faut ajouter un délimiteur de fin.

trim

Valeur true/false qui indique s'il faut effectuer un trim des valeurs (suppression des blancs en début et fin de valeur).

Retour

Retourne un objet pojo contenant les règles de formatage prédéfinies.

Exemple

Non disponible