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

public abstract Class AttributeAccessor

extends Object
implements CoreAttributeAccessor, Cloneable, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.lang.Cloneable, org.eclipse.persistence.core.mappings.CoreAttributeAccessor
Known Direct Subclasses
org.eclipse.persistence.internal.descriptors.InstanceVariableAttributeAccessor, org.eclipse.persistence.internal.descriptors.MethodAttributeAccessor, org.eclipse.persistence.internal.descriptors.MultitenantPrimaryKeyAccessor, org.eclipse.persistence.internal.dynamic.ValuesAccessor, org.eclipse.persistence.internal.sessions.factories.ObjectPersistenceRuntimeXMLProject_11_1_1.StoredProcedureArgumentsAccessor, org.eclipse.persistence.internal.sessions.factories.ObjectPersistenceRuntimeXMLProject_11_1_1.StoredFunctionResultAccessor, org.eclipse.persistence.internal.sessions.factories.ObjectPersistenceRuntimeXMLProject_11_1_1.IsSetNullPolicyIsSetParametersAttributeAccessor, org.eclipse.persistence.internal.sessions.factories.ObjectPersistenceRuntimeXMLProject_11_1_1.IsSetNullPolicyIsSetParameterTypesAttributeAccessor, org.eclipse.persistence.internal.sessions.factories.ObjectPersistenceRuntimeXMLProject_11_1_1.NullPolicyAttributeAccessor, org.eclipse.persistence.internal.oxm.accessor.OrmAttributeAccessor
Imports
java.io.*, org.eclipse.persistence.core.mappings.CoreAttributeAccessor, org.eclipse.persistence.exceptions.*, org.eclipse.persistence.internal.helper.ClassConstants

Purpose: This provides an abstract class for setting and retrieving the attribute value for the mapping from an object. It can be used in advanced situations if the attribute requires advanced conversion of the mapping value, or a real attribute does not exist.

Author
James
Since
OracleAS TopLink 10g (10.0.3)

Field Summary

Modifier and TypeField and Description
protected String
attributeName

Stores the name of the attribute

protected boolean
isReadOnly

protected boolean
isWriteOnly

Constructor Summary

AccessConstructor and Description
protected
AttributeAccessor()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides java.lang.Object.clone.

INTERNAL: Clones itself.
public Class<?>
getAttributeClass()

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.getAttributeClass.

Return the class type of the attribute.
public String
getAttributeName()

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.getAttributeName.

INTERNAL: Return the attribute name.
public abstract Object
getAttributeValueFromObject(Object object)

Redeclares org.eclipse.persistence.core.mappings.CoreAttributeAccessor.getAttributeValueFromObject.

Return the attribute value from the object.
public void
initializeAttributes(Class<?> descriptorClass)

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.initializeAttributes.

Allow any initialization to be performed with the descriptor class.
public boolean
isInitialized()

Returns true if this attribute accessor has been initialized and now stores a reference to the class's attribute.

public boolean
isInstanceVariableAttributeAccessor()

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.isInstanceVariableAttributeAccessor.

public boolean
isMapValueAttributeAccessor()

public boolean
isMethodAttributeAccessor()

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.isMethodAttributeAccessor.

public boolean
isReadOnly()

INTERNAL

public boolean
isValuesAccessor()

public boolean
isVirtualAttributeAccessor()

public boolean
isWriteOnly()

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.isWriteOnly.

INTERNAL:
public void
setAttributeName(String attributeName)

INTERNAL: Set the attribute name.

public abstract void
setAttributeValueInObject(Object object, Object value)

Redeclares org.eclipse.persistence.core.mappings.CoreAttributeAccessor.setAttributeValueInObject.

Set the attribute value into the object.
public void
setIsReadOnly(boolean aBoolean)

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.setIsReadOnly.

INTERNAL
public void
setIsWriteOnly(boolean aBoolean)

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.setIsWriteOnly.

INTERNAL:
Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

attributeNameback to summary
protected String attributeName

Stores the name of the attribute

isReadOnlyback to summary
protected boolean isReadOnly
isWriteOnlyback to summary
protected boolean isWriteOnly

Constructor Detail

AttributeAccessorback to summary
protected AttributeAccessor()

Default constructor.

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

INTERNAL: Clones itself.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
getAttributeClassback to summary
public Class<?> getAttributeClass()

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.getAttributeClass.

Return the class type of the attribute.

Annotations
@Override
getAttributeNameback to summary
public String getAttributeName()

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.getAttributeName.

INTERNAL: Return the attribute name.

Annotations
@Override
getAttributeValueFromObjectback to summary
public abstract Object getAttributeValueFromObject(Object object) throws DescriptorException

Redeclares org.eclipse.persistence.core.mappings.CoreAttributeAccessor.getAttributeValueFromObject.

Return the attribute value from the object.

Annotations
@Override
initializeAttributesback to summary
public void initializeAttributes(Class<?> descriptorClass) throws DescriptorException

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.initializeAttributes.

Allow any initialization to be performed with the descriptor class.

Annotations
@Override
isInitializedback to summary
public boolean isInitialized()

Returns true if this attribute accessor has been initialized and now stores a reference to the class's attribute. An attribute accessor can become uninitialized on serialization.

isInstanceVariableAttributeAccessorback to summary
public boolean isInstanceVariableAttributeAccessor()

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.isInstanceVariableAttributeAccessor.

Annotations
@Override
isMapValueAttributeAccessorback to summary
public boolean isMapValueAttributeAccessor()
isMethodAttributeAccessorback to summary
public boolean isMethodAttributeAccessor()

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.isMethodAttributeAccessor.

Annotations
@Override
isReadOnlyback to summary
public boolean isReadOnly()

INTERNAL

isValuesAccessorback to summary
public boolean isValuesAccessor()
isVirtualAttributeAccessorback to summary
public boolean isVirtualAttributeAccessor()
isWriteOnlyback to summary
public boolean isWriteOnly()

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.isWriteOnly.

INTERNAL:

Annotations
@Override
setAttributeNameback to summary
public void setAttributeName(String attributeName)

INTERNAL: Set the attribute name.

setAttributeValueInObjectback to summary
public abstract void setAttributeValueInObject(Object object, Object value) throws DescriptorException

Redeclares org.eclipse.persistence.core.mappings.CoreAttributeAccessor.setAttributeValueInObject.

Set the attribute value into the object.

Annotations
@Override
setIsReadOnlyback to summary
public void setIsReadOnly(boolean aBoolean)

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.setIsReadOnly.

INTERNAL

Annotations
@Override
setIsWriteOnlyback to summary
public void setIsWriteOnly(boolean aBoolean)

Implements org.eclipse.persistence.core.mappings.CoreAttributeAccessor.setIsWriteOnly.

INTERNAL:

Annotations
@Override