org.eclipse.jpt.jpa.core.context.java
Interface JavaAttributeMappingDefinition

All Known Subinterfaces:

DefaultJavaAttributeMappingDefinition

public interface JavaAttributeMappingDefinition

Map a string key to an attribute mapping and its corresponding Java annotations.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.3

Version:

2.3

Method Summary

JavaAttributeMapping	buildMapping(JavaPersistentAttribute persistentAttribute, JpaFactory factory) Build a Java attribute mapping for the specified persistent attribute.
java.lang.String	getAnnotationName() Return the name of the attribute mapping's annotation.
java.lang.String	getKey() Return the attribute mapping's key.
java.lang.Iterable<java.lang.String>	getSupportingAnnotationNames() Return the names of the attribute mapping's "supporting" annotations.
boolean	isSpecified(JavaPersistentAttribute persistentAttribute) Return whether the definition's mapping is the "specified" mapping for the specified persistent attribute.

Method Detail

getKey

java.lang.String getKey()

Return the attribute mapping's key.

getAnnotationName

java.lang.String getAnnotationName()

Return the name of the attribute mapping's annotation.

getSupportingAnnotationNames

java.lang.Iterable<java.lang.String> getSupportingAnnotationNames()

Return the names of the attribute mapping's "supporting" annotations.

isSpecified

boolean isSpecified(JavaPersistentAttribute persistentAttribute)

Return whether the definition's mapping is the "specified" mapping for the specified persistent attribute.

NB: A mapping is not necessarily "specified" if its annotation is present (see org.eclipse.jpt.jpa.core.internal.jpa2.context.java.JavaIdMappingDefinition2_0#isSpecified(JavaPersistentAttribute))

buildMapping

JavaAttributeMapping buildMapping(JavaPersistentAttribute persistentAttribute,
                                  JpaFactory factory)

Build a Java attribute mapping for the specified persistent attribute. Use the specified factory for creation so extenders can simply override the appropriate factory method instead of building a definition for the same key.