FieldMappings (arcpy)
サマリ
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.
説明
FieldMappings オブジェクトは FieldMap オブジェクトのコレクションで、[マージ（Merge）] などのフィールド マッピングを実行するツールのパラメータ値として使用されます。これらのオブジェクトを操作する最も簡単な方法は、まず FieldMappings オブジェクトを作成した後、結合対象の入力フィーチャクラスまたはテーブルを追加することにより、そのオブジェクトの FieldMap オブジェクトを初期化することです。すべての入力が指定された後、FieldMappings オブジェクトには、そのすべての入力の一意なフィールド名ごとに FieldMap オブジェクトまたは出力フィールドを 1 つずつ含まれます。このリストは、新しいフィールドを追加する、出力フィールドのプロジェクトまたは内容を変更する、必要のない出力フィールドを削除することにより、変更できます。
FieldMap オブジェクトのプロパティには、入力テキスト値の開始位置と終了位置が含まれるため、入力値の一部を使って新しい出力値を作成することができます。FieldMap オブジェクトに同じテーブルまたはフィーチャクラスからの複数入力フィールドが含まれる場合、各レコードの値は mergeRule プロパティを使用してマージされます。これは、たとえば「国道」と「1 号」のように、道路タイプが含まれているフィールドと道路名が含まれているフィールドの値を結合するのに役立ちます。FieldMap の joinDelimiter プロパティは、mergeRule の値として Join が指定されている場合に使用されます。スペースなど、任意の文字のセットを区切り文字として使用できます。前記の例では、「国道 1 号」という値が作成されます。
構文
特性
| プロパティ | 説明 | データ タイプ |
| fieldCount (読み取り専用) |
The number of output fields. | Integer |
| fieldMappings (読み書き) | A list of FieldMap objects that make up the FieldMappings object. | FieldMap |
| fieldValidationWorkspace (読み書き) |
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 (読み取り専用) |
A list of Field objects. Each field object represents the properties of each output field. | Field |
メソッドの概要
| メソッド | 説明 |
| 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) |
Gets a field map from the field mappings. |
| 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 field map from the field mappings. |
| replaceFieldMap (index, value) |
Replace a field map within the field mappings. |
メソッド
| パラメータ | 説明 | データ タイプ |
field_map |
The field map to add to the field mappings | FieldMap |
| パラメータ | 説明 | データ タイプ |
table_dataset |
The table to add to the field mappings object. | String |
| データ タイプ | 説明 |
| String |
The string representation of the object. |
| パラメータ | 説明 | データ タイプ |
field_map_name |
Find the field map by name. | String |
| データ タイプ | 説明 |
| Integer |
The index position of the field map. |
| パラメータ | 説明 | データ タイプ |
index |
The index position of the field map. | Integer |
| データ タイプ | 説明 |
| FieldMap |
The field map from the field mappings. |
| パラメータ | 説明 | データ タイプ |
string |
The string representation of the object. | String |
| パラメータ | 説明 | データ タイプ |
index |
The index position of the field map. | Integer |
| パラメータ | 説明 | データ タイプ |
index |
The index position of the field map to be replaced. | Integer |
value |
The replacement field map. | FieldMap |
コードのサンプル
FieldMap objects are often used when there is a need to merge similar datasets into one, all-encompassing dataset. In this example, the feature class Trees and the shapefile Plants.shp are merged into one feature class: Vegetation. Both original feature classes have two attributes: Type and Diameter. These two attributes must be maintained through the merge.
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)
This sample displays the option of using FieldMap objects to merge fields, using the FeatureClassToFeatureClass tool. In this example, a feature class contains information about the number of accidents per intersection in a city. Each year of data is maintained in one field. The user would like to find the average number of accidents in each intersection, without altering the existing table.
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)