EclipseLink JPA 4.0.2 · org.eclipse.persistence.internal.jpa.metadata.converters.ConvertMetadata

Modifier and Type	Field and Description
private String	m_attributeName
private MetadataClass	m_converterClass
private String	m_converterClassName
private Boolean	m_disableConversion
private Boolean	m_isForMapKey
private String	m_text

Access	Constructor and Description
public	ConvertMetadata() INTERNAL: Used for XML loading.
public	ConvertMetadata(MetadataAnnotation convert, MetadataAccessor accessor) INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method and Description
private void	apply(final DatabaseMapping Database attribute mapping. mapping, final MetadataClass JPA annotated class. referenceClass, final ClassAccessor Class accessor. accessor, final boolean Is this converter for MapKey? isForMapKey) INTERNAL: Apply converter class.
public boolean	disableConversion() INTERNAL: Return true if any auto apply converter should be disabled.
public boolean	equals(Object the reference object with which to compare. objectToCompare) Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals. INTERNAL:
public String	getAttributeName() INTERNAL: Used for OX mapping.
public MetadataClass	getConverterClass() INTERNAL:
public String	getConverterClassName() INTERNAL: Used for OX mapping.
public Boolean	getDisableConversion() INTERNAL: Used for OX mapping.
protected String	getText() Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getText. INTERNAL: Used for OX mapping.
public boolean	hasAttributeName() INTERNAL:
public boolean	hasConverterClass() INTERNAL:
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.initXMLObject. INTERNAL:
public boolean	isForMapKey() INTERNAL: Return true if this convert metadata is for a map key.
public void	process(final DatabaseMapping Database attribute mapping. mapping, final MetadataClass JPA annotated class. referenceClass, final ClassAccessor Class accessor. accessor, final String Content of `<name>` from `attributeName="value.<name>"`. embeddedAttributeName) INTERNAL: Apply convert for `@ElementCollection` mapping where we expect `@Convert` annotation to contain `attributeName="value.`
public void	process(final DatabaseMapping Database attribute mapping. mapping, final MetadataClass JPA annotated class. referenceClass, final ClassAccessor Class accessor. accessor, final boolean Is this converter for MapKey? isForMapKey) INTERNAL: By the time we get here, we have the mapping that needs to have the convert applied to.
public void	setAttributeName(String attributeName) INTERNAL: Used for OX mapping.
public void	setConverterClassName(String converterClassName) INTERNAL: Used for OX mapping.
public void	setDisableConversion(Boolean disableConversion) INTERNAL: Used for OX mapping.
public void	setText(String text) INTERNAL: Used for OX mapping.
private MetadataClass	verify(final DatabaseMapping Database attribute mapping. mapping, final MetadataClass JPA annotated class. referenceClass, final ClassAccessor Class accessor. accessor, final String Content of `<name>` from `attributeName="value.<name>"`. This value shall never be `null` when `@ElementCollection` mapping is being processed. embeddedAttributeName) INTERNAL: Verify mapping passed to register `AttributeConverter` class.

m_attributeName	back to summary
private String m_attributeName

m_converterClass	back to summary
private MetadataClass m_converterClass

m_converterClassName	back to summary
private String m_converterClassName

m_disableConversion	back to summary
private Boolean m_disableConversion

m_isForMapKey	back to summary
private Boolean m_isForMapKey

m_text	back to summary
private String m_text

Method Detail

apply

back to summary

private void apply(final DatabaseMapping mapping, final MetadataClass referenceClass, final ClassAccessor accessor, final boolean isForMapKey)

INTERNAL: Apply converter class.

Parameters

mapping:DatabaseMapping: Database attribute mapping.
referenceClass:MetadataClass: JPA annotated class.
accessor:ClassAccessor: Class accessor.
isForMapKey:boolean: Is this converter for MapKey?

disableConversion	back to summary
public boolean disableConversion() INTERNAL: Return true if any auto apply converter should be disabled.

equals back to summary

equals	back to summary
public boolean equals(Object objectToCompare) Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals. INTERNAL: Parameters objectToCompare:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL:

Parameters

objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAttributeName	back to summary
public String getAttributeName() INTERNAL: Used for OX mapping.

