MapRecord (nifi-record 1.14.0 API)

java.lang.Object
- org.apache.nifi.serialization.record.MapRecord

All Implemented Interfaces:: Record

public class MapRecord
extends Object
implements Record

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`checkTypes`
`private boolean`	`dropUnknownFields`
`private Set<RecordField>`	`inactiveFields`
`private RecordSchema`	`schema`
`private Optional<SerializedForm>`	`serializedForm`
`private Map<String,Object>`	`values`

Constructor Summary

Constructors
Constructor and Description
`MapRecord(RecordSchema schema, Map<String,Object> values)`
`MapRecord(RecordSchema schema, Map<String,Object> values, boolean checkTypes, boolean dropUnknownFields)`
`MapRecord(RecordSchema schema, Map<String,Object> values, SerializedForm serializedForm)`
`MapRecord(RecordSchema schema, Map<String,Object> values, SerializedForm serializedForm, boolean checkTypes, boolean dropUnknownFields)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private Map<String,Object>`	`checkTypes(Map<String,Object> values, RecordSchema schema)`
`private String`	`convertToString(Object value, String format)`
`boolean`	`equals(Object obj)`
`Object[]`	`getAsArray(String fieldName)`
`Boolean`	`getAsBoolean(String fieldName)`
`Date`	`getAsDate(String fieldName, String format)`
`Double`	`getAsDouble(String fieldName)`
`Float`	`getAsFloat(String fieldName)`
`Integer`	`getAsInt(String fieldName)`
`Long`	`getAsLong(String fieldName)`
`Record`	`getAsRecord(String fieldName, RecordSchema schema)`
`String`	`getAsString(RecordField field, String format)`
`String`	`getAsString(String fieldName)`
`String`	`getAsString(String fieldName, String format)`
`private Object`	`getExplicitValue(RecordField field)`
`private Object`	`getExplicitValue(RecordField field, Map<String,Object> values)`
`Set<String>`	`getRawFieldNames()` Returns a Set that contains the names of all of the fields that are present in the Record, regardless of whether or not those fields are contained in the schema.
`RecordSchema`	`getSchema()`
`Optional<SerializedForm>`	`getSerializedForm()`
`private RecordField`	`getUpdatedRecordField(RecordField field)`
`Object`	`getValue(RecordField field)`
`Object`	`getValue(String fieldName)`
`Object[]`	`getValues()` Returns a view of the the values of the fields in this Record.
`int`	`hashCode()`
`void`	`incorporateInactiveFields()` Updates the Record's schema to incorporate all of the fields that were added via the `Record.setValue(RecordField, Object)` method that did not exist in the schema.
`void`	`incorporateSchema(RecordSchema other)` Updates the Record's schema to to incorporate all of the fields in the given schema.
`boolean`	`isDropUnknownFields()` If `true`, any field that is added to the record will be drop unless the field is known by the schema
`private boolean`	`isSimpleType(RecordFieldType fieldType)`
`boolean`	`isTypeChecked()` Indicates whether or not field values for this record are expected to be coerced into the type designated by the schema.
`private Optional<RecordField>`	`resolveField(RecordField field)`
`void`	`setArrayValue(String fieldName, int arrayIndex, Object value)` Updates the value of a the specified index of a field.
`void`	`setMapValue(String fieldName, String mapKey, Object value)` Updates the value of a the specified key in a Map field.
`void`	`setValue(RecordField field, Object value)` Updates the value of the given field to the given value.
`void`	`setValue(String fieldName, Object value)` Updates the value of the field with the given name to the given value.
`private Optional<RecordField>`	`setValueAndGetField(String fieldName, Object value)`
`Map<String,Object>`	`toMap()` Converts the Record into a Map whose keys are the same as the Record's field names and the values are the field values
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - schema
```
private RecordSchema schema
```
  - values
```
private final Map<String,Object> values
```
  - serializedForm
```
private Optional<SerializedForm> serializedForm
```
  - checkTypes
```
private final boolean checkTypes
```
  - dropUnknownFields
```
private final boolean dropUnknownFields
```
  - inactiveFields
```
private Set<RecordField> inactiveFields
```
- Constructor Detail
  - MapRecord
```
public MapRecord(RecordSchema schema,
                 Map<String,Object> values)
```
  - MapRecord
```
public MapRecord(RecordSchema schema,
                 Map<String,Object> values,
                 boolean checkTypes,
                 boolean dropUnknownFields)
```
  - MapRecord
```
public MapRecord(RecordSchema schema,
                 Map<String,Object> values,
                 SerializedForm serializedForm)
```
  - MapRecord
```
public MapRecord(RecordSchema schema,
                 Map<String,Object> values,
                 SerializedForm serializedForm,
                 boolean checkTypes,
                 boolean dropUnknownFields)
```
- Method Detail
  - checkTypes
