FieldPath (Data Pipeline JavaDoc)

java.lang.Object
- com.northconcepts.datapipeline.core.FieldPath

All Implemented Interfaces:

JsonSerializable, RecordSerializable, XmlSerializable, JavaCodeGenerator
```
public class FieldPath
extends Object
implements RecordSerializable, XmlSerializable, JavaCodeGenerator
```
An abstract representation for the location of a field within a record. Instances can be created by parsing an expression with parse(String) or programmatically by adding name (name(String)) and index (index(int)) segments to an instance.
For example, the field path customer.address[0].city can be created in two ways:
1. FieldPath.parse("customer.address[0].city")
2. new FieldPath().name("customer").name("address").index(0).name("city")
Other examples of parsed field paths include:
- Single field names: firstName
- Nested field names: customer.firstName
- Array values: customer.address[2].city
- Positional field access: customer.address[2][0]
- Positional field access: [1]
- String arrays (for field names with spaces): customer.address[2]["zip code"]
- String arrays (using single quotes): customer.address[2]['zip code']
- Quoted field names (for field names with spaces or symbols): 'Company Flag (Y/N)'
- Quoted nested field names (for field names with spaces or symbols): customer."Company Flag (Y/N)"
- Quoted array values (for field names with spaces or symbols): `Company Address`[0]
Identifiers in field expressions may start with letters, underscores (_), at symbols (@), or dollar signs ($) and contain letters, numbers, underscores, at symbols, and dollar signs. You will need to quote field expressions that contain other symbols and spaces if they should be treated as part of the field name. For example, if your field name contains a period, you will need to quote it ("Package Lbs.").
Quoting:When quoting fields, you can use double quotes ("), single quotes ('), or grave accent (`).
A note of caution: FieldPath can also represent the location of values in array fields. For example, city[2] or customer.address[0].city[2] could match the third city in an array field. Some methods and operations expecting a field will throw an exception (or return false) if the supplied FieldPath matches an array value and not a field.
See Also:

parse(String), name(String), index(int), Record.getField(FieldPath), Record.getField(FieldPath, boolean, boolean), Record.getValue(FieldPath), Record.getValue(FieldPath, boolean), Record.getValue(FieldPath, boolean, boolean), Record.containsField(FieldPath), Record.contains(FieldPath)

Field Summary
- Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
  SERIALIZED_CLASS_NAME, TYPE
- Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
  XML_SERIALIZED_CLASS_NAME

Constructor Summary

Constructors
Constructor and Description

FieldPath()

Constructors
Constructor and Description
`FieldPath()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`contains(Record record)` Deprecated.
`boolean`	`containsField(Record record)`
`boolean`	`containsNonNullField(Record record)`
`boolean`	`containsNonNullValue(Record record)`
`boolean`	`containsValue(Record record)`
`boolean`	`equals(Object o)`
`FieldPath`	`fromJson(InputStream inputStream)`
`FieldPath`	`fromJson(String json)`
`static FieldPath`	`fromName(String fieldName)` Converts a single field name into a FieldPath.
`FieldPath`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`FieldPath`	`fromXml(InputStream inputStream)`
`FieldPath`	`fromXml(String xml)`
`FieldPath`	`fromXmlElement(Element element)`
`void`	`generateJavaCode(JavaCodeBuilder javaCodeBuilder)`
`Field`	`getField(Record record, boolean create, boolean throwException)`
`Node`	`getNode(Node rootNode, boolean create, boolean throwException)`
`String`	`getSimpleName()` Returns the name (or number/index) of the last segment in this path as a string.
`SingleValue`	`getSingleValue(Record record, boolean create, boolean throwException)`
`Object`	`getValue(ValueNode<?> recordOrArray, boolean create, boolean throwException)`
`ValueNode<?>`	`getValueNode(ValueNode<?> recordOrArray, boolean create, boolean throwException)`
`int`	`hashCode()`
`FieldPath`	`index(int index)`
`boolean`	`isTabular()` Indicates if this path matches against a flat record (i.e.
`FieldPath`	`name(String name)` Appends a new field name segment to this field path.
`static FieldPath`	`parse(String fieldPathExpression)` Converts a field path expression into a FieldPath object.
`static FieldPath`	`parse(String fieldPathExpression, boolean failOnEmpty)`
`ValueNode<?>`	`setValue(ValueNode<?> parentNode, boolean create, boolean throwException, Object value)`
`String`	`toExpression()`
`Record`	`toRecord()`
`String`	`toString()`
`Element`	`toXmlElement(Document document)`

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

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
fromArrayValue, fromArrayValue, fromArrayValue, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable
newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
forEachGrandChildElement, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

- Constructor Detail
  - FieldPath
```
public FieldPath()
```
- Method Detail
  - parse
```
public static FieldPath parse(String fieldPathExpression)
```
    Converts a field path expression into a FieldPath object. Expressions can be:
    - Single field names: firstName
    - Nested field names: customer.firstName
    - Array values: customer.address[2].city
    - Positional field access: customer.address[2][0]
    - Positional field access: [1]
    - String arrays (for field names with spaces): customer.address[2]["zip code"]
    - String arrays (using single quotes): customer.address[2]['zip code']
    - Quoted field names (for field names with spaces or symbols): 'Company Flag (Y/N)'
    - Quoted nested field names (for field names with spaces or symbols): customer."Company Flag (Y/N)"
    - Quoted array values (for field names with spaces or symbols): `Company Address`[0]
    Identifiers in field expressions may start with letters, underscores (_), at symbols (@), or dollar signs ($) and contain letters, numbers, underscores, at symbols, and dollar signs. You will need to quote field expressions that contain other symbols and spaces if they should be treated as part of the field name. For example, if your field name contains a period, you will need to quote it ("Package Lbs.").
    Quoting:When quoting fields, you can use double quotes ("), single quotes ('), or grave accent (`).
  - parse
