Module org.eclipse.persistence.core
Package org.eclipse.persistence.internal.oxm.mappings

Interface Mapping<ABSTRACT_SESSION extends CoreAbstractSession,ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor,CONTAINER_POLICY extends CoreContainerPolicy,DESCRIPTOR extends CoreDescriptor,FIELD extends CoreField,XML_RECORD extends XMLRecord>

All Known Subinterfaces:
AnyAttributeMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,XML_RECORD>, AnyCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHAL_KEEP_AS_ELEMENT_POLICY,UNMARSHALLER,XML_RECORD>, AnyObjectMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHAL_KEEP_AS_ELEMENT_POLICY,UNMARSHALLER,XML_RECORD>, BinaryDataCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,MIME_TYPE_POLICY,SESSION,UNMARSHALLER,XML_RECORD>, BinaryDataMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,MIME_TYPE_POLICY,SESSION,UNMARSHALLER,XML_RECORD>, ChoiceCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHALLER,XML_FIELD,XML_MAPPING,XML_RECORD>, ChoiceObjectMapping<ATTRIBUTE_ACCESSOR,ABSTRACT_SESSION,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHALLER,XML_FIELD,XML_MAPPING,XML_RECORD>, CollectionReferenceMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,UNMARSHAL_RECORD,XML_FIELD,XML_RECORD>, CompositeCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHAL_KEEP_AS_ELEMENT_POLICY,UNMARSHALLER,XML_RECORD>, CompositeObjectMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHAL_KEEP_AS_ELEMENT_POLICY,UNMARSHALLER,XML_RECORD>, DirectCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHALLER,XML_RECORD>, DirectMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHALLER,XML_RECORD>, FragmentCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,SESSION,XML_RECORD>, FragmentMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,SESSION,XML_RECORD>, InverseReferenceMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,MAPPING,XML_RECORD>, ObjectReferenceMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,UNMARSHAL_RECORD,XML_FIELD,XML_RECORD>, TransformationMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,TRANSFORMATION_RECORD,XML_RECORD>, VariableXPathCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHALLER,XML_RECORD>, VariableXPathObjectMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHALLER,XML_RECORD>, XMLMapping
All Known Implementing Classes:
XMLAnyAttributeMapping, XMLAnyCollectionMapping, XMLAnyObjectMapping, XMLBinaryDataCollectionMapping, XMLBinaryDataMapping, XMLChoiceCollectionMapping, XMLChoiceObjectMapping, XMLCollectionReferenceMapping, XMLCompositeCollectionMapping, XMLCompositeDirectCollectionMapping, XMLCompositeObjectMapping, XMLDirectMapping, XMLFragmentCollectionMapping, XMLFragmentMapping, XMLInverseReferenceMapping, XMLObjectReferenceMapping, XMLTransformationMapping, XMLVariableXPathCollectionMapping, XMLVariableXPathObjectMapping
public interface Mapping<ABSTRACT_SESSION extends CoreAbstractSession,ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor,CONTAINER_POLICY extends CoreContainerPolicy,DESCRIPTOR extends CoreDescriptor,FIELD extends CoreField,XML_RECORD extends XMLRecord>

  • Method Details

    • convertClassNamesToClasses

      void convertClassNamesToClasses(ClassLoader classLoader)

    • getAttributeAccessor

      ATTRIBUTE_ACCESSOR getAttributeAccessor()

    • getAttributeClassification

      Class<?> getAttributeClassification()
      The classification type for the attribute this mapping represents

    • getAttributeName

      String getAttributeName()
      Return the name of the attribute set in the mapping.

    • getAttributeValueFromObject

      Object getAttributeValueFromObject(Object object)

    • getContainerPolicy

      CONTAINER_POLICY getContainerPolicy()

    • getDescriptor

      DESCRIPTOR getDescriptor()
      Return the descriptor to which this mapping belongs

    • getField

      FIELD getField()

    • getReferenceDescriptor

      DESCRIPTOR getReferenceDescriptor()

    • isAbstractCompositeCollectionMapping

      boolean isAbstractCompositeCollectionMapping()
      Related mapping should implement this method to return true.

    • isAbstractCompositeDirectCollectionMapping

      boolean isAbstractCompositeDirectCollectionMapping()
      Related mapping should implement this method to return true.

    • isAbstractCompositeObjectMapping

      boolean isAbstractCompositeObjectMapping()
      Related mapping should implement this method to return true.

    • isAbstractDirectMapping

      boolean isAbstractDirectMapping()
      Related mapping should implement this method to return true.

    • isCollectionMapping

      boolean isCollectionMapping()

    • isReadOnly

      boolean isReadOnly()

    • isReferenceMapping

      boolean isReferenceMapping()

    • isTransformationMapping

      boolean isTransformationMapping()
      Related mapping should implement this method to return true.

    • setAttributeAccessor

      void setAttributeAccessor(ATTRIBUTE_ACCESSOR attributeAccessor)
      ADVANCED: Set the attributeAccessor. The attribute accessor is responsible for setting and retrieving the attribute value from the object for this mapping. This can be set to an implementor of AttributeAccessor if the attribute requires advanced conversion of the mapping value, or a real attribute does not exist.

    • setAttributeName

      void setAttributeName(String attributeName)
      Sets the name of the attribute in the mapping.

    • setAttributeValueInObject

      void setAttributeValueInObject(Object object, Object value)

    • writeSingleValue

      void writeSingleValue(Object value, Object object, XML_RECORD record, ABSTRACT_SESSION session)

    • setGetMethodName

      void setGetMethodName(String methodName)
      This method is invoked reflectively on the reference object to return the value of the attribute in the object. This method sets the name of the getMethodName.

    • setIsReadOnly

      void setIsReadOnly(boolean aBoolean)
      Set this mapping to be read only. Read-only mappings can be used if two attributes map to the same field. Read-only mappings cannot be used for the primary key or other required fields.

    • setProperties

      void setProperties(Map properties)
      INTERNAL: Allow user defined properties.

    • setSetMethodName

      void setSetMethodName(String methodName)
      Set the methodName used to set the value for the mapping's attribute into the object.