```
private Map<String,Object> checkTypes(Map<String,Object> values,
                                      RecordSchema schema)
```
  - isDropUnknownFields
```
public boolean isDropUnknownFields()
```
    Description copied from interface: Record
    
    If true, any field that is added to the record will be drop unless the field is known by the schema
    
    Specified by:
    
    isDropUnknownFields in interface Record
    
    Returns:
    
    true if fields that are unknown to the schema will be dropped, false if all field values are retained.
  - isTypeChecked
```
public boolean isTypeChecked()
```
    Description copied from interface: Record
    
    Indicates whether or not field values for this record are expected to be coerced into the type designated by the schema. If true, then it is safe to assume that calling Record.getValue(RecordField) will return an Object of the appropriate type according to the schema, or an object that can be coerced into the appropriate type. If type checking is not enabled, then calling Record.getValue(RecordField) can return an object of any type.
    
    Specified by:
    
    isTypeChecked in interface Record
    
    Returns:
    
    true if type checking is enabled, false otherwise.
  - getSchema
```
public RecordSchema getSchema()
```
    Specified by:
    
    getSchema in interface Record
  - getValues
```
public Object[] getValues()
```
    Description copied from interface: Record
    
    Returns a view of the the values of the fields in this Record. Note that this method returns values only for those entries in the Record's schema. This allows the Record to guarantee that it will return the values in the order dictated by the schema.
    NOTE: The array that is returned may be an underlying array that is backing the contents of the Record. As such, modifying the array in any way may result in modifying the record.
    
    Specified by:
    
    getValues in interface Record
    
    Returns:
    
    a view of the values of the fields in this Record
  - getValue
```
public Object getValue(String fieldName)
```
    Specified by:
    
    getValue in interface Record
  - getValue
```
public Object getValue(RecordField field)
```
    Specified by:
    
    getValue in interface Record
  - resolveField
```
private Optional<RecordField> resolveField(RecordField field)
```
  - getExplicitValue
```
private Object getExplicitValue(RecordField field)
```
  - getExplicitValue
```
private Object getExplicitValue(RecordField field,
                                Map<String,Object> values)
```
  - getAsString
```
public String getAsString(String fieldName)
```
    Specified by:
    
    getAsString in interface Record
  - getAsString
```
public String getAsString(String fieldName,
                          String format)
```
    Specified by:
    
    getAsString in interface Record
  - getAsString
```
public String getAsString(RecordField field,
                          String format)
```
    Specified by:
    
    getAsString in interface Record
  - convertToString
```
private String convertToString(Object value,
                               String format)
```
  - getAsLong
```
public Long getAsLong(String fieldName)
```
    Specified by:
    
    getAsLong in interface Record
  - getAsInt
```
public Integer getAsInt(String fieldName)
```
    Specified by:
    
    getAsInt in interface Record
  - getAsDouble
```
public Double getAsDouble(String fieldName)
```
    Specified by:
    
    getAsDouble in interface Record
  - getAsFloat
```
public Float getAsFloat(String fieldName)
```
    Specified by:
    
    getAsFloat in interface Record
  - getAsRecord
```
public Record getAsRecord(String fieldName,
                          RecordSchema schema)
```
    Specified by:
    
    getAsRecord in interface Record
  - getAsBoolean
```
public Boolean getAsBoolean(String fieldName)
```
    Specified by:
    
    getAsBoolean in interface Record
  - getAsDate
```
public Date getAsDate(String fieldName,
                      String format)
```
    Specified by:
    
    getAsDate in interface Record
  - getAsArray
```
public Object[] getAsArray(String fieldName)
```
    Specified by:
    
    getAsArray in interface Record
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getSerializedForm
```
public Optional<SerializedForm> getSerializedForm()
```
    Specified by:
    
    getSerializedForm in interface Record
  - toMap
```
public Map<String,Object> toMap()
```
    Description copied from interface: Record
    
    Converts the Record into a Map whose keys are the same as the Record's field names and the values are the field values
    
    Specified by:
    
    toMap in interface Record
    
    Returns:
    
    a Map that represents the values in the Record.
  - setValue
```
public void setValue(RecordField field,
                     Object value)
```
    Description copied from interface: Record
    
    Updates the value of the given field to the given value. If the field specified is not present in this Record's schema, this method will track of the field as an 'inactive field', which can then be added into the Record's schema via the Record.incorporateInactiveFields() method. This method should not be called after each invocation of Record.setValue(RecordField, Object) but rather should be called only once all updates to the Record have completed, in order to optimize performance. If this method changes any value in the Record, any SerializedForm that was provided will be removed (i.e., any subsequent call to Record.getSerializedForm()} will return an empty Optional).
    
    Specified by:
    
    setValue in interface Record
    
    Parameters:
    
    field - the field to update
    
    value - the value to set
  - setValue
