Modifier and Type	Class and Description
private static class	ORMetadata.SimpleORMetadata INTERNAL: Internal class to represent java type objects.

Modifier and Type	Field and Description
private static final Map<String, String>	boxedTypes
private MetadataAccessibleObject	m_accessibleObject
private MetadataAnnotation	m_annotation
private XMLEntityMappings	m_entityMappings
private Object	m_location
protected MetadataProject	m_project
private String	m_xmlElement
private static final Map<String, Class<?>>	primitiveClasses

Access	Constructor and Description
protected	ORMetadata() INTERNAL: Used for defaulting case.
public	ORMetadata(String xmlElement) INTERNAL: Used for OX loading.
protected	ORMetadata(MetadataAccessibleObject accessibleObject, MetadataProject project, Object location) INTERNAL: Used for defaulting.
public	ORMetadata(MetadataAnnotation annotation, MetadataAccessor accessor) INTERNAL: Used for annotation loading of metadata objects.
public	ORMetadata(MetadataAnnotation annotation, MetadataAccessibleObject accessibleObject, MetadataProject project) INTERNAL: Used for annotation loading of class and mapping accessors.
public	ORMetadata(ORMetadata orm) INTERNAL: Used for annotation loading and switching from one metadata object to a more specific one.

Method Summary

