Class BaseIdProperty<E>

java.lang.Object

org.apache.cayenne.exp.property.BaseProperty<E>

org.apache.cayenne.exp.property.BaseIdProperty<E>

All Implemented Interfaces:

IdProperty<E>, Property<E>

public class BaseIdProperty<E>
extends BaseProperty<E>
implements IdProperty<E>

Property that represents non-numeric PK

Since:

4.2

Field Summary

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<E>	type	Explicit type of the property

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getAttributeName()
String	getEntityName()

Methods inherited from class BaseProperty

aggregate, alias, asc, ascInsensitive, ascInsensitives, ascs, count, countDistinct, desc, descInsensitive, descInsensitives, descs, enclosing, 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)
BaseProperty<E>	alias(String alias)	Creates alias with different name for this property
Ordering	asc()
Ordering	ascInsensitive()
Orderings	ascInsensitives()
Orderings	ascs()
NumericProperty<Long>	count()
NumericProperty<Long>	countDistinct()
Ordering	desc()
Ordering	descInsensitive()
Orderings	descInsensitives()
Orderings	descs()
BaseProperty<E>	enclosing()	This operator allows to access properties of the enclosing query from the subquery.
Expression	eq(E 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.
E	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<E>	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<E>	getType()
int	hashCode()
Expression	in(E firstValue, E... moreValues)
Expression	in(Collection<E> values)
Expression	in(ColumnSelect<? extends E> subquery)
Expression	isFalse()
Expression	isNotNull()
Expression	isNull()
Expression	isTrue()
Expression	ne(E value)
Expression	ne(BaseProperty<?> value)
Expression	nin(E firstValue, E... moreValues)
Expression	nin(Collection<E> values)
Expression	nin(ColumnSelect<? extends E> 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, E 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, E 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 IdProperty

eq

Modifier and Type	Method	Description
default Expression	eq(ObjectId value)

Constructor Details

BaseIdProperty

protected BaseIdProperty(String attribute,
 CayennePath path,
 String entityName,
 Class<? super E> type)

Constructs a new property with the given name and expression

Parameters:

attribute - PK attribute name (optional, can be omitted for single PK entity)

path - cayenne path (optional, can be omitted for ID of the root)

entityName - name of the entity (mandatory)

type - of the property (mandatory)

See Also:

• PropertyFactory.createBaseId(String, CayennePath, String, Class)

Method Details

getEntityName

public String getEntityName()

Specified by:

getEntityName in interface IdProperty<E>

getAttributeName

public String getAttributeName()

Specified by:

getAttributeName in interface IdProperty<E>