Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.accessors.objects

public Class MetadataFile

extends MetadataAccessibleObject
Class Inheritance
Imports
org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings

INTERNAL: Parent object that is used to hold onto a valid JPA decorated file.
Author
Guy Pelletier
Since
EclipseLink 1.0

Field Summary

Modifier and TypeField and Description
pack-priv XMLEntityMappings
Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject:
m_factory

Constructor Summary

AccessConstructor and Description
public
MetadataFile(XMLEntityMappings entityMappings)

INTERNAL:

Method Summary

Modifier and TypeMethod and Description
public String
getAttributeName()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject.getAttributeName.

INTERNAL: Return the attribute name of this accessible object.
public Object
getElement()

INTERNAL: Return the element of this accessible object.

public String
getName()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject.getName.

INTERNAL: Returns the name/url of the metadata file.
Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject:
getLoggergetMetadataClassgetMetadataFactorysetMetadataFactory

Field Detail

m_entityMappingsback to summary
pack-priv XMLEntityMappings m_entityMappings

Constructor Detail

MetadataFileback to summary
public MetadataFile(XMLEntityMappings entityMappings)

INTERNAL:

Method Detail

getAttributeNameback to summary
public String getAttributeName()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject.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).

Annotations
@Override
getElementback to summary
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 ... ;-)

getNameback to summary
public String getName()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject.getName.

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

Annotations
@Override