Modifier and Type	Method and Description
public abstract boolean	equals(Object the reference object with which to compare. objectToCompare) Overrides java.lang.Object.equals. INTERNAL: For merging and overriding to work properly, all ORMetadata must be able to compare themselves for metadata equality.
protected MetadataAccessibleObject	getAccessibleObject() INTERNAL: Returns the accessible object for this accessor.
public String	getAccessibleObjectName() INTERNAL: Returns the name of the accessible object.
public MetadataAnnotation	getAnnotation() INTERNAL: This is a value is that is used when logging messages for overriding.
protected String	getBoxedType(String type) INTERNAL: Quick lookup of a primitive boxed type.
private static Map<String, String>	getBoxedTypesMap()
protected DatabaseType	getDatabaseTypeEnum(String type) Return the DataType enum constant for the String type name.
public XMLEntityMappings	getEntityMappings() INTERNAL:
protected String	getFullyQualifiedClassName(String className) INTERNAL: Return the fully qualified className using the package (if any) setting from XML.
protected String	getIdentifier() INTERNAL: Sub classes that can uniquely be identified must override this method to allow the overriding and merging to uniquely identify objects.
protected Class<?>	getJavaClass(MetadataClass metadataClass) INTERNAL: Return the Java class for the metadata class using the metadata loader.
public String	getJavaClassName(MetadataClass metadataClass) INTERNAL: Return the Java class name for the metadata class.
public ClassLoader	getLoader() INTERNAL: This method will return the current loader from the metadata factory used to created this ORMetadata.
public Object	getLocation() INTERNAL:
public MetadataLogger	getLogger() INTERNAL: Return the metadata logger.
public MetadataClass	getMetadataClass(Class<?> javaClass) INTERNAL: Return the MetadataClass for the class.
public MetadataClass	getMetadataClass(String className) INTERNAL: Return the MetadataClass for the class name.
public MetadataClass	getMetadataClass(String className, boolean isLazy) INTERNAL: Return the MetadataClass for the class name.
public MetadataFactory	getMetadataFactory() INTERNAL:
protected String	getName(String name, String defaultName, String context) INTERNAL: Helper method to return a field name from a candidate field name and a default field name.
private static Map<String, Class<?>>	getPrimitiveClassesMap()
protected Class<?>	getPrimitiveClassForName(String className) INTERNAL:
public MetadataProject	getProject() INTERNAL: Return the MetadataProject.
protected String	getText() INTERNAL: Any ORMetadata that supported mixed types, that is, text or other metadata should override this method.
protected String	getXMLElement() INTERNAL: This is a value is that is used when logging messages for overriding.
protected boolean	hasIdentifier() INTERNAL:
protected boolean	hasText() INTERNAL: Any ORMetadata that supported mixed types, that is, text or other metadata should override this method.
protected MetadataClass	initXMLClassName(String className) INTERNAL: This method should only be called on those objects that were loaded from XML and that need to initialize a class name.
public void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) INTERNAL: Any subclass that cares to do any more initialization (e.g. initialize a class) should override this method.
protected void	initXMLObject(ORMetadata metadata, MetadataAccessibleObject accessibleObject) INTERNAL:
protected <T extends ORMetadata> void	initXMLObjects(List<T> metadatas, MetadataAccessibleObject accessibleObject) INTERNAL: It is assumed this is a list of ORMetadata
protected <T extends ORMetadata> String	initXMLTextObject(List<T> metadatas) INTERNAL: This is to support legacy orm instance docs.
public boolean	loadedFromAnnotation() INTERNAL: Note: That annotations can default so the annotation may be null.
public boolean	loadedFromEclipseLinkXML() INTERNAL:
public boolean	loadedFromXML() INTERNAL:
protected void	merge(ORMetadata metadata) INTERNAL: Subclasses that care to handle deeper merges should extend this method.
protected <T extends ORMetadata> List<T>	mergeORObjectLists(List<T> list1, List<T> list2) INTERNAL: Convenience method to merge two lists of metadata objects.
protected ORMetadata	mergeORObjects(ORMetadata obj1, ORMetadata obj2) INTERNAL: Convenience method to merge two objects that were loaded from XML.
protected Object	mergeSimpleObjects(Object obj1, Object obj2, ORMetadata otherMetadata, String xmlElement) INTERNAL: Convenience method to merge two objects that were loaded from XML.
protected EntityAccessor	reloadEntity(EntityAccessor entity, MetadataDescriptor descriptor) INTERNAL: This method should be called to reload an entity (that was either loaded from XML or an annotation) as a way of cloning it.
protected MappedSuperclassAccessor	reloadMappedSuperclass(MappedSuperclassAccessor mappedSuperclass, MetadataDescriptor descriptor) INTERNAL: This method should be called to reload a mapped superclass (that was either loaded from XML or an annotation) as a way of cloning it.
public void	setAccessibleObject(MetadataAccessibleObject accessibleObject) INTERNAL: Set the accessible object for this accessor.
public void	setEntityMappings(XMLEntityMappings entityMappings) INTERNAL: Set the entity mappings (mapping file) for this OR object.
protected void	setFieldName(DatabaseField field, String name) INTERNAL: All field names should be set through this method to ensure delimited identifiers and upper casing defaults are set.
protected void	setFieldName(DatabaseField field, String defaultName, String context) INTERNAL: Go through this method if you can default a name.
public void	setProject(MetadataProject project) INTERNAL: Set the metadata project.
public boolean	shouldOverride(ORMetadata existing) INTERNAL: Method to determine if this ORMetadata should override another.
protected boolean	valuesMatch(List<Object> list1, List<Object> list2) INTERNAL: Two lists are the same if they are the same size and their ordered elements are the same.
protected boolean	valuesMatch(Object value1, Object value2) INTERNAL:

Inherited from java.lang.Object:: clone finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

boxedTypes	back to summary
private static final Map<String, String> boxedTypes

m_accessibleObject	back to summary
private MetadataAccessibleObject m_accessibleObject

m_annotation	back to summary
private MetadataAnnotation m_annotation

m_entityMappings	back to summary
private XMLEntityMappings m_entityMappings

m_location	back to summary
private Object m_location

m_project	back to summary
protected MetadataProject m_project

m_xmlElement	back to summary
private String m_xmlElement

primitiveClasses	back to summary
private static final Map<String, Class<?>> primitiveClasses

Constructor Detail

ORMetadata	back to summary
protected ORMetadata() INTERNAL: Used for defaulting case.

ORMetadata	back to summary
public ORMetadata(String xmlElement) INTERNAL: Used for OX loading.

ORMetadata

back to summary

protected ORMetadata(MetadataAccessibleObject accessibleObject, MetadataProject project, Object location)

INTERNAL: Used for defaulting. At minimum, all metadata should have this information available to them at process time (to ensure no errors during processing). Depending on the metadata processing needs you can get away with not having them set, however, any dependencies on the loader, metadata logger or the metadata project etc. will require these.

