# Uses of Interface
org.apache.cayenne.exp.path.CayennePath

Packages that use CayennePath
Package
Description
org.apache.cayenne
Contains persistence APIs directly accessible by users.
org.apache.cayenne.access
Contains classes that make up Cayenne ORM stack.
org.apache.cayenne.access.flush.operation
org.apache.cayenne.exp
Cayenne data expression classes.
org.apache.cayenne.exp.parser
Contains expression parser and other expression internals.
org.apache.cayenne.exp.path
org.apache.cayenne.exp.property
Property API
org.apache.cayenne.map
Contains O/R mapping classes that store relational database metadata information and map it to Java classes.
org.apache.cayenne.query
Defines standard queries supported by Cayenne and extension mechanism to create custom queries.
org.apache.cayenne.reflect

- ## Uses of CayennePath in org.apache.cayenne

  Methods in org.apache.cayenne with parameters of type CayennePath
  Modifier and Type
  Method
  Description
  `static Object`
  Cayenne.`readNestedProperty(Object o, CayennePath path)`
  Returns a value of the property identified by a property path.
  `Object`
  Persistent.`readNestedProperty(CayennePath path)`
  Returns a value of the property identified by a property path.
  `Object`
  PersistentObject.`readNestedProperty(CayennePath path)`

- ## Uses of CayennePath in org.apache.cayenne.access

  Fields in org.apache.cayenne.access with type parameters of type CayennePath
  Modifier and Type
  Field
  Description
  `protected Map<Object, Map<CayennePath, ObjectId>>`
  ObjectStore.`trackedFlattenedPaths`
  Map that tracks flattened paths for given object Id that is present in db.
  Methods in org.apache.cayenne.access that return types with arguments of type CayennePath
  Modifier and Type
  Method
  Description
  `Map<CayennePath, ObjectId>`
  ObjectStore.`getFlattenedPathIdMap(ObjectId objectId)`
  Methods in org.apache.cayenne.access with parameters of type CayennePath
  Modifier and Type
  Method
  Description
  `ObjectId`
  ObjectStore.`getFlattenedId(ObjectId objectId, CayennePath path)`
  `void`
  ObjectStore.`markFlattenedPath(ObjectId objectId, CayennePath path, ObjectId id)`
  Mark that flattened path for object has data row in DB.

- ## Uses of CayennePath in org.apache.cayenne.access.flush.operation

  Fields in org.apache.cayenne.access.flush.operation with type parameters of type CayennePath
  Modifier and Type
  Field
  Description
  `protected Map<CayennePath, ObjectId>`
  Values.`flattenedIds`
  Methods in org.apache.cayenne.access.flush.operation that return types with arguments of type CayennePath
  Modifier and Type
  Method
  Description
  `Map<CayennePath, ObjectId>`
  Values.`getFlattenedIds()`
  Methods in org.apache.cayenne.access.flush.operation with parameters of type CayennePath
  Modifier and Type
  Method
  Description
  `void`
  Values.`addFlattenedId(CayennePath path, ObjectId id)`

- ## Uses of CayennePath in org.apache.cayenne.exp

  Methods in org.apache.cayenne.exp with parameters of type CayennePath
  Modifier and Type
  Method
  Description
  `static Expression`
  ExpressionFactory.`dbIdPathExp(CayennePath pathSpec)`
  `static Expression`
  ExpressionFactory.`dbPathExp(CayennePath path)`
  `static Expression`
  ExpressionFactory.`pathExp(CayennePath path)`

- ## Uses of CayennePath in org.apache.cayenne.exp.parser

  Fields in org.apache.cayenne.exp.parser declared as CayennePath
  Modifier and Type
  Field
  Description
  `protected CayennePath`
  ASTPath.`path`
  Methods in org.apache.cayenne.exp.parser that return CayennePath
  Modifier and Type
  Method
  Description
  `CayennePath`
  ASTPath.`getPath()`
  Methods in org.apache.cayenne.exp.parser with parameters of type CayennePath
  Modifier and Type
  Method
  Description
  `protected Object`
  ASTDbIdPath.`evaluateNode(Object o, CayennePath localPath)`
  `protected void`
  ASTPath.`setPath(CayennePath path)`
  Constructors in org.apache.cayenne.exp.parser with parameters of type CayennePath
  Modifier
  Constructor
  Description
  ``
  `ASTDbIdPath(CayennePath value)`
  ``
  `ASTDbPath(CayennePath value)`
  ``
  `ASTObjPath(CayennePath path)`

