Module org.eclipse.persistence.jpa

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

Class MetadataFile

java.lang.Object

org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject

org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataFile

public class MetadataFile
extends MetadataAccessibleObject

INTERNAL: Parent object that is used to hold onto a valid JPA decorated file.

Since:

EclipseLink 1.0

Author:

Guy Pelletier

Field Summary

Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject

m_factory

Constructor Summary

Constructors

Constructor	Description
MetadataFile(XMLEntityMappings entityMappings)	INTERNAL:

Method Summary

Modifier and Type	Method	Description
String	getAttributeName()	INTERNAL: Return the attribute name of this accessible object.
Object	getElement()	INTERNAL: Return the element of this accessible object.
String	getName()	INTERNAL: Returns the name/url of the metadata file.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject

getLogger, getMetadataClass, getMetadataFactory, setMetadataFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataFile

public MetadataFile(XMLEntityMappings entityMappings)

INTERNAL:

Method Detail

getAttributeName

public String getAttributeName()

INTERNAL: Return the attribute name of this accessible object. Right now it's just the location. This method is currently never called and is implemented only to satisfy the abstract definition. An attribute name is very important on the metadata annotated element side and describes the attribute the metadata is tied to. This avoids unnecessary casting when initializing XML objects. If in the future, some logging message (or something else would like to use this method, feel free to modify it to return whatever is necessary (and of course, change this comment to reflect the new dependency).

Specified by:

getAttributeName in class MetadataAccessibleObject

getElement

public Object getElement()

INTERNAL: Return the element of this accessible object. Right now it's just the top most entity mappings tag. At least it's something. Could probably get more descriptive, right now it's only used in merging and for those elements that do not tie to an annotated element (class, method or field) That is, unnamed <entity-mappings> level elements and <persistence-unit-metadata> and <persistence-unit-defaults> elements. So this will have to do for now ... plus no one looks at the logging messages anyway ... ;-)

getName

public String getName()

INTERNAL: Returns the name/url of the metadata file.

Specified by:

getName in class MetadataAccessibleObject