ORMetadata	back to summary
public ORMetadata(MetadataAnnotation annotation, MetadataAccessor accessor) INTERNAL: Used for annotation loading of metadata objects.

ORMetadata	back to summary
public ORMetadata(MetadataAnnotation annotation, MetadataAccessibleObject accessibleObject, MetadataProject project) INTERNAL: Used for annotation loading of class and mapping accessors.

ORMetadata	back to summary
public ORMetadata(ORMetadata orm) INTERNAL: Used for annotation loading and switching from one metadata object to a more specific one.

Method Detail

equals back to summary

equals	back to summary
public abstract boolean equals(Object objectToCompare) Overrides java.lang.Object.equals. INTERNAL: For merging and overriding to work properly, all ORMetadata must be able to compare themselves for metadata equality. equals plays a big role in the shouldOverride() method from this class. 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 abstract boolean equals(Object objectToCompare)

Overrides java.lang.Object.equals.

INTERNAL: For merging and overriding to work properly, all ORMetadata must be able to compare themselves for metadata equality. equals plays a big role in the shouldOverride() method from this class.

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

getAccessibleObject	back to summary
protected MetadataAccessibleObject getAccessibleObject() INTERNAL: Returns the accessible object for this accessor.

getAccessibleObjectName	back to summary
public String getAccessibleObjectName() INTERNAL: Returns the name of the accessible object. If it is a field, it will return the field name. For a method it will return the method name.

getAnnotation back to summary

getAnnotation	back to summary
public MetadataAnnotation getAnnotation() INTERNAL: This is a value is that is used when logging messages for overriding. See Also `shouldOverride`

public MetadataAnnotation getAnnotation()

INTERNAL: This is a value is that is used when logging messages for overriding.

See Also: shouldOverride

getBoxedType	back to summary
protected String getBoxedType(String type) INTERNAL: Quick lookup of a primitive boxed type.

getBoxedTypesMap	back to summary
private static Map<String, String> getBoxedTypesMap()

getDatabaseTypeEnum	back to summary
protected DatabaseType getDatabaseTypeEnum(String type) Return the DataType enum constant for the String type name. If not a type defined by the enums, then return a record type.

getEntityMappings	back to summary
public XMLEntityMappings getEntityMappings() INTERNAL:

getFullyQualifiedClassName	back to summary
protected String getFullyQualifiedClassName(String className) INTERNAL: Return the fully qualified className using the package (if any) setting from XML.

getIdentifier back to summary

getIdentifier	back to summary
protected String getIdentifier() INTERNAL: Sub classes that can uniquely be identified must override this method to allow the overriding and merging to uniquely identify objects. It will also be used when logging messages, that is, to provide a more detailed message. See Also `shouldOverride(ORMetadata)`, `mergeORObjects(ORMetadata, ORMetadata)`, `mergeORObjectLists(List, List)`

protected String getIdentifier()

INTERNAL: Sub classes that can uniquely be identified must override this method to allow the overriding and merging to uniquely identify objects. It will also be used when logging messages, that is, to provide a more detailed message.

See Also: shouldOverride(ORMetadata), mergeORObjects(ORMetadata, ORMetadata), mergeORObjectLists(List, List)

getJavaClass

back to summary

protected Class<?> getJavaClass(MetadataClass metadataClass)

INTERNAL: Return the Java class for the metadata class using the metadata loader. Callers to this method should only do so when the application loader (from deploy) is available. This method should not be called with the temp loader, see getJavaClassName instead which will provide a valid string class name that can be initialized at runtime instead.

getJavaClassName	back to summary
public String getJavaClassName(MetadataClass metadataClass) INTERNAL: Return the Java class name for the metadata class. This is the class name name metadata processing should set on descriptors and mappings to be initialized during the convertClassNamesToClasses call at runtime.

getLoader	back to summary
public ClassLoader getLoader() INTERNAL: This method will return the current loader from the metadata factory used to created this ORMetadata.

getLocation	back to summary
public Object getLocation() INTERNAL:

getLogger	back to summary
public MetadataLogger getLogger() INTERNAL: Return the metadata logger.