```
public static FieldPath parse(String fieldPathExpression,
                              boolean failOnEmpty)
```
  - fromName
```
public static FieldPath fromName(String fieldName)
```
    Converts a single field name into a FieldPath. This method does no parsing and treats all characters as part of the field name.
  - name
```
public FieldPath name(String name)
```
    Appends a new field name segment to this field path.
  - index
```
public FieldPath index(int index)
```
  - isTabular
```
public boolean isTabular()
```
    Indicates if this path matches against a flat record (i.e. no nested records or array fields).
  - getField
```
public Field getField(Record record,
                      boolean create,
                      boolean throwException)
```
  - getSingleValue
```
public SingleValue getSingleValue(Record record,
                                  boolean create,
                                  boolean throwException)
```
  - getValueNode
```
public ValueNode<?> getValueNode(ValueNode<?> recordOrArray,
                                 boolean create,
                                 boolean throwException)
```
  - setValue
```
public ValueNode<?> setValue(ValueNode<?> parentNode,
                             boolean create,
                             boolean throwException,
                             Object value)
```
  - getValue
```
public Object getValue(ValueNode<?> recordOrArray,
                       boolean create,
                       boolean throwException)
```
  - getNode
```
public Node getNode(Node rootNode,
                    boolean create,
                    boolean throwException)
```
  - containsField
```
public boolean containsField(Record record)
```
  - containsNonNullField
```
public boolean containsNonNullField(Record record)
```
  - contains
```
@Deprecated
public boolean contains(Record record)
```
    Deprecated.
    
    Use containsValue(Record) instead.
  - containsValue
```
public boolean containsValue(Record record)
```
  - containsNonNullValue
```
public boolean containsNonNullValue(Record record)
```
  - getSimpleName
```
public String getSimpleName()
```
    Returns the name (or number/index) of the last segment in this path as a string.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toExpression
```
public String toExpression()
```
  - toRecord
```
public Record toRecord()
```
    Specified by:
    
    toRecord in interface RecordSerializable
  - fromRecord
```
public FieldPath fromRecord(Record source)
```
    Description copied from interface: RecordSerializable
    
    Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.
    
    Specified by:
    
    fromRecord in interface RecordSerializable
    
    Returns:
    
    this instance.
  - toXmlElement
```
public Element toXmlElement(Document document)
```
    Specified by:
    
    toXmlElement in interface XmlSerializable
  - fromXmlElement
```
public FieldPath fromXmlElement(Element element)
```
    Specified by:
    
    fromXmlElement in interface XmlSerializable
  - fromXml
```
public FieldPath fromXml(InputStream inputStream)
```
    Specified by:
    
    fromXml in interface XmlSerializable
  - fromXml
```
public FieldPath fromXml(String xml)
```
    Specified by:
    
    fromXml in interface XmlSerializable
  - fromJson
```
public FieldPath fromJson(InputStream inputStream)
```
    Specified by:
    
    fromJson in interface JsonSerializable
    
    Specified by:
    
    fromJson in interface RecordSerializable
  - fromJson
```
public FieldPath fromJson(String json)
```
    Specified by:
    
    fromJson in interface JsonSerializable
    
    Specified by:
    
    fromJson in interface RecordSerializable
  - generateJavaCode
```
public void generateJavaCode(JavaCodeBuilder javaCodeBuilder)
```
    Specified by:
    
    generateJavaCode in interface JavaCodeGenerator

Class FieldPath

Field Summary

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Constructor Detail

FieldPath

Method Detail

parse

parse

fromName

name

index

isTabular

getField

getSingleValue

getValueNode

setValue

getValue

getNode

containsField

containsNonNullField

contains

containsValue

containsNonNullValue

getSimpleName

hashCode

equals

toString

toExpression

toRecord

fromRecord

toXmlElement

fromXmlElement

fromXml

fromXml

fromJson

fromJson

generateJavaCode