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

public Class NamedEntityGraphMetadata

extends ORMetadata
Class Inheritance
Imports
java.util.ArrayList, .HashMap, .List, .Map, org.eclipse.persistence.internal.jpa.metadata.MetadataLogger, .ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.classes.EntityAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings, org.eclipse.persistence.internal.localization.ExceptionLocalization, org.eclipse.persistence.queries.AttributeGroup
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.
Author
Guy Pelletier
Since
EclipseLink 2.5

Field Summary

Modifier and TypeField and Description
protected Boolean
m_includeAllAttributes

protected String
m_name

protected List<NamedAttributeNodeMetadata>
m_namedAttributeNodes

protected List<NamedSubgraphMetadata>
m_subclassSubgraphs

protected List<NamedSubgraphMetadata>
m_subgraphs

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
m_project

Constructor Summary

AccessConstructor and Description
public
NamedEntityGraphMetadata()

INTERNAL: Used for XML loading.

public
NamedEntityGraphMetadata(MetadataAnnotation namedEntityGraph, EntityAccessor accessor)

INTERNAL: Used for annotation loading.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL: Used for XML merging and overriding.
public Boolean
getIncludeAllAttributes()

INTERNAL: Used for OX mapping.

public String
getName()

INTERNAL: Used for OX mapping.

public List<NamedAttributeNodeMetadata>
getNamedAttributeNodes()

INTERNAL: Used for OX mapping.

public List<NamedSubgraphMetadata>
getSubclassSubgraphs()

INTERNAL: Used for OX mapping.

public List<NamedSubgraphMetadata>
getSubgraphs()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
protected boolean
hasName()

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

public boolean
includeAllAttributes()

INTERNAL:

public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:
public void
process(EntityAccessor entityAccessor)

INTERNAL: Process the entity graph metadata.

public void
setIncludeAllAttributes(Boolean includeAllAttributes)

INTERNAL: Used for OX mapping.

public void
setName(String name)

INTERNAL: Used for OX mapping.

public void
setNamedAttributeNodes(List<NamedAttributeNodeMetadata> attributeNodes)

INTERNAL: Used for OX mapping.

public void
setSubclassSubgraphs(List<NamedSubgraphMetadata> subclassSubgraphs)

INTERNAL: Used for OX mapping.

public void
setSubgraphs(List<NamedSubgraphMetadata> subgraphs)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.ORMetadata:
getAccessibleObjectgetAccessibleObjectNamegetAnnotationgetBoxedTypegetDatabaseTypeEnumgetEntityMappingsgetFullyQualifiedClassNamegetIdentifiergetJavaClassgetJavaClassNamegetLoadergetLocationgetLoggergetMetadataClassgetMetadataClassgetMetadataClassgetMetadataFactorygetNamegetPrimitiveClassForNamegetProjectgetTextgetXMLElementhasIdentifierhasTextinitXMLClassNameinitXMLObjectinitXMLObjectsinitXMLTextObjectloadedFromAnnotationloadedFromEclipseLinkXMLloadedFromXMLmergemergeORObjectListsmergeORObjectsmergeSimpleObjectsreloadEntityreloadMappedSuperclasssetAccessibleObjectsetEntityMappingssetFieldNamesetFieldNamesetProjectshouldOverridevaluesMatchvaluesMatch

Field Detail

m_includeAllAttributesback to summary
protected Boolean m_includeAllAttributes
m_nameback to summary
protected String m_name
m_namedAttributeNodesback to summary
protected List<NamedAttributeNodeMetadata> m_namedAttributeNodes
m_subclassSubgraphsback to summary
protected List<NamedSubgraphMetadata> m_subclassSubgraphs
m_subgraphsback to summary
protected List<NamedSubgraphMetadata> m_subgraphs

Constructor Detail

NamedEntityGraphMetadataback to summary
public NamedEntityGraphMetadata()

INTERNAL: Used for XML loading.

NamedEntityGraphMetadataback to summary
public NamedEntityGraphMetadata(MetadataAnnotation namedEntityGraph, EntityAccessor accessor)

INTERNAL: Used for annotation loading.

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Implements abstract org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL: Used for XML merging and overriding.

Parameters
objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getIncludeAllAttributesback to summary
public Boolean getIncludeAllAttributes()

INTERNAL: Used for OX mapping.

getNameback to summary
public String getName()

INTERNAL: Used for OX mapping.

getNamedAttributeNodesback to summary
public List<NamedAttributeNodeMetadata> getNamedAttributeNodes()

INTERNAL: Used for OX mapping.

getSubclassSubgraphsback to summary
public List<NamedSubgraphMetadata> getSubclassSubgraphs()

INTERNAL: Used for OX mapping.

getSubgraphsback to summary
public List<NamedSubgraphMetadata> getSubgraphs()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
hasNameback to summary
protected boolean hasName()

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

includeAllAttributesback to summary
public boolean includeAllAttributes()

INTERNAL:

initXMLObjectback to summary
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:

Annotations
@Override
processback to summary
public void process(EntityAccessor entityAccessor)

INTERNAL: Process the entity graph metadata.

setIncludeAllAttributesback to summary
public void setIncludeAllAttributes(Boolean includeAllAttributes)

INTERNAL: Used for OX mapping.

setNameback to summary
public void setName(String name)

INTERNAL: Used for OX mapping.

setNamedAttributeNodesback to summary
public void setNamedAttributeNodes(List<NamedAttributeNodeMetadata> attributeNodes)

INTERNAL: Used for OX mapping.

setSubclassSubgraphsback to summary
public void setSubclassSubgraphs(List<NamedSubgraphMetadata> subclassSubgraphs)

INTERNAL: Used for OX mapping.

setSubgraphsback to summary
public void setSubgraphs(List<NamedSubgraphMetadata> subgraphs)

INTERNAL: Used for OX mapping.