com.yahoo.elide.core

Class Path

java.lang.Object

com.yahoo.elide.core.Path

public class Path
extends Object

Represents a path in the entity relationship graph.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Path.PathElement The path taken through data model associations to reference a given field.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Path.PathElement>	pathElements

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Path()
	Path(Class<?> entityClass, EntityDictionary dictionary, String dotSeparatedPath)
	Path(Class<?> entityClass, EntityDictionary dictionary, String fieldName, String alias, Set<Argument> arguments)
	Path(List<Path.PathElement> pathElements)
	Path(Path copy)
	Path(Type<?> entityClass, EntityDictionary dictionary, String dotSeparatedPath)
	Path(Type<?> entityClass, EntityDictionary dictionary, String fieldName, String alias, Set<Argument> arguments)

Method Summary

Modifier and Type	Method and Description
String	getAlias() Returns an alias that uniquely identifies the last collection of entities in the path.
String	getFieldPath()
Optional<Path.PathElement>	lastElement()
protected boolean	needNavigation(Type<?> entityClass, String fieldName, EntityDictionary dictionary) Check whether a field need navigation to another entity.
protected Path.PathElement	resolvePathAttribute(Type<?> entityClass, String fieldName, String alias, Set<Argument> arguments, EntityDictionary dictionary)
protected List<Path.PathElement>	resolvePathElements(Type<?> entityClass, EntityDictionary dictionary, String dotSeparatedPath) Resolve a dot separated path into list of path elements.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

pathElements

protected List<Path.PathElement> pathElements

Constructor Detail

Path

protected Path()

Path

public Path(Path copy)

Path

public Path(List<Path.PathElement> pathElements)

Path

public Path(Class<?> entityClass,
            EntityDictionary dictionary,
            String dotSeparatedPath)

Path

public Path(Type<?> entityClass,
            EntityDictionary dictionary,
            String dotSeparatedPath)

Path

public Path(Class<?> entityClass,
            EntityDictionary dictionary,
            String fieldName,
            String alias,
            Set<Argument> arguments)

Path

public Path(Type<?> entityClass,
            EntityDictionary dictionary,
            String fieldName,
            String alias,
            Set<Argument> arguments)

Method Detail

resolvePathElements

protected List<Path.PathElement> resolvePathElements(Type<?> entityClass,
                                                     EntityDictionary dictionary,
                                                     String dotSeparatedPath)

Resolve a dot separated path into list of path elements.

Parameters:

entityClass - root class e.g. "foo"

dictionary - dictionary

dotSeparatedPath - path e.g. "bar.baz"

Returns:

list of path elements e.g. ["foo.bar", "bar.baz"]

resolvePathAttribute

protected Path.PathElement resolvePathAttribute(Type<?> entityClass,
                                                String fieldName,
                                                String alias,
                                                Set<Argument> arguments,
                                                EntityDictionary dictionary)

needNavigation

protected boolean needNavigation(Type<?> entityClass,
                                 String fieldName,
                                 EntityDictionary dictionary)

Check whether a field need navigation to another entity.

Parameters:

entityClass - entity class

fieldName - field name

dictionary - dictionary

Returns:

True if the field requires navigation.

lastElement

public Optional<Path.PathElement> lastElement()

getFieldPath

public String getFieldPath()

getAlias

public String getAlias()

Returns an alias that uniquely identifies the last collection of entities in the path.

Returns:

An alias for the path.

toString

public String toString()

Overrides:

toString in class Object