FieldMappings
サマリ
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 オブジェクトのコレクションで、マージ などのフィールド マッピングを実行するツールのパラメータ値として使用されます。これらのオブジェクトを操作する最も簡単な方法は、まず FieldMappings オブジェクトを作成した後、結合対象の入力フィーチャクラスまたはテーブルを追加することにより、そのオブジェクトの FieldMap オブジェクトを初期化することです。すべての入力が指定された後、FieldMappings オブジェクトには、そのすべての入力の一意なフィールド名ごとに FieldMap オブジェクトまたは出力フィールドを 1 つずつ含まれます。このリストは、新しいフィールドを追加する、出力フィールドのプロジェクトまたは内容を変更する、必要のない出力フィールドを削除することにより、変更できます。
FieldMap オブジェクトのプロパティには、入力テキスト値の開始位置と終了位置が含まれるため、入力値の一部を使って新しい出力値を作成することができます。FieldMap オブジェクトに同じテーブルまたはフィーチャクラスからの複数入力フィールドが含まれる場合、各レコードの値は mergeRule プロパティを使用してマージされます。これは、たとえば「国道」と「1 号」のように、道路タイプが含まれているフィールドと道路名が含まれているフィールドの値を結合するのに役立ちます。FieldMap の joinDelimiter プロパティは、mergeRule の値として Join が指定されている場合に使用されます。スペースなど、任意の文字のセットを区切り文字として使用できます。前記の例では、「国道 1 号」という値が作成されます。
構文
プロパティ
プロパティ | 説明 | データ タイプ |
fieldCount (読み取り専用) |
The number of output fields. | Integer |
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 Python List that contains 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 |
コードのサンプル
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)