Résumé
The FieldMappings object is a collection of FieldMap objects and it is used as the parameter value for tools that perform field mapping, such as Merge.
Discussion
Les propriétés de l’objet FieldMap comprennent la position de départ et la position de fin d’une valeur de texte en entrée, de façon à ce qu’une valeur en sortie puisse être créée à l’aide d’une tranche d’une valeur en entrée. Si un objet FieldMap contient plusieurs champs en entrée provenant de la même table ou classe d'entités, chaque valeur d’enregistrement est fusionnée à l’aide de la propriété mergeRule. Il s’agit d’une méthode pratique pour concaténer des valeurs, comme un nom de rue contenu dans un champ et un type de voie contenu dans un autre champ, par exemple, Eureka et Street. La propriété joinDelimiter de FieldMap est utilisée si la valeur mergeRule Join est spécifiée. N’importe quel ensemble de caractères, comme un espace, peut être utilisé comme délimiteur. Dans l’exemple ci-dessus, ceci créerait la valeur Eureka Street.
L'objet FieldMappingsest une collection d'objets FieldMap et sert de valeur de paramètre pour les outils qui exécutent un appariement de champs, tels que l’outil Fusionner. La manière la plus simple de travailler avec ces objets est de créer tout d'abord un objet FieldMappings, puis d’initialiser ses objets FieldMap en ajoutant les classes ou tables d’entités en entrée devant être combinées. Une fois toutes les entrées fournies, l’objet FieldMappings contient un objet FieldMap, ou un champ en sortie, pour chaque nom de champ unique de toutes les entrées. Cette liste peut être modifiée en ajoutant de nouveaux champs, en modifiant les propriétés ou le contenu d’un champ en sortie, ou en supprimant tout champ en sortie non désiré.
Syntaxe
FieldMappings ()
Propriétés
| Propriété | Explication | Type de données |
| fieldCount (Lecture seule) | The number of output fields. | Integer |
| fieldMappings (Lecture/écriture) | A list of FieldMap objects that make up the FieldMappings object. | FieldMap |
| fieldValidationWorkspace (Lecture/écriture) | The workspace type that defines the rules for attribute field naming. These rules are used when determining the output field names, which are based on the names of the input fields. For example, setting the fieldValidationWorkspace property to the path of a folder on disk containing the input shapefiles will result in the output field names being truncated to 10 characters. Setting the fieldValidationWorkspace property to the path of a file geodatabase will allow for much longer field names. The fieldValidationWorkspace property should be set with a consideration for the output format. | String |
| fields (Lecture seule) | A list of Field objects. Each field object represents the properties of each output field. | Field |
Vue d’ensemble des méthodes
| Méthode | Explication |
| addFieldMap (field_map) | Add a field map to the field mappings. |
| addTable (table_dataset) | Adds a table to the field mappings object. |
| exportToString () | Exports the object to its string representation. |
| findFieldMapIndex (field_map_name) | Find a field map within the field mappings by name. |
| getFieldMap (index) | Returns a FieldMap object from the FieldMappings object by index position. |
| loadFromString (string) | Restore the object using its string representation. The exportToString method can be used to create a string representation. |
| removeAll () | Removes all values and creates an empty object. |
| removeFieldMap (index) | Removes a FieldMap object from the FieldMappings object. |
| replaceFieldMap (index, value) | Replace a FieldMap object within the FieldMappings object. |
Méthodes
addFieldMap (field_map)
| Paramètre | Explication | Type de données |
field_map | The field map to add to the field mappings | FieldMap |
addTable (table_dataset)
| Paramètre | Explication | Type de données |
table_dataset | The table to add to the field mappings object. | String |
exportToString ()
Valeur renvoyée
| Type de données | Explication |
| String | The string representation of the object. |
findFieldMapIndex (field_map_name)
| Paramètre | Explication | Type de données |
field_map_name | Find the field map by name. | String |
Valeur renvoyée
| Type de données | Explication |
| Integer | The index position of the field map. |
getFieldMap (index)
| Paramètre | Explication | Type de données |
index | The index position of the FieldMap object. | Integer |
Valeur renvoyée
| Type de données | Explication |
| FieldMap | The FieldMap object from the FieldMappings object. |
loadFromString (string)
| Paramètre | Explication | Type de données |
string | The string representation of the object. | String |
removeAll ()
removeFieldMap (index)
| Paramètre | Explication | Type de données |
index | The index position of the FieldMap. | Integer |
replaceFieldMap (index, value)
| Paramètre | Explication | Type de données |
index | The index position of the FieldMap object to be replaced. | Integer |
value | The replacement FieldMap object. | FieldMap |
Exemple de code
FieldMappings example
Les objets FieldMap sont souvent utilisés pour fusionner des jeux de données similaires dans un jeu de données les englobant tous. Dans cet exemple, la classe d'entités Arbres et le shapefile Plants.shp sont fusionnés pour former la classe d’entités nommée Végétation. Chacune des deux classes d'entités d’origine comporte deux attributs : Type et Diamètre. Ces deux attributs doivent être conservés dans la fusion.
import arcpy
# Set the workspace
arcpy.env.workspace = 'c:/base'
in_file1 = 'data.gdb/Trees'
in_file2 = 'Plants.shp'
output_file = 'data.gdb/Vegetation'
# Create the required FieldMap and FieldMappings objects
fm_type = arcpy.FieldMap()
fm_diam = arcpy.FieldMap()
fms = arcpy.FieldMappings()
# Get the field names of vegetation type and diameter for both original
# files
tree_type = "Tree_Type"
plant_type = "Plant_Type"
tree_diam = "Tree_Diameter"
plant_diam = "Diameter"
# Add fields to their corresponding FieldMap objects
fm_type.addInputField(in_file1, tree_type)
fm_type.addInputField(in_file2, plant_type)
fm_diam.addInputField(in_file1, tree_diam)
fm_diam.addInputField(in_file2, plant_diam)
# Set the output field properties for both FieldMap objects
type_name = fm_type.outputField
type_name.name = 'Veg_Type'
fm_type.outputField = type_name
diam_name = fm_diam.outputField
diam_name.name = 'Veg_Diam'
fm_diam.outputField = diam_name
# Add the FieldMap objects to the FieldMappings object
fms.addFieldMap(fm_type)
fms.addFieldMap(fm_diam)
# Merge the two feature classes
arcpy.Merge_management([in_file1, in_file2], output_file, fms)
FieldMappings example 2
Cet exemple montre l’option consistant à utiliser des objets FieldMap pour fusionner des champs, à l’aide de l’outil FeatureClassToFeatureClass. Dans cet exemple, une classe d'entités contient des informations concernant le nombre d’accidents par intersection dans une ville. Les données de chaque année sont contenues dans un champ. L’utilisateur veut connaître le nombre moyen d’accidents pour chaque intersection, sans modifier la table existante.
import arcpy
# Set the workspace arcpy.env.workspace = 'c:/base/data.gdb'
in_file = 'AccidentData' out_file = 'AverageAccidents'
# Create the necessary FieldMap and FieldMappings objects fm = arcpy.FieldMap() fm1 = arcpy.FieldMap() fms = arcpy.FieldMappings()
# Each field with accident data begins with 'Yr' (from Yr2007 to Yr2012). # The next step loops through each of the fields beginning with 'Yr', # and adds them to the FieldMap Object for field in arcpy.ListFields(in_file, 'Yr*'):
fm.addInputField(in_file, field.name)
# Set the merge rule to find the mean value of all fields in the
# FieldMap object fm.mergeRule = 'Mean'
# Set properties of the output name. f_name = fm.outputField f_name.name = 'AvgAccidents' f_name.aliasName = 'AvgAccidents' fm.outputField = f_name
# Add the intersection field to the second FieldMap object fm1.addInputField(in_file, "Intersection")
# Add both FieldMaps to the FieldMappings Object fms.addFieldMap(fm) fms.addFieldMap(fm1)
# Create the output feature class, using the FieldMappings object arcpy.FeatureClassToFeatureClass_conversion( in_file, arcpy.env.workspace, out_file, field_mapping=fms)