Package org.eclipse.persistence.mappings
Class AttributeAccessor
- java.lang.Object
-
- org.eclipse.persistence.mappings.AttributeAccessor
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,CoreAttributeAccessor
public abstract class AttributeAccessor extends java.lang.Object implements CoreAttributeAccessor, java.lang.Cloneable, java.io.Serializable
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.
- See Also:
- Serialized Form
- Author:
- James
- Since:
- OracleAS TopLink 10g (10.0.3)
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.StringattributeNameStores the name of the attributeprotected booleanisReadOnlyprotected booleanisWriteOnly
-
Constructor Summary
Constructors Constructor Description AttributeAccessor()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.Objectclone()INTERNAL: Clones itself.java.lang.ClassgetAttributeClass()Return the class type of the attribute.java.lang.StringgetAttributeName()INTERNAL: Return the attribute name.abstract java.lang.ObjectgetAttributeValueFromObject(java.lang.Object object)Return the attribute value from the object.voidinitializeAttributes(java.lang.Class descriptorClass)Allow any initialization to be performed with the descriptor class.booleanisInitialized()Returns true if this attribute accessor has been initialized and now stores a reference to the class's attribute.booleanisInstanceVariableAttributeAccessor()booleanisMapValueAttributeAccessor()booleanisMethodAttributeAccessor()booleanisReadOnly()INTERNALbooleanisValuesAccessor()booleanisVirtualAttributeAccessor()booleanisWriteOnly()INTERNAL:voidsetAttributeName(java.lang.String attributeName)INTERNAL: Set the attribute name.abstract voidsetAttributeValueInObject(java.lang.Object object, java.lang.Object value)Set the attribute value into the object.voidsetIsReadOnly(boolean aBoolean)INTERNALvoidsetIsWriteOnly(boolean aBoolean)INTERNAL:
-
-
-
Method Detail
-
clone
public java.lang.Object clone()
INTERNAL: Clones itself.- Overrides:
clonein classjava.lang.Object
-
getAttributeName
public java.lang.String getAttributeName()
INTERNAL: Return the attribute name.- Specified by:
getAttributeNamein interfaceCoreAttributeAccessor
-
setAttributeName
public void setAttributeName(java.lang.String attributeName)
INTERNAL: Set the attribute name.
-
getAttributeClass
public java.lang.Class getAttributeClass()
Return the class type of the attribute.- Specified by:
getAttributeClassin interfaceCoreAttributeAccessor
-
initializeAttributes
public void initializeAttributes(java.lang.Class descriptorClass) throws DescriptorExceptionAllow any initialization to be performed with the descriptor class.- Specified by:
initializeAttributesin interfaceCoreAttributeAccessor- Throws:
DescriptorException
-
isInitialized
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.
-
isInstanceVariableAttributeAccessor
public boolean isInstanceVariableAttributeAccessor()
- Specified by:
isInstanceVariableAttributeAccessorin interfaceCoreAttributeAccessor
-
isMapValueAttributeAccessor
public boolean isMapValueAttributeAccessor()
-
isMethodAttributeAccessor
public boolean isMethodAttributeAccessor()
- Specified by:
isMethodAttributeAccessorin interfaceCoreAttributeAccessor
-
isValuesAccessor
public boolean isValuesAccessor()
-
isVirtualAttributeAccessor
public boolean isVirtualAttributeAccessor()
-
isWriteOnly
public boolean isWriteOnly()
INTERNAL:- Specified by:
isWriteOnlyin interfaceCoreAttributeAccessor- Returns:
-
setIsWriteOnly
public void setIsWriteOnly(boolean aBoolean)
INTERNAL:- Specified by:
setIsWriteOnlyin interfaceCoreAttributeAccessor- Parameters:
aBoolean-
-
isReadOnly
public boolean isReadOnly()
INTERNAL- Returns:
-
setIsReadOnly
public void setIsReadOnly(boolean aBoolean)
INTERNAL- Specified by:
setIsReadOnlyin interfaceCoreAttributeAccessor- Parameters:
aBoolean-
-
getAttributeValueFromObject
public abstract java.lang.Object getAttributeValueFromObject(java.lang.Object object) throws DescriptorExceptionReturn the attribute value from the object.- Specified by:
getAttributeValueFromObjectin interfaceCoreAttributeAccessor- Throws:
DescriptorException
-
setAttributeValueInObject
public abstract void setAttributeValueInObject(java.lang.Object object, java.lang.Object value) throws DescriptorExceptionSet the attribute value into the object.- Specified by:
setAttributeValueInObjectin interfaceCoreAttributeAccessor- Throws:
DescriptorException
-
-