getConverterClass	back to summary
public MetadataClass getConverterClass() INTERNAL:

getConverterClassName	back to summary
public String getConverterClassName() INTERNAL: Used for OX mapping.

getDisableConversion	back to summary
public Boolean getDisableConversion() INTERNAL: Used for OX mapping.

getText	back to summary
protected String getText() Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getText. INTERNAL: Used for OX mapping. Any ORMetadata that supported mixed types, that is, text or other metadata should override this method. Annotations @Override

getText

back to summary

protected String getText()

Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.getText.

INTERNAL: Used for OX mapping. Any ORMetadata that supported mixed types, that is, text or other metadata should override this method.

Annotations

@Override

hasAttributeName	back to summary
public boolean hasAttributeName() INTERNAL:

hasConverterClass	back to summary
public boolean hasConverterClass() INTERNAL:

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

initXMLObject

back to summary

public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

Overrides org.eclipse.persistence.internal.jpa.metadata.ORMetadata.initXMLObject.

INTERNAL:

Annotations

@Override

isForMapKey	back to summary
public boolean isForMapKey() INTERNAL: Return true if this convert metadata is for a map key. Way to tell is if there is an attribute name that begins with "key". Calling this method will also update the attribute name on the first call to it. This call is made when sorting convert annotations. Unlike XML, where the user can sort through <convert> and <map-key-convert> elements, there is only a single Convert annotation that uses a "key" prefix on the attribute name to signify a map key convert. An unforunate decision by the JPA spec committee, but we can make it work of course.

isForMapKey

back to summary

public boolean isForMapKey()

INTERNAL: Return true if this convert metadata is for a map key. Way to tell is if there is an attribute name that begins with "key". Calling this method will also update the attribute name on the first call to it. This call is made when sorting convert annotations. Unlike XML, where the user can sort through <convert> and <map-key-convert> elements, there is only a single Convert annotation that uses a "key" prefix on the attribute name to signify a map key convert. An unforunate decision by the JPA spec committee, but we can make it work of course.

process back to summary

public void process(final DatabaseMapping mapping, final MetadataClass referenceClass, final ClassAccessor accessor, final String embeddedAttributeName)

INTERNAL: Apply convert for @ElementCollection mapping where we expect @Convert annotation to contain attributeName="value.<name>".

Parameters

mapping:DatabaseMapping: Database attribute mapping.
referenceClass:MetadataClass: JPA annotated class.
accessor:ClassAccessor: Class accessor.
embeddedAttributeName:String: Content of <name> from attributeName="value.<name>".

process

back to summary

public void process(final DatabaseMapping mapping, final MetadataClass referenceClass, final ClassAccessor accessor, final boolean isForMapKey)

INTERNAL: By the time we get here, we have the mapping that needs to have the convert applied to. Do some validation checks along with some embedded mapping traversing if need be and apply the converter. Will look an auto-apply converter as well if one is not specified directly.

Parameters

mapping:DatabaseMapping: Database attribute mapping.
referenceClass:MetadataClass: JPA annotated class.
accessor:ClassAccessor: Class accessor.
isForMapKey:boolean: Is this converter for MapKey?

setAttributeName	back to summary
public void setAttributeName(String attributeName) INTERNAL: Used for OX mapping.

setConverterClassName	back to summary
public void setConverterClassName(String converterClassName) INTERNAL: Used for OX mapping.

setDisableConversion	back to summary
public void setDisableConversion(Boolean disableConversion) INTERNAL: Used for OX mapping.

setText	back to summary
public void setText(String text) INTERNAL: Used for OX mapping.

verify back to summary

private MetadataClass verify(final DatabaseMapping mapping, final MetadataClass referenceClass, final ClassAccessor accessor, final String embeddedAttributeName) throws ValidationException

INTERNAL: Verify mapping passed to register AttributeConverter class.

Parameters

mapping:DatabaseMapping: Database attribute mapping.
referenceClass:MetadataClass: JPA annotated class.
accessor:ClassAccessor: Class accessor.
embeddedAttributeName:String: Content of <name> from attributeName="value.<name>". This value shall never be null when @ElementCollection mapping is being processed.

public Class ConvertMetadata

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail