Class BaseToOneProperty

java.lang.Object

org.apache.cayenne.reflect.BaseProperty

org.apache.cayenne.reflect.BaseArcProperty

org.apache.cayenne.reflect.BaseToOneProperty

All Implemented Interfaces:

ArcProperty, PropertyDescriptor, ToOneProperty

public abstract class BaseToOneProperty
extends BaseArcProperty
implements ToOneProperty

A convenience base superclass for ToOneProperty implementors.

Since:

3.0

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
BaseToOneProperty(ClassDescriptor owner, ClassDescriptor targetDescriptor, Accessor accessor, String reverseName)

Method Summary

Modifier and Type	Method	Description
void	setTarget(Object source, Object target, boolean setReverse)
boolean	visit(PropertyVisitor visitor)	A visitor accept method.

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, injectValueHolder, readProperty, readPropertyDirectly, toString, writeProperty, writePropertyDirectly

Modifier and Type	Method	Description
String	getName()	Returns property name.
void	injectValueHolder(Object object)	Does nothing.
Object	readProperty(Object object)	Returns a property value, inflating unresolved object if need.
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.
void	writePropertyDirectly(Object object, Object oldValue, Object newValue)	Sets a property value of an object without disturbing the object fault status.

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

BaseToOneProperty

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

Method Details

setTarget

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

Specified by:

setTarget in interface ToOneProperty

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.