```
public void setValue(String fieldName,
                     Object value)
```
    Description copied from interface: Record
    
    Updates the value of the field with the given name to the given value. If the field specified is not present in this Record's schema, this method will do nothing. If this method does change any value in the Record, any SerializedForm that was provided will be removed (i.e., any subsequent call to Record.getSerializedForm() will return an empty Optional).
    
    Specified by:
    
    setValue in interface Record
    
    Parameters:
    
    fieldName - the name of the field to update
    
    value - the new value to set
  - setValueAndGetField
```
private Optional<RecordField> setValueAndGetField(String fieldName,
                                                  Object value)
```
  - setArrayValue
```
public void setArrayValue(String fieldName,
                          int arrayIndex,
                          Object value)
```
    Description copied from interface: Record
    
    Updates the value of a the specified index of a field. If the field specified is not present in this Record's schema, this method will do nothing. If the field specified is not an Array, an IllegalArgumentException will be thrown. If the field specified is an array but the array has fewer elements than the specified index, this method will do nothing. If this method does change any value in the Record, any SerializedForm that was provided will be removed (i.e., any subsequent call to Record.getSerializedForm() will return an empty Optional).
    
    Specified by:
    
    setArrayValue in interface Record
    
    Parameters:
    
    fieldName - the name of the field to update
    
    arrayIndex - the 0-based index into the array that should be updated. If this value is larger than the number of elements in the array, or if the array is null, this method will do nothing.
    
    value - the new value to set
  - setMapValue
```
public void setMapValue(String fieldName,
                        String mapKey,
                        Object value)
```
    Description copied from interface: Record
    
    Updates the value of a the specified key in a Map field. If the field specified is not present in this Record's schema, this method will do nothing. If the field specified is not a Map field, an IllegalArgumentException will be thrown. If this method does change any value in the Record, any SerializedForm that was provided will be removed (i.e., any subsequent call to Record.getSerializedForm() will return an empty Optional).
    
    Specified by:
    
    setMapValue in interface Record
    
    Parameters:
    
    fieldName - the name of the field to update
    
    mapKey - the key in the map of the entry to update
    
    value - the new value to set
  - incorporateSchema
```
public void incorporateSchema(RecordSchema other)
```
    Description copied from interface: Record
    
    Updates the Record's schema to to incorporate all of the fields in the given schema. If both schemas have a field with the same name but a different type, then the existing schema will be updated to have a RecordFieldType.CHOICE field with both types as choices. If two fields have the same name but different default values, then the default value that is already in place will remain the default value, unless the current default value is null. Note that all values for this Record will still be valid according to this Record's Schema after this operation completes, as no type will be changed except to become more lenient. However, if incorporating the other schema does modify this schema, then the schema text returned by getSchemaText(), the schema format returned by getSchemaFormat(), and the SchemaIdentifier returned by getIdentifier() for this record's schema may all become Empty.
    
    Specified by:
    
    incorporateSchema in interface Record
    
    Parameters:
    
    other - the other schema to incorporate into this Record's schema
  - incorporateInactiveFields
```
public void incorporateInactiveFields()
```
    Description copied from interface: Record
    
    Updates the Record's schema to incorporate all of the fields that were added via the Record.setValue(RecordField, Object) method that did not exist in the schema.
    
    Specified by:
    
    incorporateInactiveFields in interface Record
  - getUpdatedRecordField
```
private RecordField getUpdatedRecordField(RecordField field)
```
  - isSimpleType
```
private boolean isSimpleType(RecordFieldType fieldType)
```
  - getRawFieldNames
```
public Set<String> getRawFieldNames()
```
    Description copied from interface: Record
    
    Returns a Set that contains the names of all of the fields that are present in the Record, regardless of whether or not those fields are contained in the schema. To determine which fields exist in the Schema, use Record.getSchema().getFieldNames() instead.
    
    Specified by:
    
    getRawFieldNames in interface Record
    
    Returns:
    
    a Set that contains the names of all of the fields that are present in the Record

Class MapRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

schema

values

serializedForm

checkTypes

dropUnknownFields

inactiveFields

Constructor Detail

MapRecord

MapRecord

MapRecord

MapRecord

Method Detail

checkTypes

isDropUnknownFields

isTypeChecked

getSchema

getValues

getValue

getValue

resolveField

getExplicitValue

getExplicitValue

getAsString

getAsString

getAsString

convertToString

getAsLong

getAsInt

getAsDouble

getAsFloat

getAsRecord

getAsBoolean

getAsDate

getAsArray

hashCode

equals

toString

getSerializedForm

toMap

setValue

setValue

setValueAndGetField

setArrayValue

setMapValue

incorporateSchema

incorporateInactiveFields

getUpdatedRecordField

isSimpleType

getRawFieldNames