getMetadataClass	back to summary
public MetadataClass getMetadataClass(Class<?> javaClass) INTERNAL: Return the MetadataClass for the class.

getMetadataClass	back to summary
public MetadataClass getMetadataClass(String className) INTERNAL: Return the MetadataClass for the class name.

getMetadataClass	back to summary
public MetadataClass getMetadataClass(String className, boolean isLazy) INTERNAL: Return the MetadataClass for the class name.

getMetadataFactory	back to summary
public MetadataFactory getMetadataFactory() INTERNAL:

getName	back to summary
protected String getName(String name, String defaultName, String context) INTERNAL: Helper method to return a field name from a candidate field name and a default field name. Requires the context from where this method is called to output the correct logging message when defaulting the field name. In some cases, both the name and defaultName could be "" or null, therefore, don't log a message and return name.

getName

back to summary

protected String getName(String name, String defaultName, String context)

INTERNAL: Helper method to return a field name from a candidate field name and a default field name. Requires the context from where this method is called to output the correct logging message when defaulting the field name. In some cases, both the name and defaultName could be "" or null, therefore, don't log a message and return name.

getPrimitiveClassesMap	back to summary
private static Map<String, Class<?>> getPrimitiveClassesMap()

getPrimitiveClassForName	back to summary
protected Class<?> getPrimitiveClassForName(String className) INTERNAL:

getProject	back to summary
public MetadataProject getProject() INTERNAL: Return the MetadataProject.

getText	back to summary
protected String getText() INTERNAL: Any ORMetadata that supported mixed types, that is, text or other metadata should override this method.

getXMLElement back to summary

getXMLElement	back to summary
protected String getXMLElement() INTERNAL: This is a value is that is used when logging messages for overriding. See Also `shouldOverride(ORMetadata)`

protected String getXMLElement()

INTERNAL: This is a value is that is used when logging messages for overriding.

See Also: shouldOverride(ORMetadata)

hasIdentifier	back to summary
protected boolean hasIdentifier() INTERNAL:

hasText	back to summary
protected boolean hasText() INTERNAL: Any ORMetadata that supported mixed types, that is, text or other metadata should override this method.

initXMLClassName	back to summary
protected MetadataClass initXMLClassName(String className) INTERNAL: This method should only be called on those objects that were loaded from XML and that need to initialize a class name. The assumption here is that an entity mappings object will be available.

initXMLObject	back to summary
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) INTERNAL: Any subclass that cares to do any more initialization (e.g. initialize a class) should override this method.

initXMLObject	back to summary
protected void initXMLObject(ORMetadata metadata, MetadataAccessibleObject accessibleObject) INTERNAL:

initXMLObjects	back to summary
protected <T extends ORMetadata> void initXMLObjects(List<T> metadatas, MetadataAccessibleObject accessibleObject) INTERNAL: It is assumed this is a list of ORMetadata

initXMLTextObject back to summary

initXMLTextObject	back to summary
protected <T extends ORMetadata> String initXMLTextObject(List<T> metadatas) INTERNAL: This is to support legacy orm instance docs. In some cases, previous simple text elements may have been changed to a list of ORMetadata through spec churn. (e.g. `<convert>`). Method helps support backwards compatibility. If the text object is initialized the metadata list is set to null to ease further processing (logging, warnings, overrides etc.)

protected <T extends ORMetadata> String initXMLTextObject(List<T> metadatas)

INTERNAL: This is to support legacy orm instance docs. In some cases, previous simple text elements may have been changed to a list of ORMetadata through spec churn. (e.g. <convert>). Method helps support backwards compatibility. If the text object is initialized the metadata list is set to null to ease further processing (logging, warnings, overrides etc.)

loadedFromAnnotation	back to summary
public boolean loadedFromAnnotation() INTERNAL: Note: That annotations can default so the annotation may be null.

loadedFromEclipseLinkXML	back to summary
public boolean loadedFromEclipseLinkXML() INTERNAL:

loadedFromXML	back to summary
public boolean loadedFromXML() INTERNAL:

merge	back to summary
protected void merge(ORMetadata metadata) INTERNAL: Subclasses that care to handle deeper merges should extend this method.

