org.eclipse.persistence.internal.jpa.metadata.graphs

Class NamedEntityGraphMetadata

java.lang.Object

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

org.eclipse.persistence.internal.jpa.metadata.graphs.NamedEntityGraphMetadata

public class NamedEntityGraphMetadata
extends ORMetadata

Object to hold onto named entity graph metadata. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - any metadata mapped from XML to this class must be initialized in the initXMLObject method. - when loading from annotations, the constructor accepts the metadata accessor this metadata was loaded from. Used it to look up any 'companion' annotation needed for processing. - methods should be preserved in alphabetical order.

Since:

EclipseLink 2.5

Author:

Guy Pelletier

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	m_includeAllAttributes
protected java.lang.String	m_name
protected java.util.List<NamedAttributeNodeMetadata>	m_namedAttributeNodes
protected java.util.List<NamedSubgraphMetadata>	m_subclassSubgraphs
protected java.util.List<NamedSubgraphMetadata>	m_subgraphs

Fields inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

m_project

Constructor Summary

Constructors

Constructor and Description
NamedEntityGraphMetadata() INTERNAL: Used for XML loading.
NamedEntityGraphMetadata(MetadataAnnotation namedEntityGraph, EntityAccessor accessor) INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object objectToCompare) INTERNAL: Used for XML merging and overriding.
java.lang.Boolean	getIncludeAllAttributes() INTERNAL: Used for OX mapping.
java.lang.String	getName() INTERNAL: Used for OX mapping.
java.util.List<NamedAttributeNodeMetadata>	getNamedAttributeNodes() INTERNAL: Used for OX mapping.
java.util.List<NamedSubgraphMetadata>	getSubclassSubgraphs() INTERNAL: Used for OX mapping.
java.util.List<NamedSubgraphMetadata>	getSubgraphs() INTERNAL: Used for OX mapping.
int	hashCode()
protected boolean	hasName() INTERNAL: Return true is a name was provided through metadata.
boolean	includeAllAttributes() INTERNAL:
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) INTERNAL:
void	process(EntityAccessor entityAccessor) INTERNAL: Process the entity graph metadata.
void	setIncludeAllAttributes(java.lang.Boolean includeAllAttributes) INTERNAL: Used for OX mapping.
void	setName(java.lang.String name) INTERNAL: Used for OX mapping.
void	setNamedAttributeNodes(java.util.List<NamedAttributeNodeMetadata> attributeNodes) INTERNAL: Used for OX mapping.
void	setSubclassSubgraphs(java.util.List<NamedSubgraphMetadata> subclassSubgraphs) INTERNAL: Used for OX mapping.
void	setSubgraphs(java.util.List<NamedSubgraphMetadata> subgraphs) INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getIdentifier, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, merge, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object

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

Field Detail

m_name

protected java.lang.String m_name

m_includeAllAttributes

protected java.lang.Boolean m_includeAllAttributes

m_namedAttributeNodes

protected java.util.List<NamedAttributeNodeMetadata> m_namedAttributeNodes

m_subgraphs

protected java.util.List<NamedSubgraphMetadata> m_subgraphs

m_subclassSubgraphs

protected java.util.List<NamedSubgraphMetadata> m_subclassSubgraphs

Constructor Detail

NamedEntityGraphMetadata

public NamedEntityGraphMetadata()

INTERNAL: Used for XML loading.

NamedEntityGraphMetadata

public NamedEntityGraphMetadata(MetadataAnnotation namedEntityGraph,
                                EntityAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equals

public boolean equals(java.lang.Object objectToCompare)

INTERNAL: Used for XML merging and overriding.

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getIncludeAllAttributes

public java.lang.Boolean getIncludeAllAttributes()

INTERNAL: Used for OX mapping.

getName

public java.lang.String getName()

INTERNAL: Used for OX mapping.

getNamedAttributeNodes

public java.util.List<NamedAttributeNodeMetadata> getNamedAttributeNodes()

INTERNAL: Used for OX mapping.

getSubclassSubgraphs

public java.util.List<NamedSubgraphMetadata> getSubclassSubgraphs()

INTERNAL: Used for OX mapping.

getSubgraphs

public java.util.List<NamedSubgraphMetadata> getSubgraphs()

INTERNAL: Used for OX mapping.

includeAllAttributes

public boolean includeAllAttributes()

INTERNAL:

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class ORMetadata

hasName

protected boolean hasName()

INTERNAL: Return true is a name was provided through metadata.

process

public void process(EntityAccessor entityAccessor)

INTERNAL: Process the entity graph metadata.

setIncludeAllAttributes

public void setIncludeAllAttributes(java.lang.Boolean includeAllAttributes)

INTERNAL: Used for OX mapping.

setName

public void setName(java.lang.String name)

INTERNAL: Used for OX mapping.

setNamedAttributeNodes

public void setNamedAttributeNodes(java.util.List<NamedAttributeNodeMetadata> attributeNodes)

INTERNAL: Used for OX mapping.

setSubclassSubgraphs

public void setSubclassSubgraphs(java.util.List<NamedSubgraphMetadata> subclassSubgraphs)

INTERNAL: Used for OX mapping.

setSubgraphs

public void setSubgraphs(java.util.List<NamedSubgraphMetadata> subgraphs)

INTERNAL: Used for OX mapping.