- ## Uses of CayennePath in org.apache.cayenne.exp.path

  Fields in org.apache.cayenne.exp.path declared as CayennePath
  Modifier and Type
  Field
  Description
  `static final CayennePath`
  CayennePath.`EMPTY_PATH`
  Constant value for an empty path
  Methods in org.apache.cayenne.exp.path that return CayennePath
  Modifier and Type
  Method
  Description
  `default CayennePath`
  CayennePath.`dot(String next)`
  Create new path appending next segment to this.
  `default CayennePath`
  CayennePath.`dot(CayennePath next)`
  Create new path appending all segments of the next path to this.
  `default CayennePath`
  CayennePath.`dot(CayennePathSegment next)`
  Create new path appending next segment to this.
  `default CayennePath`
  CayennePath.`head(int end)`
  Create sub path from this path from the first element and ending at the given index.
  `static CayennePath`
  CayennePath.`of(String path)`
  Create path from a given String
  `static CayennePath`
  CayennePath.`of(String path, int marker)`
  Create path from a given String with a marker.
  `static CayennePath`
  CayennePath.`of(List<CayennePathSegment> segments)`
  Create path from a given list of `CayennePathSegment`
  `static CayennePath`
  CayennePath.`of(List<CayennePathSegment> segments, int marker)`
  Create path from a given list of `CayennePathSegment` and a marker
  `static CayennePath`
  CayennePath.`of(CayennePath path, int marker)`
  Clone given path with a different marker
  `default CayennePath`
  CayennePath.`parent()`
  Get the parent path, that is a path up to the last segment of this path.
  `default CayennePath`
  CayennePath.`tail(int start)`
  Create sub path from this path starting from the given index and to the end.
  `default CayennePath`
  CayennePath.`withMarker(int marker)`
  Clone this path with new marker
  Methods in org.apache.cayenne.exp.path with parameters of type CayennePath
  Modifier and Type
  Method
  Description
  `default CayennePath`
  CayennePath.`dot(CayennePath next)`
  Create new path appending all segments of the next path to this.
  `static CayennePath`
  CayennePath.`of(CayennePath path, int marker)`
  Clone given path with a different marker

