Class ListProperty<V extends Persistent>

java.lang.Object

org.apache.cayenne.exp.property.BaseProperty<List<V>>

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 CollectionProperty

entityType

Modifier and Type	Field	Description
protected Class<V>	entityType

Fields inherited from class BaseProperty

expressionSupplier, path, type

Modifier and Type	Field	Description
protected final Supplier<Expression>	expressionSupplier	Expression provider for the property
protected final CayennePath	path	Path of this property
protected final Class<List<V>>	type	Explicit type of the property

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ListProperty(CayennePath path, Expression expression, Class<V> entityType)	Constructs a new property with the given path and expression

Method Summary

Modifier and Type	Method	Description
ListProperty<V>	alias(String alias)	Creates alias with different name for this property
ListProperty<V>	enclosing()	This operator allows to access properties of the enclosing query from the subquery.
ListProperty<V>	outer()	Returns a version of this property that represents an OUTER join.

Methods inherited from class CollectionProperty

contains, contains, contains, containsId, containsId, containsId, containsIds, containsIdsCollection, containsValue, containsValues, containsValuesCollection, flat, getEntityType, notContains, notContains, notContains, notContainsId, notContainsId, notContainsId, notContainsIds, notContainsIdsCollection, notContainsValue, notContainsValues, notContainsValuesCollection

Modifier and Type	Method	Description
Expression	contains(Collection<V> values)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favour of CollectionProperty.containsValuesCollection(Collection)
Expression	contains(V value)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favour of CollectionProperty.containsValue(V)
Expression	contains(V firstValue, V... moreValues)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favour of CollectionProperty.containsValues(V...)
Expression	containsId(Object id)
Expression	containsId(Object firstId, Object... moreId)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favour of CollectionProperty.containsIds(Object...)
Expression	containsId(Collection<Object> ids)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favour of CollectionProperty.containsIdsCollection(Collection)
Expression	containsIds(Object... ids)
Expression	containsIdsCollection(Collection<?> ids)
Expression	containsValue(V value)
final Expression	containsValues(V... values)
Expression	containsValuesCollection(Collection<V> values)
EntityProperty<V>	flat()	Create new "flat" property for toMany relationship.
protected Class<V>	getEntityType()
Expression	notContains(Collection<V> values)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favour of CollectionProperty.notContainsValuesCollection(Collection)
Expression	notContains(V value)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favour of CollectionProperty.notContainsValue(V)
final Expression	notContains(V firstValue, V... moreValues)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favour of CollectionProperty.notContainsValues(V...)
Expression	notContainsId(Object id)
Expression	notContainsId(Object firstId, Object... moreId)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favour of CollectionProperty.notContainsIds(Object...)
Expression	notContainsId(Collection<Object> ids)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 in favour of CollectionProperty.notContainsIdsCollection(Collection)
Expression	notContainsIds(Object... ids)
Expression	notContainsIdsCollection(Collection<?> ids)
Expression	notContainsValue(V value)
final Expression	notContainsValues(V... values)
Expression	notContainsValuesCollection(Collection<V> values)

Methods inherited from class BaseProperty

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

