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

Class NamedSubgraphMetadata

java.lang.Object

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

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

public class NamedSubgraphMetadata
extends ORMetadata

Object to hold onto named sub 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 String	m_name
protected List<NamedAttributeNodeMetadata>	m_namedAttributeNodes
protected MetadataClass	m_type
protected String	m_typeName

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

m_project

Constructor Summary

Constructors

Constructor and Description
NamedSubgraphMetadata() INTERNAL: Used for XML loading.
NamedSubgraphMetadata(MetadataAnnotation namedSubgraph, ClassAccessor accessor) INTERNAL: Used for annotation loading.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) INTERNAL: Used for XML merging and overriding.
String	getIdentifier() INTERNAL: The unique identifier of named subgraph metadata.
String	getName() INTERNAL: Used for OX mapping.
List<NamedAttributeNodeMetadata>	getNamedAttributeNodes() INTERNAL: Used for OX mapping.
String	getTypeClassName() INTERNAL:
String	getTypeName() INTERNAL: Used for OX mapping.
int	hashCode()
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) INTERNAL:
void	process(Map<String,Map<String,AttributeGroup>> attributeGraphs) INTERNAL: Process the named subgraph metadata into a new attribute group.
void	processAttributeNodes(Map<String,Map<String,AttributeGroup>> attributeGraphs, AttributeGroup subgraph, AttributeGroup entityGraph) INTERNAL: Process the named subgraph metadata attribute nodes.
void	setName(String name) INTERNAL: Used for OX mapping.
void	setNamedAttributeNodes(List<NamedAttributeNodeMetadata> namedAttributeNodes) INTERNAL: Used for OX mapping.
void	setType(MetadataClass type) INTERNAL:
void	setTypeName(String typeName) INTERNAL: Used for OX mapping.

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

getAccessibleObject, getAccessibleObjectName, getAnnotation, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, 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 String m_name

m_type

protected MetadataClass m_type

m_typeName

protected String m_typeName

m_namedAttributeNodes

protected List<NamedAttributeNodeMetadata> m_namedAttributeNodes

Constructor Detail

NamedSubgraphMetadata

public NamedSubgraphMetadata()

INTERNAL: Used for XML loading.

NamedSubgraphMetadata

public NamedSubgraphMetadata(MetadataAnnotation namedSubgraph,
                             ClassAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL: Used for XML merging and overriding.

Specified by:

equals in class ORMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getIdentifier

public String getIdentifier()

INTERNAL: The unique identifier of named subgraph metadata.

Overrides:

getIdentifier in class ORMetadata

See Also:

ORMetadata.shouldOverride(ORMetadata), ORMetadata.mergeORObjects(ORMetadata, ORMetadata), ORMetadata.mergeORObjectLists(List, List)

getName

public String getName()

INTERNAL: Used for OX mapping.

getNamedAttributeNodes

public List<NamedAttributeNodeMetadata> getNamedAttributeNodes()

INTERNAL: Used for OX mapping.

getTypeClassName

public String getTypeClassName()

INTERNAL:

getTypeName

public String getTypeName()

INTERNAL: Used for OX mapping.

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class ORMetadata

process

public void process(Map<String,Map<String,AttributeGroup>> attributeGraphs)

INTERNAL: Process the named subgraph metadata into a new attribute group.

processAttributeNodes

public void processAttributeNodes(Map<String,Map<String,AttributeGroup>> attributeGraphs,
                                  AttributeGroup subgraph,
                                  AttributeGroup entityGraph)

INTERNAL: Process the named subgraph metadata attribute nodes.

setName

public void setName(String name)

INTERNAL: Used for OX mapping.

setNamedAttributeNodes

public void setNamedAttributeNodes(List<NamedAttributeNodeMetadata> namedAttributeNodes)

INTERNAL: Used for OX mapping.

setType

public void setType(MetadataClass type)

INTERNAL:

setTypeName

public void setTypeName(String typeName)

INTERNAL: Used for OX mapping.