Path (OpenJPA Parent POM 4.0.0 API)

All Superinterfaces:

java.io.Serializable, Value

All Known Implementing Classes:

CandidatePath, PCPath
```
public interface Path
extends Value
```
A path represents a traversal into fields of a candidate object. Equivalent paths should compare equal.

Author:

Abe White

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`get(FieldMetaData field, boolean nullTraversal)`	Traverse into the given field of the current object, and update the current object to that field value.
`void`	`get(FieldMetaData fmd, XMLMetaData meta)`	Traverse into the given field that maps to xml column, and update the current object to that field value.
`void`	`get(XMLMetaData meta, java.lang.String name)`	Traverse into the gevin xpath name of the current object, and update the current object to that xpath field.
`java.lang.String`	`getCorrelationVar()`
`java.lang.String`	`getSchemaAlias()`
`XMLMetaData`	`getXmlMapping()`	Return the current XPath's xmlmapping metadata.
`FieldMetaData`	`last()`	Return the last field in the path, or null if the path does not not contain a final field.
`void`	`setSchemaAlias(java.lang.String schemaAlias)`	Set the schema alias (the identification variable) this path is begin with.
`void`	`setSubqueryContext(Context context, java.lang.String correlationVar)`

Methods inherited from interface org.apache.openjpa.kernel.exps.Value
acceptVisit, getAlias, getMetaData, getName, getPath, getSelectAs, getType, isAggregate, isVariable, isXPath, setAlias, setImplicitType, setMetaData

- Method Detail
  - get
```
void get(FieldMetaData field,
         boolean nullTraversal)
```
    Traverse into the given field of the current object, and update the current object to that field value.
    
    Parameters:
    
    nullTraversal - if true, allow traversal through a null field
  - last
```
FieldMetaData last()
```
    Return the last field in the path, or null if the path does not not contain a final field.
  - get
```
void get(FieldMetaData fmd,
         XMLMetaData meta)
```
    Traverse into the given field that maps to xml column, and update the current object to that field value.
    
    Parameters:
    
    fmd - field maps to xml column
    
    meta - associated xml mapping
  - get
```
void get(XMLMetaData meta,
         java.lang.String name)
```
    Traverse into the gevin xpath name of the current object, and update the current object to that xpath field.
  - getXmlMapping
```
XMLMetaData getXmlMapping()
```
    Return the current XPath's xmlmapping metadata.
    
    Returns:
    
    Return xmlmapping
  - setSchemaAlias
```
void setSchemaAlias(java.lang.String schemaAlias)
```
    Set the schema alias (the identification variable) this path is begin with.
  - getSchemaAlias
```
java.lang.String getSchemaAlias()
```
  - setSubqueryContext
```
void setSubqueryContext(Context context,
                        java.lang.String correlationVar)
```
  - getCorrelationVar
```
java.lang.String getCorrelationVar()
```