Module org.eclipse.persistence.jpa

Package org.eclipse.persistence.internal.jpa.metadata

Class MetadataHelper

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.MetadataHelper

public class MetadataHelper
extends Object

INTERNAL: Common helper methods for the metadata processing.

Since:

TopLink EJB 3.0 Reference Implementation

Author:

Guy Pelletier

Field Summary

Fields

Modifier and Type	Field	Description
static String	ECLIPSELINK_ORM_FILE
static String	JPA_ORM_FILE

Method Summary

Modifier and Type	Method	Description
protected static String	getCanonicalName(String name, Map<String,Object> properties)	INTERNAL: Return the canonical name.
static Class<?>	getClassForName(String classname, ClassLoader loader)	INTERNAL: Load a class from a given class name.
static String	getName(String name, String defaultName, String context, MetadataLogger logger, Object location)	INTERNAL: Helper method to return a field name from a candidate field name and a default field name.
static String	getQualifiedCanonicalName(String qualifiedName, Map<String,Object> properties)	INTERNAL: Return the canonical name applying any default package.
static String	getQualifiedCanonicalName(String qualifiedName, AbstractSession session)	INTERNAL: Return the qualified canonical name of the given qualified class name.
static Integer	getValue(Integer value, Integer defaultValue)	INTERNAL: Helper method to return a string value if specified, otherwise returns the default value.
static String	getValue(String value, String defaultValue)	INTERNAL: Helper method to return a string value if specified, otherwise returns the default value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JPA_ORM_FILE

public static final String JPA_ORM_FILE

See Also:

Constant Field Values

ECLIPSELINK_ORM_FILE

public static final String ECLIPSELINK_ORM_FILE

See Also:

Constant Field Values

Method Detail

getCanonicalName

protected static String getCanonicalName(String name,
                                         Map<String,Object> properties)

INTERNAL: Return the canonical name. This will apply the prefix and suffix qualifiers given to the canonical name. If the given prefix is null, the the default "" is applied. If the given suffix is null, then the default "_" will be applied.

getClassForName

public static Class<?> getClassForName(String classname,
                                       ClassLoader loader)

INTERNAL: Load a class from a given class name. (XMLEntityMappings calls this one)

getName

public static String getName(String name,
                             String defaultName,
                             String context,
                             MetadataLogger logger,
                             Object location)

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.

getQualifiedCanonicalName

public static String getQualifiedCanonicalName(String qualifiedName,
                                               AbstractSession session)

INTERNAL: Return the qualified canonical name of the given qualified class name. This method will check the session for a corresponding class that was processed during deploy. If one is not found, will build the canonical name applying any default package and the default suffix qualifier "_".

getQualifiedCanonicalName

public static String getQualifiedCanonicalName(String qualifiedName,
                                               Map<String,Object> properties)

INTERNAL: Return the canonical name applying any default package. This will apply the prefix and suffix qualifiers given to the canonical name. If the prefix is null, the default "" is applied. If the suffix is null, then the default "_" will be applied.

getValue

public static Integer getValue(Integer value,
                               Integer defaultValue)

INTERNAL: Helper method to return a string value if specified, otherwise returns the default value.

getValue

public static String getValue(String value,
                              String defaultValue)

INTERNAL: Helper method to return a string value if specified, otherwise returns the default value.