- ## Uses of CayennePath in org.apache.cayenne.exp.property

  Fields in org.apache.cayenne.exp.property declared as CayennePath
  Modifier and Type
  Field
  Description
  `protected final CayennePath`
  BaseProperty.`path`
  Path of this property
  Methods in org.apache.cayenne.exp.property that return CayennePath
  Modifier and Type
  Method
  Description
  `CayennePath`
  BaseProperty.`getPath()`
  `CayennePath`
  Property.`getPath()`
  Methods in org.apache.cayenne.exp.property with parameters of type CayennePath
  Modifier and Type
  Method
  Description
  `static <T> BaseProperty<T>`
  PropertyFactory.`createBase(CayennePath path, Class<T> type)`
  Create base property
  `static <T> BaseProperty<T>`
  PropertyFactory.`createBase(CayennePath path, Expression expression, Class<T> type)`
  Create base property
  `static <T> BaseIdProperty<T>`
  PropertyFactory.`createBaseId(String attribute, CayennePath path, String entityName, Class<T> propertyType)`
  Create property that represents base ID
  `static <T> DateProperty<T>`
  PropertyFactory.`createDate(CayennePath path, Class<T> type)`
  Create date property
  `static <T> DateProperty<T>`
  PropertyFactory.`createDate(CayennePath path, Expression expression, Class<T> type)`
  Create date property
  `static <T extends EmbeddableObject>
  EmbeddableProperty<T>`
  PropertyFactory.`createEmbeddable(CayennePath path, Class<T> embeddableType)`
  Create property that represents embeddable
  `static <T extends EmbeddableObject>
  EmbeddableProperty<T>`
  PropertyFactory.`createEmbeddable(CayennePath path, Expression exp, Class<T> embeddableType)`
  Create property that represents embeddable
  `static <T extends Persistent>
  EntityProperty<T>`
  PropertyFactory.`createEntity(CayennePath path, Class<T> type)`
  Create entity property
  `static <T extends Persistent>
  EntityProperty<T>`
  PropertyFactory.`createEntity(CayennePath path, Expression expression, Class<T> entityType)`
  Create entity property
  `static <T extends Persistent>
  ListProperty<T>`
  PropertyFactory.`createList(CayennePath path, Class<T> entityType)`
  Create to-many relationship mapped on list property
  `static <T extends Persistent>
  ListProperty<T>`
  PropertyFactory.`createList(CayennePath path, Expression expression, Class<T> entityType)`
  Create to-many relationship mapped on list property
  `static <K, V extends Persistent>
  MapProperty<K,V>`
  PropertyFactory.`createMap(CayennePath path, Class<K> keyType, Class<V> entityType)`
  Create to-many relationship mapped on map property
  `static <K, V extends Persistent>
  MapProperty<K,V>`
  PropertyFactory.`createMap(CayennePath path, Expression expression, Class<K> keyType, Class<V> entityType)`
  Create to-many relationship mapped on map property
  `static <T extends Number>
  NumericProperty<T>`
  PropertyFactory.`createNumeric(CayennePath path, Expression expression, Class<T> type)`
  Create numeric property
  `static <T extends Number>
  NumericIdProperty<T>`
  PropertyFactory.`createNumericId(String attribute, CayennePath path, String entityName, Class<T> propertyType)`
  `static <T extends Persistent>
  SetProperty<T>`
  PropertyFactory.`createSet(CayennePath path, Class<T> entityType)`
  Create to-many relationship mapped on set property
  `static <T extends Persistent>
  SetProperty<T>`
  PropertyFactory.`createSet(CayennePath path, Expression expression, Class<T> entityType)`
  Create to-many relationship mapped on set property
  `static <T extends CharSequence>
  StringProperty<T>`
  PropertyFactory.`createString(CayennePath path, Class<T> type)`
  Create string property
  `static <T extends CharSequence>
  StringProperty<T>`
  PropertyFactory.`createString(CayennePath path, Expression expression, Class<T> type)`
  Create string property
  Constructors in org.apache.cayenne.exp.property with parameters of type CayennePath
  Modifier
  Constructor
  Description
  `protected`
  `BaseIdProperty(String attribute, CayennePath path, String entityName, Class<? super E> type)`
  Constructs a new property with the given name and expression
  `protected`
  `BaseProperty(CayennePath path, Expression expression, Class<? super E> type)`
  Constructs a new property with the given name and expression
  `protected`
  `CollectionProperty(CayennePath path, Expression expression, Class<? super E> collectionType, Class<V> entityType)`
  Constructs a new property with the given name and expression
  `protected`
  `DateProperty(CayennePath path, Expression expression, Class<E> type)`
  Constructs a new property with the given name and expression
  `protected`
  `EmbeddableProperty(CayennePath path, Expression exp, Class<? super E> type)`
  Constructs a new property with the given name and type
  `protected`
  `EntityProperty(CayennePath path, Expression expression, Class<E> type)`
  Constructs a new property with the given name and expression
  `protected`
  `ListProperty(CayennePath path, Expression expression, Class<V> entityType)`
  Constructs a new property with the given path and expression
  `protected`
  `MapProperty(CayennePath path, Expression expression, Class<K> keyType, Class<V> entityType)`
  Constructs a new property with the given path and expression
  `protected`
  `NumericIdProperty(String attribute, CayennePath path, String entityName, Class<E> type)`
  Constructs a new property with the given name and expression
  `protected`
  `NumericProperty(CayennePath path, Expression expression, Class<E> type)`
  Constructs a new property with the given name and expression
  `protected`
  `SelfProperty(CayennePath path, Expression expression, Class<E> type)`
  Constructs a new property with the given name and expression
  `protected`
  `SetProperty(CayennePath path, Expression expression, Class<V> entityType)`
  Constructs a new property with the given path and expression
  `protected`
  `StringProperty(CayennePath path, Expression expression, Class<E> type)`
  Constructs a new property with the given name and expression

- ## Uses of CayennePath in org.apache.cayenne.map

  Fields in org.apache.cayenne.map declared as CayennePath
  Modifier and Type
  Field
  Description
  `protected CayennePath`
  ObjAttribute.`dbAttributePath`
  Fields in org.apache.cayenne.map with type parameters of type CayennePath
  Modifier and Type
  Field
  Description
  `protected Map<String, CayennePath>`
  ObjEntity.`attributeOverrides`
  Methods in org.apache.cayenne.map that return CayennePath
  Modifier and Type
  Method
  Description
  `CayennePath`
  ObjAttribute.`getDbAttributePath()`
  Returns a dot-separated path that starts in the root DbEntity that maps to this attribute's ObjEntity and spans zero or more relationships, always ending in a DbAttribute name.
  `CayennePath`
  ObjRelationship.`getDbRelationshipPath()`
  Returns a dot-separated path over mapped DbRelationships.
  `CayennePath`
  ObjRelationship.`getReverseDbRelationshipPath()`
  Returns a reversed dbRelationship path.
  Methods in org.apache.cayenne.map that return types with arguments of type CayennePath
  Modifier and Type
  Method
  Description
  `Map<String, CayennePath>`
  ObjEntity.`getDeclaredAttributeOverrides()`
  Methods in org.apache.cayenne.map with parameters of type CayennePath
  Modifier and Type
  Method
  Description
  `void`
  ObjEntity.`addAttributeOverride(String attributeName, CayennePath dbPath)`
  `Iterator<CayenneMapEntry>`
  Entity.`resolvePathComponents(CayennePath path)`
  `void`
  ObjAttribute.`setDbAttributePath(CayennePath dbAttributePath)`
  `void`
  ObjRelationship.`setDbRelationshipPath(CayennePath relationshipPath)`
  Sets mapped DbRelationships as a dot-separated path.
  `Expression`
  DbEntity.`translateToRelatedEntity(Expression expression, CayennePath relationshipPath)`
  Transforms Expression rooted in this entity to an analogous expression rooted in related entity.
  `abstract Expression`
  Entity.`translateToRelatedEntity(Expression expression, CayennePath relationshipPath)`
  Transforms Expression rooted in this entity to an analogous expression rooted in related entity.
  `Expression`
  ObjEntity.`translateToRelatedEntity(Expression expression, CayennePath relationshipPath)`
  Transforms an Expression rooted in this entity to an analogous expression rooted in related entity.

