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

public Class BatchFetchMetadata

extends ORMetadata
Class Inheritance
Imports
org.eclipse.persistence.annotations.BatchFetchType, org.eclipse.persistence.internal.jpa.metadata.ORMetadata, org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation, org.eclipse.persistence.mappings.ForeignReferenceMapping
INTERNAL: Object to represent the cascade types specified for a relationship mapping element. Key notes: - any metadata mapped from XML to this class must be compared in the equals 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.1

Field Summary

Modifier and TypeField and Description
private Integer
m_size

private String
m_type

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

Constructor Summary

AccessConstructor and Description
public
BatchFetchMetadata()

INTERNAL: Used for XML loading.

public
BatchFetchMetadata(MetadataAnnotation batchFetch, MetadataAccessor 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: For merging and overriding to work properly, all ORMetadata must be able to compare themselves for metadata equality.
public Integer
getSize()

INTERNAL: Used for OX mapping.

public String
getType()

INTERNAL: Used for OX mapping.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
process(ForeignReferenceMapping mapping)

INTERNAL: Process the batch fetch metadata for the given mapping.

public void
setSize(Integer size)

INTERNAL: Used for OX mapping.

public void
setType(String type)

INTERNAL: Used for OX mapping.

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

Field Detail

m_sizeback to summary
private Integer m_size
m_typeback to summary
private String m_type

Constructor Detail

BatchFetchMetadataback to summary
public BatchFetchMetadata()

INTERNAL: Used for XML loading.

BatchFetchMetadataback to summary
public BatchFetchMetadata(MetadataAnnotation batchFetch, MetadataAccessor 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.

Doc from org.eclipse.persistence.internal.jpa.metadata.ORMetadata.equals.

INTERNAL: For merging and overriding to work properly, all ORMetadata must be able to compare themselves for metadata equality. equals plays a big role in the shouldOverride() method from this class.

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
getSizeback to summary
public Integer getSize()

INTERNAL: Used for OX mapping.

getTypeback to summary
public String getType()

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
processback to summary
public void process(ForeignReferenceMapping mapping)

INTERNAL: Process the batch fetch metadata for the given mapping.

setSizeback to summary
public void setSize(Integer size)

INTERNAL: Used for OX mapping.

setTypeback to summary
public void setType(String type)

INTERNAL: Used for OX mapping.