Top Description Fields Constructors Methods
org.eclipse.persistence.oxm.mappings

public Class BidirectionalPolicy

extends Object
Class Inheritance
Imports
org.eclipse.persistence.internal.descriptors.InstanceVariableAttributeAccessor, .MethodAttributeAccessor, org.eclipse.persistence.internal.queries.ContainerPolicy, org.eclipse.persistence.mappings.AttributeAccessor

Purpose: Provides a means to configure bidirectional relationship maintenance for OXM mappings. ant

Author
mmacivor

Field Summary

Modifier and TypeField and Description
private AttributeAccessor
bidirectionalTargetAccessor

private ContainerPolicy
bidirectionalTargetContainerPolicy

Constructor Summary

AccessConstructor and Description
public
BidirectionalPolicy()

Method Summary

Modifier and TypeMethod and Description
public AttributeAccessor
getBidirectionalTargetAccessor()

Gets the AttributeAccessor that is used to get and set the value of the container on the target object.

public String
getBidirectionalTargetAttributeName()

Gets the name of the backpointer attribute on the target object.

public ContainerPolicy
getBidirectionalTargetContainerPolicy()

public String
getBidirectionalTargetGetMethodName()

Gets the name of the method to be used when accessing the value of the back pointer on the target object of this mapping.

public String
getBidirectionalTargetSetMethodName()

Gets the name of the method to be used when setting the value of the back pointer on the target object of this mapping.

public void
setBidirectionalTargetAccessor(AttributeAccessor
- the accessor to be used.
anAttributeAccessor)

Sets the AttributeAccessor that is used to get and set the value of the container on the target object.

public void
setBidirectionalTargetAttributeName(String
- the name of the backpointer attribute to be populated
attributeName)

Sets the name of the backpointer attribute on the target object.

public void
setBidirectionalTargetContainerClass(Class<?> cls)

public void
setBidirectionalTargetContainerPolicy(ContainerPolicy cp)

public void
setBidirectionalTargetGetMethodName(String
- the getter method to be used.
methodName)

Sets the method name to be used when accessing the value of the back pointer on the target object of this mapping.

public void
setBidirectionalTargetSetMethodName(String
- the setter method to be used.
methodName)

Sets the name of the method to be used when setting the value of the back pointer on the target object of this mapping.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

bidirectionalTargetAccessorback to summary
private AttributeAccessor bidirectionalTargetAccessor
bidirectionalTargetContainerPolicyback to summary
private ContainerPolicy bidirectionalTargetContainerPolicy

Constructor Detail

BidirectionalPolicyback to summary
public BidirectionalPolicy()

Method Detail

getBidirectionalTargetAccessorback to summary
public AttributeAccessor getBidirectionalTargetAccessor()

Gets the AttributeAccessor that is used to get and set the value of the container on the target object.

getBidirectionalTargetAttributeNameback to summary
public String getBidirectionalTargetAttributeName()

Gets the name of the backpointer attribute on the target object. Used to populate the backpointer.

getBidirectionalTargetContainerPolicyback to summary
public ContainerPolicy getBidirectionalTargetContainerPolicy()
getBidirectionalTargetGetMethodNameback to summary
public String getBidirectionalTargetGetMethodName()

Gets the name of the method to be used when accessing the value of the back pointer on the target object of this mapping.

getBidirectionalTargetSetMethodNameback to summary
public String getBidirectionalTargetSetMethodName()

Gets the name of the method to be used when setting the value of the back pointer on the target object of this mapping.

setBidirectionalTargetAccessorback to summary
public void setBidirectionalTargetAccessor(AttributeAccessor anAttributeAccessor)

Sets the AttributeAccessor that is used to get and set the value of the container on the target object.

Parameters
anAttributeAccessor:AttributeAccessor

- the accessor to be used.

setBidirectionalTargetAttributeNameback to summary
public void setBidirectionalTargetAttributeName(String attributeName)

Sets the name of the backpointer attribute on the target object. Used to populate the backpointer. If the specified attribute doesn't exist on the reference class of this mapping, a DescriptorException will be thrown during initialize.

Parameters
attributeName:String

- the name of the backpointer attribute to be populated

setBidirectionalTargetContainerClassback to summary
public void setBidirectionalTargetContainerClass(Class<?> cls)
setBidirectionalTargetContainerPolicyback to summary
public void setBidirectionalTargetContainerPolicy(ContainerPolicy cp)
setBidirectionalTargetGetMethodNameback to summary
public void setBidirectionalTargetGetMethodName(String methodName)

Sets the method name to be used when accessing the value of the back pointer on the target object of this mapping. If the specified method doesn't exist on the reference class of this mapping, a DescriptorException will be thrown during initialize.

Parameters
methodName:String

- the getter method to be used.

setBidirectionalTargetSetMethodNameback to summary
public void setBidirectionalTargetSetMethodName(String methodName)

Sets the name of the method to be used when setting the value of the back pointer on the target object of this mapping. If the specified method doesn't exist on the reference class of this mapping, a DescriptorException will be thrown during initialize.

Parameters
methodName:String

- the setter method to be used.