- ## Uses of CayennePath in org.apache.cayenne.query

  Fields in org.apache.cayenne.query declared as CayennePath
  Modifier and Type
  Field
  Description
  `protected CayennePath`
  PrefetchSelectQuery.`prefetchPath`
  The relationship path from root objects to the objects being prefetched.
  Methods in org.apache.cayenne.query that return CayennePath
  Modifier and Type
  Method
  Description
  `CayennePath`
  PrefetchTreeNode.`getPath()`
  Returns full prefetch path, that is a dot separated String of node names starting from root and up to and including this node.
  `CayennePath`
  PrefetchTreeNode.`getPath(PrefetchTreeNode upTillParent)`
  Returns full prefetch path, that is a dot separated String of node names starting from root and up to and including this node.
  `CayennePath`
  PrefetchSelectQuery.`getPrefetchPath()`
  Returns the prefetchPath.
  Methods in org.apache.cayenne.query with parameters of type CayennePath
  Modifier and Type
  Method
  Description
  `PrefetchTreeNode`
  PrefetchTreeNode.`addPath(CayennePath path)`
  Adds a "path" with specified semantics to this prefetch node.
  `PrefetchTreeNode`
  PrefetchTreeNode.`getNode(CayennePath path)`
  Looks up an existing node in the tree described by the path.
  `void`
  PrefetchSelectQuery.`removeResultPath(CayennePath path)`
  Removes an extra result path.
  `void`
  PrefetchSelectQuery.`setPrefetchPath(CayennePath prefetchPath)`
  Sets the prefetchPath.
  `static PrefetchTreeNode`
  PrefetchTreeNode.`withPath(CayennePath path, int semantics)`
  Creates and returns a prefetch tree spanning a single path.
  Constructors in org.apache.cayenne.query with parameters of type CayennePath
  Modifier
  Constructor
  Description
  ``
  `PrefetchSelectQuery(CayennePath prefetchPath, ObjRelationship lastPrefetchHint)`
  Creates a new disjoint prefetch select query.

- ## Uses of CayennePath in org.apache.cayenne.reflect

  Fields in org.apache.cayenne.reflect declared as CayennePath
  Modifier and Type
  Field
  Description
  `protected CayennePath`
  BaseArcProperty.`reverseDbPath`
  Fields in org.apache.cayenne.reflect with type parameters of type CayennePath
  Modifier and Type
  Field
  Description
  `protected Map<CayennePath, AdditionalDbEntityDescriptor>`
  PersistentDescriptor.`additionalDbEntities`
  Methods in org.apache.cayenne.reflect that return CayennePath
  Modifier and Type
  Method
  Description
  `CayennePath`
  AdditionalDbEntityDescriptor.`getPath()`
  Methods in org.apache.cayenne.reflect that return types with arguments of type CayennePath
  Modifier and Type
  Method
  Description
  `Map<CayennePath, AdditionalDbEntityDescriptor>`
  ClassDescriptor.`getAdditionalDbEntities()`
  Returns information about additional db entities that is used for this ObjEntity (i.e. for flattened attributes).
  `Map<CayennePath, AdditionalDbEntityDescriptor>`
  LazyClassDescriptorDecorator.`getAdditionalDbEntities()`
  `Map<CayennePath, AdditionalDbEntityDescriptor>`
  PersistentDescriptor.`getAdditionalDbEntities()`
  Methods in org.apache.cayenne.reflect with parameters of type CayennePath
  Modifier and Type
  Method
  Description
  `static Accessor`
  PropertyUtils.`accessor(CayennePath nestedPropertyPath)`
  Compiles an accessor that can be used for fast access for the nested property of the objects of a given class.
  `static Object`
  PropertyUtils.`getProperty(Object object, CayennePath nestedProperty)`
  Returns object property using JavaBean-compatible introspection with one addition - a property can be a dot-separated property name path.