Modifier and Type	Method	Description
<T> BaseProperty<T>	aggregate(String function, Class<T> type)
Ordering	asc()
Ordering	ascInsensitive()
Orderings	ascInsensitives()
Orderings	ascs()
NumericProperty<Long>	count()
NumericProperty<Long>	countDistinct()
Ordering	desc()
Ordering	descInsensitive()
Orderings	descInsensitives()
Orderings	descs()
Expression	eq(List<V> value)
Expression	eq(BaseProperty<?> value)
boolean	equals(Object o)
<T> BaseProperty<T>	function(String functionName, Class<T> returnType, Object... arguments)
<T> BaseProperty<T>	function(String functionName, Class<T> returnType, BaseProperty<?>... arguments)
String	getAlias()
Expression	getExpression()	This method returns fresh copy of the expression for each call.
List<V>	getFrom(Object bean)	Extracts property value from an object using JavaBean-compatible introspection with one addition - a property can be a dot-separated property name path.
List<List<V>>	getFromAll(Collection<?> beans)	Extracts property value from a collection of objects using JavaBean-compatible introspection with one addition - a property can be a dot-separated property name path.
String	getName()
CayennePath	getPath()
Class<List<V>>	getType()
int	hashCode()
Expression	in(List<V> firstValue, List<V>... moreValues)
Expression	in(Collection<List<V>> values)
Expression	in(ColumnSelect<? extends List<V>> subquery)
Expression	isFalse()
Expression	isNotNull()
Expression	isNull()
Expression	isTrue()
Expression	ne(List<V> value)
Expression	ne(BaseProperty<?> value)
Expression	nin(List<V> firstValue, List<V>... moreValues)
Expression	nin(Collection<List<V>> values)
Expression	nin(ColumnSelect<? extends List<V>> subquery)
<T> BaseProperty<T>	operator(String operator, Class<T> returnType, Object... arguments)
<T> BaseProperty<T>	operator(String operator, Class<T> returnType, BaseProperty<?>... arguments)
void	setIn(Object bean, List<V> value)	Sets a property value in 'obj' using JavaBean-compatible introspection with one addition - a property can be a dot-separated property name path.
void	setInAll(Collection<?> beans, List<V> value)	Sets a property value in a collection of objects using JavaBean-compatible introspection with one addition - a property can be a dot-separated property name path.

Methods inherited from class Object

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

Methods inherited from interface PathProperty

dot, dot, dot, dot, dot

Modifier and Type	Method	Description
default BaseProperty<Object>	dot(String property)	Constructs a property path by appending the argument to the existing property separated by a dot.
default <T> BaseProperty<T>	dot(BaseProperty<T> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.
default <T> DateProperty<T>	dot(DateProperty<T> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.
default <T extends Number> NumericProperty<T>	dot(NumericProperty<T> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.
default <T extends CharSequence> StringProperty<T>	dot(StringProperty<T> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.

Methods inherited from interface RelationshipProperty

disjoint, disjointById, dot, dot, dot, dot, dot, dot, dot, exists, joint, notExists

Modifier and Type	Method	Description
default PrefetchTreeNode	disjoint()	Returns a prefetch tree that follows this property path, potentially spanning a number of phantom nodes, and having a single leaf with "disjoint" prefetch semantics.
default PrefetchTreeNode	disjointById()	Returns a prefetch tree that follows this property path, potentially spanning a number of phantom nodes, and having a single leaf with "disjoint by id" prefetch semantics.
default <T> BaseIdProperty<T>	dot(BaseIdProperty<T> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.
default <T extends EmbeddableObject> EmbeddableProperty<T>	dot(EmbeddableProperty<T> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.
default <T extends Persistent> EntityProperty<T>	dot(EntityProperty<T> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.
default <T extends Persistent> ListProperty<T>	dot(ListProperty<T> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.
default <K, V extends Persistent> MapProperty<K,V>	dot(MapProperty<K,V> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.
default <T extends Number> NumericIdProperty<T>	dot(NumericIdProperty<T> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.
default <T extends Persistent> SetProperty<T>	dot(SetProperty<T> property)	Constructs a new property path by appending the argument to the existing property separated by a dot.
default Expression	exists()
default PrefetchTreeNode	joint()	Returns a prefetch tree that follows this property path, potentially spanning a number of phantom nodes, and having a single leaf with "joint" prefetch semantics.
default Expression	notExists()

Constructor Details

ListProperty

protected ListProperty(CayennePath path,
 Expression expression,
 Class<V> entityType)

Constructs a new property with the given path and expression

Parameters:

path - of the property (will be used as alias for the expression)

expression - expression for property

entityType - type of related entity

Method Details

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.

enclosing

public ListProperty<V> enclosing()

Description copied from class: BaseProperty

This operator allows to access properties of the enclosing query from the subquery. It allows multiple nesting levels to access a corresponding query in case of multiple levels of subqueries. Example:

ObjectSelect.query(Artist.class)
                .where(ExpressionFactory.notExists(ObjectSelect.query(Painting.class)
                        .where(Painting.TO_ARTIST.eq(Artist.ARTIST_ID_PK_PROPERTY.enclosing()))))

Overrides:

enclosing in class BaseProperty<List<V extends Persistent>>

Returns:

property that will be translated relative to parent query