FieldMap

Resumen

The FieldMap object provides a field definition and a list of input fields taken from a set of tables or feature classes.

Debate

El objeto FieldMappings es una colección de objetos FieldMap y se utiliza como valor de parámetro para las herramientas que realizan la asignación de campos, tales como Merge. La manera más fácil de trabajar con estos objetos es crear primero un objeto FieldMappings y, a continuación, inicializar sus objetos FieldMap agregando las clases de entidad o las tablas de entrada que se vayan a combinar. Una vez proporcionadas todas las entradas, el objeto FieldMappings contendrá un objeto FieldMap, o campo de salida, para cada nombre de campo único de todas las entradas. Esta lista se puede modificar agregando nuevos campos, modificando las propiedades o los contenidos de un campo de salida, o quitando los campos de salida no deseados.

Las propiedades del objeto FieldMap incluyen la posición de inicio y final de un valor de texto de entrada, de modo que se pueda crear un nuevo valor de salida utilizando una sección de un valor de entrada. Si un objeto FieldMap contiene varios campos de entrada de la misma tabla o clase de entidad, los valores de cada registro se combinan utilizando la propiedad mergeRule. Ésta es una manera conveniente de unir valores, tales como un nombre de calle contenido en un campo y un tipo de calle contenido en otro, por ejemplo, Eureka y Street. La propiedad joinDelimiter de FieldMap si se utiliza si se especifica el valor de mergeRule Join. Cualquier conjunto de caracteres, tal como un espacio, se puede utilizar como delimitador. En el ejemplo anterior, esto crearía el valor Eureka Street.

Sintaxis

FieldMap ()

Propiedades

Propiedad	Explicación	Tipo de datos
inputFieldCount (Sólo lectura)	Get the count of subfields.	Integer
joinDelimiter (Lectura y escritura)	Join delimiter for the subfields.	String
mergeRule (Lectura y escritura)	Merge rule for the subfields.	String
outputField (Lectura y escritura)	Get the properties field.	Field

Vista general del método

Método	Explicación
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étodos

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

Parámetro	Explicación	Tipo de datos
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. (El valor predeterminado es -1)	Integer
end_position	The end position of an input text value. (El valor predeterminado es -1)	Integer

findInputFieldIndex (table_dataset, field_name)

Parámetro	Explicación	Tipo de datos
table_dataset	The table added to the field map.	String
field_name	The field name.	String

Valor de retorno

Tipo de datos	Explicación
Integer	The index position of the field name.

getEndTextPosition (index)

Parámetro	Explicación	Tipo de datos
index	The index position.	Integer

Valor de retorno

Tipo de datos	Explicación
Integer	The end text position.

getInputFieldName (index)

Parámetro	Explicación	Tipo de datos
index	The index position.	Integer

Valor de retorno

Tipo de datos	Explicación
String	The input field name.

getInputTableName (index)

Parámetro	Explicación	Tipo de datos
index	The index position.	Integer

Valor de retorno

Tipo de datos	Explicación
String	The input table name.

getStartTextPosition (index)

Parámetro	Explicación	Tipo de datos
index	The index position.	Integer

Valor de retorno

Tipo de datos	Explicación
Integer	The start text position.

removeAll ()

removeInputField (index)

Parámetro	Explicación	Tipo de datos
index	The index position.	Integer

setEndTextPosition (index, end_position)

Parámetro	Explicación	Tipo de datos
index	The index position.	Integer
end_position	The end position of an input text value.	Integer

setStartTextPosition (index, start_position)

Parámetro	Explicación	Tipo de datos
index	The index position.	Integer
start_position	The start position of an input text value.	Integer

Ejemplo de código

FieldMap example

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)