FieldMap

Récapitulatif

L'objet FieldMap fournit une définition de champ et une liste de champs en entrée issues d'un ensemble de tables ou de classes d'entités.

Discussion

L'objet FieldMappings est une collection d'objets FieldMap et il sert de valeur de paramètre pour les outils qui exécutent un appariement de champs, tels que l'outil Fusionner. La méthode la plus simple pour utiliser ces objets consiste à créer d'abord un objet FieldMappings, puis à initialiser ses objets FieldMap en ajoutant les classes d'entités ou les tables en entrée à associer. 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 issu de toutes les entrées. Cette liste peut être modifiée en ajoutant de nouveaux champs, en modifiant les propriétés et/ou le contenu d'un champ en sortie ou en supprimant tous les champs en sortie non souhaités.

Les propriétés de l'objet FieldMap incluent les positions de début et de fin d'une valeur textuelle en entrée, afin qu'une nouvelle valeur en sortie puisse être créée à l'aide d'une partie 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, les valeurs de chaque enregistrement sont fusionnées à l'aide de la propriété mergeRule. Cette méthode est pratique pour joindre des valeurs, telles qu'un nom de rue stocké dans un champ et un type de rue stocké dans un autre, par exemple, Eureka et Rue. La propriété joinDelimiter de FieldMap est utilisée si la valeur spécifiée de mergeRule est Jointure. Tout ensemble de caractères, tel qu'un espace, peut être utilisé comme délimiteur. Dans l'exemple ci-dessus, la valeur Rue Eureka serait créée.

Syntaxe

FieldMap ()

Propriétés

Propriété	Explication	Type de données
inputFieldCount (Lecture seule)	Get the count of subfields.	Integer
joinDelimiter (Lecture et écriture)	Join delimiter for the subfields.	String
mergeRule (Lecture et écriture)	Merge rule for the subfields.	String
outputField (Lecture et écriture)	Get the properties field.	Field

Vue d'ensemble des méthodes

Méthode	Explication
addInputField (table_dataset, field_name, {start_position}, {end_position})	Adds input field to the field map.
findInputFieldIndex (table_dataset, field_name)	Finds an input field from the field map.
getEndTextPosition (index)	Gets end text position from the field map.
getInputFieldName (index)	Gets the name of an input field from the field map, based on the field's index.
getInputTableName (index)	Gets the name of an input table from the field map, based on the table's index.
getStartTextPosition (index)	Gets start text position from the field map.
removeAll ()	Removes all values and creates an empty object.
removeInputField (index)	Removes an input field from the field map.
setEndTextPosition (index, end_position)	Sets end text position for the field map.
setStartTextPosition (index, start_position)	Sets the start text position from the field map.

Méthodes

addInputField (table_dataset, field_name, {start_position}, {end_position})

Paramètre	Explication	Type de données
table_dataset	The table added to the field map.	String
field_name	The input field name.	String
start_position	The start position of an input text value. (La valeur par défaut est -1)	Integer
end_position	The end position of an input text value. (La valeur par défaut est -1)	Integer

findInputFieldIndex (table_dataset, field_name)

Paramètre	Explication	Type de données
table_dataset	The table added to the field map.	String
field_name	The field name.	String

Valeur renvoyée

Type de données	Explication
Integer	The index position of the field name.

getEndTextPosition (index)

Paramètre	Explication	Type de données
index	The index position.	Integer

Valeur renvoyée

Type de données	Explication
Integer	The end text position.

getInputFieldName (index)

Paramètre	Explication	Type de données
index	The index position.	Integer

Valeur renvoyée

Type de données	Explication
String	The input field name.

getInputTableName (index)

Paramètre	Explication	Type de données
index	The index position.	Integer

Valeur renvoyée

Type de données	Explication
String	The input table name.

getStartTextPosition (index)

Paramètre	Explication	Type de données
index	The index position.	Integer

Valeur renvoyée

Type de données	Explication
Integer	The start text position.

removeAll ()

removeInputField (index)

Paramètre	Explication	Type de données
index	The index position.	Integer

setEndTextPosition (index, end_position)

Paramètre	Explication	Type de données
index	The index position.	Integer
end_position	The end position of an input text value.	Integer

setStartTextPosition (index, start_position)

Paramètre	Explication	Type de données
index	The index position.	Integer
start_position	The start position of an input text value.	Integer

Exemple de code

Exemple d'objet FieldMap

import arcpy
from arcpy import env

# Input feature classes contain a PID field that is a composite of
#   the Township, Range, Section, QuarterSection, Block, Lot, and SubLot values.
#   We need to define how to break the PID field into two fields: TWNSHIP and BLOCK,
#   then run the Merge tool.
#   PID field and field map. 
#                    1 1 1 1 1 1 1
#  1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6
# +-------------------------------+
# |2|0|3|0|8|2|1|0|0|1|0|0|5|0|0|0|
# +-------------------------------+
# +---TWNSHIP---+-------BLOCK-----+

infc1 = "C:/Data/NewParcels.shp"
infc2 = "Parcels"
outfc = "Parcels_Merge"

# Create a fieldmappings object and two fieldmap objects
#
fieldmappings = arcpy.FieldMappings()
fldmap_TWNSHIP = arcpy.FieldMap()
fldmap_BLOCK = arcpy.FieldMap()

# Create a value table to hold names of input feature classes for Merge tool.
#
vt = arcpy.ValueTable()

# Add all fields from first input feature class to fieldmappings object
#   AddTable is the most efficient way.
#
fieldmappings.addTable(infc1)

# Add the TWNSHIP and BLOCK field from the first input feature class 
#   to fieldmap object.
#
fldmap_TWNSHIP.addInputField(infc1)
fldmap_BLOCK.addInputField(infc1)
vt.addRow(infc1)

# Add all fields from second input feature class to fieldmappings object
#
env.workspace = "C:/Data/Boulder.gdb"
fieldmappings.addTable(infc2)

# Add the TWNSHIP and BLOCK field from the second input feature class 
#   to fieldmap object.
#
fldmap_TWNSHIP.addInputField(infc2)
fldmap_BLOCK.addInputField(infc2)
vt.addRow(infc2)

# Set the starting and ending positions of the input field in the fieldmap.
#   This is for TWNSHIP
for x in range(0, fldmap_TWNSHIP.inputFieldCount):
    fldmap_TWNSHIP.setStartTextPosition(x, 0)
    fldmap_TWNSHIP.setEndFieldPosition(x, 6)

# Set the starting and ending positions of the input field in the fieldmap.
#   This is for BLOCK
for x in range(0, fldmap_BLOCK.inputFieldCount):
    fldmap_BLOCK.setStartTextPosition(x, 7)
    fldmap_BLOCK.setEndFieldPosition(x, 15)

# Get the new field object from fieldmap, set field name, place back in fieldmap.
#
fld_TWNSHIP = fldmap_TWNSHIP.outputField
fld_TWNSHIP.name = "TWNSHIP"
fldmap_TWNSHIP.outputField = fld_TWNSHIP
fld_BLOCK = fldmap_BLOCK.outputField
fld_BLOCK.name = "BLOCK"
fldmap_BLOCK.outputField = fld_BLOCK

# Add the new fieldmap object to fieldmappings object.
fieldmappings.addFieldMap(fldmap_TWNSHIP)
fieldmappings.addFieldMap(fldmap_BLOCK)

#Run the Merge tool
arcpy.Merge_management(vt, outfc, fieldmappings)