org.apache.cayenne.exp.property

## Class ListProperty<V extends Persistent>

- java.lang.Object
- - org.apache.cayenne.exp.property.BaseProperty<E>
  - - org.apache.cayenne.exp.property.CollectionProperty<V,List<V>>
    - - org.apache.cayenne.exp.property.ListProperty<V>

- All Implemented Interfaces:
    PathProperty<List<V>>, Property<List<V>>, RelationshipProperty<List<V>>

      public class ListProperty<V extends Persistent>
      extends CollectionProperty<V,List<V>>

  Property that represents to-many relationship mapped on `List`.

       ObjectSelect.query(Artist.class)
            .where(Artist.PAINTING_ARRAY.contains(painting));

  Since:
    4.2
  See Also:
    `org.apache.cayenne.exp.property`

- - ### Field Summary

    - ### Fields inherited from class org.apache.cayenne.exp.property.CollectionProperty

      `entityType`

    - ### Fields inherited from class org.apache.cayenne.exp.property.BaseProperty

      `expressionSupplier, name, type`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `ListProperty(String name, Expression expression, Class<V> entityType)` Constructs a new property with the given name and expression

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `ListProperty<V>` | `alias(String alias)` Creates alias with different name for this property
    `ListProperty<V>` | `enclosing()`
    `ListProperty<V>` | `outer()` Returns a version of this property that represents an OUTER join.

    - ### Methods inherited from class org.apache.cayenne.exp.property.CollectionProperty

      `contains, contains, contains, containsId, containsId, containsId, flat, getEntityType, notContains, notContains, notContains, notContainsId, notContainsId, notContainsId`

    - ### Methods inherited from class org.apache.cayenne.exp.property.BaseProperty

      `asc, ascInsensitive, ascInsensitives, ascs, count, countDistinct, desc, descInsensitive, descInsensitives, descs, eq, eq, equals, function, function, getAlias, getExpression, getFrom, getFromAll, getName, getType, hashCode, in, in, in, isFalse, isNotNull, isNull, isTrue, ne, ne, nin, nin, nin, operator, operator, path, setIn, setInAll`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface org.apache.cayenne.exp.property.RelationshipProperty

      `disjoint, disjointById, dot, dot, dot, dot, dot, dot, dot, joint`

    - ### Methods inherited from interface org.apache.cayenne.exp.property.PathProperty

      `dot, dot, dot, dot, dot`

    - ### Methods inherited from interface org.apache.cayenne.exp.property.Property

      `getAlias, getExpression, getName, getType`

- - ### Constructor Detail

    - #### ListProperty

          protected ListProperty(String name,
                                 Expression expression,
                                 Class<V> entityType)

      Constructs a new property with the given name and expression
      Parameters:
        `name` - of the property (will be used as alias for the expression)
        `expression` - expression for property
        `entityType` - type of related entity

  - ### Method Detail

    - #### alias

          public ListProperty<V> alias(String alias)

      Creates alias with different name for this property
      Overrides:
        `alias` in class `BaseProperty<List<V extends Persistent>>`

    - #### outer

          public ListProperty<V> outer()

      Returns a version of this property that represents an OUTER join. It is up to caller to ensure that the property corresponds to a relationship, as "outer" attributes make no sense.

    - #### enclosing

          public ListProperty<V> enclosing()

      Overrides:
        `enclosing` in class `BaseProperty<List<V extends Persistent>>`
      Returns:
        property that will be translated relative to parent query

Copyright © 2001–2021 Apache Cayenne. All rights reserved.