## Uses of Interface
com.holonplatform.core.Path

- Packages that use Path
  Package | Description
  --- | ---
  com.holonplatform.core |
  com.holonplatform.core.beans |
  com.holonplatform.core.datastore |
  com.holonplatform.core.datastore.beans |
  com.holonplatform.core.datastore.operation.commons |
  com.holonplatform.core.datastore.relational |
  com.holonplatform.core.internal |
  com.holonplatform.core.property |
  com.holonplatform.core.query |

- - ### Uses of Path in com.holonplatform.core

    Subinterfaces of Path in com.holonplatform.core
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `Path.FinalPath<T>` Represents a final path, i.e. a path which do not support any parent path.
    `static interface` | `Path.FinalPath.FinalPathBuilder<T>` `Path.FinalPath` builder.
    `static interface` | `Path.PathBuilder<T>` Path builder.

    Methods in com.holonplatform.core that return types with arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `Optional<Path<?>>` | Path.`getParent()` Gets the parent path
    `default Optional<Path<?>>` | Path.FinalPath.`getParent()`
    `default Stream<Path<?>>` | Path.`stream()` Returns a `Stream` of path hierarchy, starting form this path and walking through parent paths, if any.

    Methods in com.holonplatform.core with parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `B` | Path.Builder.`parent(Path<?> parent)` Sets the parent path

    Method parameters in com.holonplatform.core with type arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `default String` | Path.`fullName(Function<Path<?>,String> nameMapper)` Gets the path full name, including any parent path, separated by a dot `.`
    `default String` | Path.`relativeName(Function<Path<?>,String> nameMapper)` Gets the relative path name, separated by a dot `.`

  - ### Uses of Path in com.holonplatform.core.beans

    Subinterfaces of Path in com.holonplatform.core.beans
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `BeanDataTarget<T>` A `DataTarget` which uses a bean class a path type.
    `interface` | `BeanProperty<T>` Represents a Java Bean property as a `PathProperty`, providing additional configuration informations and read/write methods.
    `static interface` | `BeanProperty.Builder<T>` BeanProperty builder.
    `interface` | `BooleanBeanProperty` A Boolean type `BeanProperty`, implementing `BooleanProperty`.
    `interface` | `NumericBeanProperty<N extends Number>` A numeric type `BeanProperty`, implementing `NumericProperty`.
    `interface` | `StringBeanProperty` A String type `BeanProperty`, implementing `StringProperty`.
    `interface` | `TemporalBeanProperty<T>` A temporal type `BeanProperty`, implementing `TemporalProperty`.

    Methods in com.holonplatform.core.beans with parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `static <T> BeanPropertySet<T>` | BeanPropertySet.`create(Class<? extends T> beanClass, Path<?> parentPath)` Deprecated. The root bean property path will always be a `Path.FinalPath` typed on bean class and with the bean class name as path name. Use `BeanPropertySet.create(Class)` instead.
    `<T> BeanPropertySet<T>` | BeanIntrospector.`getPropertySet(Class<? extends T> beanClass, Path<?> parentPath)` Deprecated. The root bean property path will always be a `Path.FinalPath` typed on bean class and with the bean class name as path name. Use `BeanIntrospector.getPropertySet(Class)` instead.
    `<V> V` | BeanPropertySet.`read(Path<V> path, T instance)` Read the value of the property bound to given `path` from given bean instance, using full path name to match the bean property to read.
    `<P> void` | BeanPropertySet.`write(Path<P> path, P value, T instance)` Write the `value` bound to given `path` to given bean instance, using full path name to match the bean property to write.

  - ### Uses of Path in com.holonplatform.core.datastore

    Subinterfaces of Path in com.holonplatform.core.datastore
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `DataTarget<T>` Representation of the target element of a data model persistence/query operation.

    Methods in com.holonplatform.core.datastore that return types with arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `Map<Path<?>,Object>` | Datastore.OperationResult.`getInsertedKeys()` For `Datastore.OperationType.INSERT` operations, returns the inserted key values, if the concrete `Datastore` implementation supports this feature.

    Methods in com.holonplatform.core.datastore with parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `<T> Optional<T>` | Datastore.OperationResult.`getInsertedKey(Path<T> path)` For `Datastore.OperationType.INSERT` operations, returns the inserted key value which correspond to given `path` name, if available.
    `Datastore.OperationResult.Builder` | Datastore.OperationResult.Builder.`withInsertedKey(Path<?> key, Object value)` Add an inserted key

  - ### Uses of Path in com.holonplatform.core.datastore.beans

    Methods in com.holonplatform.core.datastore.beans with parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `default <T> O` | BeanBulkUpdateOperation.`set(Path<T> path, T value)` Set given `path` to given constant value.
    `<T> O` | BeanBulkUpdateOperation.`set(Path<T> path, TypedExpression<? super T> expression)` Set given `path` to given `expression` value.
    `default <P> O` | BeanBulkUpdateOperation.`setNull(Path<P> path)` Set the given `Path` to `null` value.

  - ### Uses of Path in com.holonplatform.core.datastore.operation.commons

    Methods in com.holonplatform.core.datastore.operation.commons that return types with arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `Map<Path<?>,TypedExpression<?>>` | PropertyBoxOperationConfiguration.`getValueExpressions(boolean includeNullValues)` Get the `PropertyBox` value as a `Path` - `TypedExpression` map.
    `Map<Path<?>,TypedExpression<?>>` | BulkUpdateOperationConfiguration.`getValues()` Get the operation values, expressed as a `Path` - `TypedExpression` map.

    Methods in com.holonplatform.core.datastore.operation.commons with parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `O` | BulkInsertOperation.`operationPaths(Path<?>[] paths)` Deprecated. Use `BulkInsertOperation.propertySet(Iterable)`
    `default <T> O` | BulkUpdateOperation.`set(Path<T> path, T value)` Set given `path` to given constant value.
    `<T> O` | BulkUpdateOperation.`set(Path<T> path, TypedExpression<? super T> expression)` Set given `path` to given `expression` value.
    `default <P> O` | BulkUpdateOperation.`setNull(Path<P> path)` Set the given `Path` to `null` value.

    Method parameters in com.holonplatform.core.datastore.operation.commons with type arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `O` | BulkInsertOperation.`add(Map<Path<?>,Object> values)` Deprecated. Use `BulkInsertOperation.add(Iterable)`

  - ### Uses of Path in com.holonplatform.core.datastore.relational

    Subinterfaces of Path in com.holonplatform.core.datastore.relational
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `Aliasable.AliasablePath<T,C extends Aliasable.AliasablePath<T,C>>` Represents an `Aliasable` `Path`.
    `interface` | `Join<T>` Represents a relational join expression between two `DataTarget`s.
    `interface` | `RelationalTarget<T>` A `DataTarget` which can be use with relational `Datastore`s.

  - ### Uses of Path in com.holonplatform.core.internal

    Classes in com.holonplatform.core.internal that implement Path
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DefaultFinalPath<T>` Default `FinalPath` implementation.
    `class` | `DefaultPath<T>` Default `Path` implementation.

    Methods in com.holonplatform.core.internal that return types with arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `Optional<Path<?>>` | DefaultPath.`getParent()`

    Methods in com.holonplatform.core.internal with parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `Path.PathBuilder<T>` | DefaultFinalPath.`parent(Path<?> parent)`
    `Path.PathBuilder<T>` | DefaultPath.`parent(Path<?> parent)`

  - ### Uses of Path in com.holonplatform.core.property

    Classes in com.holonplatform.core.property with type parameters of type Path
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `CloneableProperty.CloneablePathProperty<T,P extends Property<T> & Path<T>>` A `Path` type `CloneableProperty`.
    `static interface` | `PathProperty.Builder<T,P extends Path<T> & Property<T>,B extends PathProperty.Builder<T,P,B>>` Base interface for `Path` and `Property` builders.

    Subinterfaces of Path in com.holonplatform.core.property
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `BooleanProperty` A boolean type `PathProperty`.
    `static interface` | `BooleanProperty.BooleanPropertyBuilder` `BooleanProperty` builder.
    `static interface` | `CloneableProperty.CloneablePathProperty<T,P extends Property<T> & Path<T>>` A `Path` type `CloneableProperty`.
    `interface` | `CollectionPathProperty<E,C extends Collection<E>>` A `CollectionProperty` type `PathProperty`.
    `interface` | `ListPathProperty<T>` A `CollectionPathProperty` which uses a `List` as concrete collection type.
    `static interface` | `ListPathProperty.ListPathPropertyBuilder<T>` `ListPathProperty` builder.
    `interface` | `NumericProperty<N extends Number>` A numeric type `PathProperty`.
    `static interface` | `NumericProperty.NumericPropertyBuilder<N extends Number>` `NumericProperty` builder.
    `interface` | `PathProperty<T>` A `Property` bound to a `Path`, using `getName()` as property name.
    `static interface` | `PathProperty.PathPropertyBuilder<T>` `PathProperty` builder.
    `interface` | `PropertyBoxProperty` A `PropertyBox` type `PathProperty`.
    `static interface` | `PropertyBoxProperty.PropertyBoxPropertyBuilder` `PropertyBoxProperty` builder.
    `interface` | `SetPathProperty<T>` A `CollectionPathProperty` which uses a `Set` as concrete collection type.
    `static interface` | `SetPathProperty.SetPathPropertyBuilder<T>` `SetPathProperty` builder.
    `interface` | `StringProperty` A String type `PathProperty`.
    `static interface` | `StringProperty.StringPropertyBuilder` `StringProperty` builder.
    `interface` | `TemporalProperty<T>` A temporal type `PathProperty`.
    `static interface` | `TemporalProperty.TemporalPropertyBuilder<T>` `TemporalProperty` builder.

    Methods in com.holonplatform.core.property that return Path
    Modifier and Type | Method and Description
    --- | ---
    `Path<T>` | PathPropertySetAdapter.PropertyPath.`getPath()` Get the path bound the property definition.

    Methods in com.holonplatform.core.property that return types with arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `<T> Optional<Path<T>>` | PathPropertySetAdapter.PathConverter.`convert(Property<T> property)` Get the `Path` representation of given `Property`, if the property can be represented by a path.
    `<T> Optional<Path<T>>` | PathPropertySetAdapter.`getPath(Property<T> property)` Check if given `property` is available in property set and if it can be represented as a `Path`.
    `Set<Path<?>>` | PathPropertySetAdapter.`getPathIdentifiers()` If the property set declares a set of identifiers, and each identifier property can be represented as a `Path`, returns the set of identifiers represented as paths.
    `Stream<Path<?>>` | PathPropertySetAdapter.`paths()` Returns a stream of `Path`s, containing the `Path` representation of all the properties in the property set which can be represented as a `Path`.

    Methods in com.holonplatform.core.property with parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | PathPropertySetAdapter.`contains(Path<?> path)` Return `true` if a property which corresponds to given path is available in the property set.
    `<T> boolean` | PathPropertyBoxAdapter.`containsValue(Path<T> path)` Check if the `PropertyBox` contains a `Property` which corresponds to given `path` with a not `null` value.
    `static BooleanProperty.BooleanPropertyBuilder` | BooleanProperty.`create(Path<Boolean> path)` Create a new `BooleanProperty` from given `path`, using given `Path` `name`.
    `static StringProperty.StringPropertyBuilder` | StringProperty.`create(Path<String> path)` Create a new `StringProperty` from given `path`, using given `Path` `name`.
    `static <T> PathProperty.PathPropertyBuilder<T>` | PathProperty.`create(Path<T> path)` Create a new `PathProperty` from given `path`, using given `Path` `name` and `type`.
    `static <T> TemporalProperty.TemporalPropertyBuilder<T>` | TemporalProperty.`create(Path<T> path)` Create a new `TemporalProperty` from given `path`, using given `Path` `name`and `type`.
    `static <T extends Number> NumericProperty.NumericPropertyBuilder<T>` | NumericProperty.`create(Path<T> path)` Create a new `NumericProperty` from given `path`, using given `Path` `name`and `type`.
    `<T> Optional<Property<T>>` | PathPropertySetAdapter.`getProperty(Path<T> path)` Check if a `Property` which corresponds to given `path` is present in the property set.
    `<T> Optional<T>` | PathPropertyBoxAdapter.`getValue(Path<T> path)` Get the value of the `PropertyBox` property which corresponds to given `path`, if the the property is present and its value is not `null`.
    `<T> Optional<T>` | PathPropertyBoxAdapter.`getValueOrElse(Path<T> path, Consumer<Path<T>> valueNotPresent)` Get the value of the `PropertyBox` property which corresponds to given `path`, if the the property is present and its value is not `null`.
    `boolean` | PathPropertySetAdapter.PathMatcher.`match(Path<?> path, Path<?> otherPath)` Checks whether the given paths match, i.e. they are to be considered equal.
    `boolean` | PathPropertySetAdapter.PathMatcher.`match(Path<?> path, Path<?> otherPath)` Checks whether the given paths match, i.e. they are to be considered equal.
    `<T> Optional<Property<T>>` | PathPropertyBoxAdapter.`setValue(Path<T> path, T value)` Set the value of the `PropertyBox` property which corresponds to given `path`, if such property is available.

    Method parameters in com.holonplatform.core.property with type arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `<T> Optional<T>` | PathPropertyBoxAdapter.`getValueOrElse(Path<T> path, Consumer<Path<T>> valueNotPresent)` Get the value of the `PropertyBox` property which corresponds to given `path`, if the the property is present and its value is not `null`.

  - ### Uses of Path in com.holonplatform.core.query

    Subinterfaces of Path in com.holonplatform.core.query
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `PathExpression<T>` A `QueryExpression` wich represents a `Path`.

    Methods in com.holonplatform.core.query that return Path
    Modifier and Type | Method and Description
    --- | ---
    `Path<?>[]` | QueryAggregation.`getAggregationPaths()` Get the paths for wich to aggregate the query results.
    `Path<T>` | QuerySort.PathQuerySort.`getPath()` Get the `Path` on which the sort is declared.

    Methods in com.holonplatform.core.query with parameters of type Path
    Modifier and Type | Method and Description
    --- | ---
    `default C` | QueryAggregation.QueryAggregationSupport.`aggregate(Path<?>... paths)` Aggregate results on given paths.
    `static <T> QuerySort` | QuerySort.`asc(Path<T> path)` Create a QuerySort on given `path` using `QuerySort.SortDirection.ASCENDING` sort direction.
    `static <T> QueryProjection<T>` | QueryProjection.`bean(Class<? extends T> beanClass, Path<?>... selection)` Create a `QueryProjection` using given bean class.
    `static QueryAggregation` | QueryAggregation.`create(Path<?>... paths)` Create a `QueryAggregation` using given aggregation paths
    `static <T> QuerySort` | QuerySort.`desc(Path<T> path)` Create a QuerySort on given `path` using `QuerySort.SortDirection.DESCENDING` sort direction.
    `static <T> PathExpression<T>` | PathExpression.`from(Path<T> path)` Create a `PathExpression` from given `Path`.
    `static <T> BeanProjection<T>` | BeanProjection.`of(Class<? extends T> beanClass, Path... selection)` Create a `BeanProjection` using given bean class.
    `static <T> QuerySort` | QuerySort.`of(Path<T> path, boolean ascending)` Create a QuerySort on given `path` using given sort direction
    `static <T> QuerySort` | QuerySort.`of(Path<T> path, QuerySort.SortDirection direction)` Create a QuerySort on given `path` using given sort direction
    `QueryAggregation.Builder` | QueryAggregation.Builder.`path(Path<?> path)` Add a query aggregation path.
    `static <T> QueryProjection<T>` | QueryProjection.`path(Path<T> path)` Create a `QueryProjection` for a `Path` expression.

    Method parameters in com.holonplatform.core.query with type arguments of type Path
    Modifier and Type | Method and Description
    --- | ---
    `default C` | QueryAggregation.QueryAggregationSupport.`aggregate(List<Path> paths)` Aggregate results on given paths.
    `static QueryAggregation` | QueryAggregation.`create(List<Path> paths)` Create a `QueryAggregation` using given aggregation paths

Copyright © 2019 The Holon Platform. All rights reserved.