mergeORObjectLists	back to summary
protected <T extends ORMetadata> List<T> mergeORObjectLists(List<T> list1, List<T> list2) INTERNAL: Convenience method to merge two lists of metadata objects. This does not check for duplicates or any overrides at this time. Just appends all items from list2 to list1.

mergeORObjects	back to summary
protected ORMetadata mergeORObjects(ORMetadata obj1, ORMetadata obj2) INTERNAL: Convenience method to merge two objects that were loaded from XML. The merge is complete. If value2 is specified it will override value1, otherwise, value1 does not change.

mergeSimpleObjects	back to summary
protected Object mergeSimpleObjects(Object obj1, Object obj2, ORMetadata otherMetadata, String xmlElement) INTERNAL: Convenience method to merge two objects that were loaded from XML. The merge is complete. If value2 is specified it will override value1, otherwise, value1 does not.

reloadEntity

back to summary

protected EntityAccessor reloadEntity(EntityAccessor entity, MetadataDescriptor descriptor)

INTERNAL: This method should be called to reload an entity (that was either loaded from XML or an annotation) as a way of cloning it. This is needed when we process TABLE_PER_CLASS inheritance. We must process the parent classes for every subclasses descriptor. The processing is similar to that of processing a mapped superclass, in that we process the parents with the subclasses context (that is, the descriptor we are given).

reloadMappedSuperclass

back to summary

protected MappedSuperclassAccessor reloadMappedSuperclass(MappedSuperclassAccessor mappedSuperclass, MetadataDescriptor descriptor)

INTERNAL: This method should be called to reload a mapped superclass (that was either loaded from XML or an annotation) as a way of cloning it. This is needed when processing TABLE_PER_CLASS inheritance and when building individual entity accessor's mapped superclass list.

setAccessibleObject	back to summary
public void setAccessibleObject(MetadataAccessibleObject accessibleObject) INTERNAL: Set the accessible object for this accessor.

setEntityMappings	back to summary
public void setEntityMappings(XMLEntityMappings entityMappings) INTERNAL: Set the entity mappings (mapping file) for this OR object.

setFieldName	back to summary
protected void setFieldName(DatabaseField field, String name) INTERNAL: All field names should be set through this method to ensure delimited identifiers and upper casing defaults are set.

setFieldName	back to summary
protected void setFieldName(DatabaseField field, String defaultName, String context) INTERNAL: Go through this method if you can default a name. Provide the defaulting context to log to the correct context message to the user.

setProject	back to summary
public void setProject(MetadataProject project) INTERNAL: Set the metadata project.

shouldOverride	back to summary
public boolean shouldOverride(ORMetadata existing) INTERNAL: Method to determine if this ORMetadata should override another. Assumes all ORMetadata that call this method have correctly implemented their equals method.

valuesMatch	back to summary
protected boolean valuesMatch(List<Object> list1, List<Object> list2) INTERNAL: Two lists are the same if they are the same size and their ordered elements are the same.

valuesMatch	back to summary
protected boolean valuesMatch(Object value1, Object value2) INTERNAL:

org.eclipse.persistence.internal.jpa.metadata back to summary

private final Class ORMetadata.SimpleORMetadata

Class Inheritance

extends ORMetadata

java.lang.Object
org.eclipse.persistence.internal.jpa.metadata.ORMetadata
org.eclipse.persistence.internal.jpa.metadata.ORMetadata.SimpleORMetadata

INTERNAL: Internal class to represent java type objects. XML only.

Field Summary

Modifier and Type	Field and Description
private final Object	m_value

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:: m_project

Constructor Summary

Access	Constructor and Description
public	SimpleORMetadata(Object value, MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings, String xmlElement) INTERNAL:

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. objectToCompare) Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals. INTERNAL:
public Object	getValue() INTERNAL:
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.

Field Detail

m_value	back to summary
private final Object m_value

Constructor Detail

SimpleORMetadata	back to summary
public SimpleORMetadata(Object value, MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings, String xmlElement) INTERNAL:

Method Detail

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

getValue	back to summary
public Object getValue() INTERNAL:

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 abstract Class ORMetadata

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ORMetadata.SimpleORMetadata

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail