Class BaseToManyProperty

java.lang.Object

org.apache.cayenne.reflect.BaseProperty

org.apache.cayenne.reflect.BaseArcProperty

org.apache.cayenne.reflect.BaseToManyProperty

All Implemented Interfaces:

ArcProperty, PropertyDescriptor, ToManyProperty

public abstract class BaseToManyProperty
extends BaseArcProperty
implements ToManyProperty

A generic superclass of CollectionProperty implementations.

Since:

1.2

Field Summary

Fields inherited from class BaseArcProperty

complimentaryReverseArcName, relationship, reverseDbPath, targetDescriptor

Modifier and Type	Field	Description
protected String	complimentaryReverseArcName
protected ObjRelationship	relationship
protected CayennePath	reverseDbPath
protected ClassDescriptor	targetDescriptor

Fields inherited from class BaseProperty

accessor, owner

Modifier and Type	Field	Description
protected Accessor	accessor
protected ClassDescriptor	owner

Constructor Summary

Constructors

Constructor	Description
BaseToManyProperty(ClassDescriptor owner, ClassDescriptor targetDescriptor, Accessor accessor, String reverseName)

Method Summary

Modifier and Type	Method	Description
void	addTarget(Object source, Object target, boolean setReverse)
void	addTargetDirectly(Object source, Object target)	Adds value to collection, without triggering changing events This method is mostly for internal use
protected abstract ValueHolder	createCollectionValueHolder(Object object)	Creates a Collection for an object.
protected ValueHolder	ensureCollectionValueHolderSet(Object object)	Checks that an object's List field described by this property is set, injecting a List if needed.
void	injectValueHolder(Object object)	Injects a List in the object if it hasn't been done yet.
Object	readProperty(Object object)	Returns a property value, inflating unresolved object if need.
void	removeTarget(Object source, Object target, boolean setReverse)
void	removeTargetDirectly(Object source, Object target)	Removes value from collection, without triggering changing events This method is mostly for internal use
boolean	visit(PropertyVisitor visitor)	A visitor accept method.
void	writePropertyDirectly(Object object, Object oldValue, Object newValue)	Wraps list in a value holder that performs lazy faulting.

Methods inherited from class BaseArcProperty

getComplimentaryReverseArc, getComplimentaryReverseDbRelationshipPath, getRelationship, getTargetDescriptor, isFault, setReverse

Modifier and Type	Method	Description
ArcProperty	getComplimentaryReverseArc()	Returns a complimentary reverse ArcProperty or null if no reverse arc exists.
String	getComplimentaryReverseDbRelationshipPath()	Returns a path over reverse DbRelationships for this arc's ObjRelationship.
ObjRelationship	getRelationship()	Returns a relationship associated with this arc.
ClassDescriptor	getTargetDescriptor()	Returns a ClassDescriptor for the type of graph nodes pointed to by this arc property.
abstract boolean	isFault(Object source)	Returns whether a target node connected to a given object is an unresolved fault.
protected void	setReverse(Object source, Object oldTarget, Object newTarget)	A convenience method to set the reverse arc used by subclasses.

Methods inherited from class BaseProperty

getName, readPropertyDirectly, toString, writeProperty

Modifier and Type	Method	Description
String	getName()	Returns property name.
Object	readPropertyDirectly(Object object)	Returns a property value of an object without disturbing the object fault status.
String	toString()
void	writeProperty(Object object, Object oldValue, Object newValue)	Sets a property value, inflating unresolved object if need.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ArcProperty

invalidate

Modifier and Type	Method	Description
void	invalidate(Object object)	Turns a property of an object into a fault.

Methods inherited from interface PropertyDescriptor

equals

Modifier and Type	Method	Description
default boolean	equals(Object value1, Object value2)	Allows to use special logic to compare values for equality as in rare cases it is not sufficient to use the default equals() method.

Constructor Details

BaseToManyProperty

public BaseToManyProperty(ClassDescriptor owner,
 ClassDescriptor targetDescriptor,
 Accessor accessor,
 String reverseName)

Method Details

readProperty

public Object readProperty(Object object)
                    throws PropertyException

Description copied from interface: PropertyDescriptor

Returns a property value, inflating unresolved object if need.

Specified by:

readProperty in interface PropertyDescriptor

Overrides:

readProperty in class BaseProperty

Throws:

PropertyException

writePropertyDirectly

public void writePropertyDirectly(Object object,
 Object oldValue,
 Object newValue)
                           throws PropertyException

Wraps list in a value holder that performs lazy faulting.

Specified by:

writePropertyDirectly in interface PropertyDescriptor

Overrides:

writePropertyDirectly in class BaseProperty

Throws:

PropertyException

addTarget

public void addTarget(Object source,
 Object target,
 boolean setReverse)

Specified by:

addTarget in interface ToManyProperty

addTargetDirectly

public void addTargetDirectly(Object source,
 Object target)
                       throws PropertyException

Description copied from interface: ToManyProperty

Adds value to collection, without triggering changing events This method is mostly for internal use

Specified by:

addTargetDirectly in interface ToManyProperty

Throws:

PropertyException

removeTargetDirectly

public void removeTargetDirectly(Object source,
 Object target)
                          throws PropertyException

Description copied from interface: ToManyProperty

Removes value from collection, without triggering changing events This method is mostly for internal use

Specified by:

removeTargetDirectly in interface ToManyProperty

Throws:

PropertyException

removeTarget

public void removeTarget(Object source,
 Object target,
 boolean setReverse)

Specified by:

removeTarget in interface ToManyProperty

visit

public boolean visit(PropertyVisitor visitor)

Description copied from interface: PropertyDescriptor

A visitor accept method.

Specified by:

visit in interface PropertyDescriptor

Specified by:

visit in class BaseArcProperty

Returns:

a status returned by the corresponding callback method of the visitor. It serves as an indication of whether peer properties processing is still needed.

injectValueHolder

public void injectValueHolder(Object object)
                       throws PropertyException

Injects a List in the object if it hasn't been done yet.

Specified by:

injectValueHolder in interface PropertyDescriptor

Overrides:

injectValueHolder in class BaseProperty

Throws:

PropertyException

ensureCollectionValueHolderSet

protected ValueHolder ensureCollectionValueHolderSet(Object object)
                                              throws PropertyException

Checks that an object's List field described by this property is set, injecting a List if needed.

Throws:

PropertyException

createCollectionValueHolder

protected abstract ValueHolder createCollectionValueHolder(Object object)
                                                    throws PropertyException

Creates a Collection for an object.

Throws:

PropertyException