Top Description Constructors Methods
org.eclipse.persistence.core.descriptors

public abstract Class CoreInheritancePolicy<ABSTRACT_RECORD extends CoreAbstractRecord, ABSTRACT_SESSION extends CoreAbstractSession, DESCRIPTOR extends CoreDescriptor<ATTRIBUTE_GROUP extends CoreAttributeGroup, DESCRIPTOR_EVENT_MANAGER extends CoreDescriptorEventManager, FIELD extends CoreField, INHERITANCE_POLICY extends CoreInheritancePolicy, INSTANTIATION_POLICY extends CoreInstantiationPolicy, LIST extends List<E>, OBJECT_BUILDER extends CoreObjectBuilder>, FIELD extends CoreField>

extends Object
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.descriptors.InheritancePolicy
Imports
java.util.List, .Map, org.eclipse.persistence.internal.core.helper.CoreField, org.eclipse.persistence.internal.core.sessions.CoreAbstractRecord, .CoreAbstractSession
INTERNAL A abstraction of inheritance policy capturing behavior common to all persistence types.

Constructor Summary

AccessConstructor and Description
protected
CoreInheritancePolicy()

Default constructor.

Method Summary

Modifier and TypeMethod and Description
public abstract void
addClassIndicatorFieldToRow(ABSTRACT_RECORD databaseRow)

INTERNAL: Add abstract class indicator information to the database row.

public abstract void
addClassNameIndicator(String childClassName, Object typeValue)

INTERNAL: Add the class name reference by class name, used by the MW.

public abstract Class<?>
classFromRow(ABSTRACT_RECORD record, ABSTRACT_SESSION session)

INTERNAL: This method is invoked only for the abstract descriptors.

public abstract List<DESCRIPTOR>
getAllChildDescriptors()

INTERNAL: Returns all the child descriptors, even descriptors for subclasses of subclasses.

public abstract FIELD
getClassIndicatorField()

INTERNAL: Returns field that the class type indicator is store when using inheritance.

public abstract String
getClassIndicatorFieldName()

PUBLIC: Return the class indicator field name.

public abstract Map<K, V>
getClassIndicatorMapping()

INTERNAL: Return the association of indicators and classes using specified ConversionManager

public abstract Map<K, V>
getClassNameIndicatorMapping()

INTERNAL: Return the mapping from class name to indicator, used by MW.

public abstract DESCRIPTOR
getDescriptor()

INTERNAL: Returns the descriptor which the policy belongs to.

public abstract Class<?>
getParentClass()

PUBLIC: Return the parent class.

public abstract DESCRIPTOR
getParentDescriptor()

INTERNAL: Return the parent descriptor.

public abstract boolean
hasClassExtractor()

INTERNAL:

public abstract boolean
isRootParentDescriptor()

INTERNAL: Return whether or not is root parent descriptor

public abstract void
setClassExtractorName(String classExtractorName)

ADVANCED: Set the class extractor class name.

public abstract void
setClassIndicatorField(FIELD classIndicatorField)

ADVANCED: To set the class indicator field.

public abstract void
setClassIndicatorMapping(Map<K, V> classIndicatorMapping)

PUBLIC: Set the association of indicators and classes.

public abstract void
setDescriptor(DESCRIPTOR descriptor)

INTERNAL: Set the descriptor.

public abstract void
setParentClassName(String parentClassName)

INTERNAL: Set the parent class name, used by MW to avoid referencing the real class for deployment XML generation.

public abstract void
setShouldReadSubclasses(Boolean shouldReadSubclasses)

INTERNAL: Set the descriptor to read instance of itself and its subclasses when queried.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

CoreInheritancePolicyback to summary
protected CoreInheritancePolicy()

Default constructor.

Method Detail

addClassIndicatorFieldToRowback to summary
public abstract void addClassIndicatorFieldToRow(ABSTRACT_RECORD databaseRow)

INTERNAL: Add abstract class indicator information to the database row. This is required when building a row for an insert or an update of a concrete child descriptor.

addClassNameIndicatorback to summary
public abstract void addClassNameIndicator(String childClassName, Object typeValue)

INTERNAL: Add the class name reference by class name, used by the MW.

classFromRowback to summary
public abstract Class<?> classFromRow(ABSTRACT_RECORD record, ABSTRACT_SESSION session)

INTERNAL: This method is invoked only for the abstract descriptors.

getAllChildDescriptorsback to summary
public abstract List<DESCRIPTOR> getAllChildDescriptors()

INTERNAL: Returns all the child descriptors, even descriptors for subclasses of subclasses. Required for bug 3019934.

getClassIndicatorFieldback to summary
public abstract FIELD getClassIndicatorField()

INTERNAL: Returns field that the class type indicator is store when using inheritance.

getClassIndicatorFieldNameback to summary
public abstract String getClassIndicatorFieldName()

PUBLIC: Return the class indicator field name. This is the name of the field in the table that stores what type of object this is.

getClassIndicatorMappingback to summary
public abstract Map<K, V> getClassIndicatorMapping()

INTERNAL: Return the association of indicators and classes using specified ConversionManager

getClassNameIndicatorMappingback to summary
public abstract Map<K, V> getClassNameIndicatorMapping()

INTERNAL: Return the mapping from class name to indicator, used by MW.

getDescriptorback to summary
public abstract DESCRIPTOR getDescriptor()

INTERNAL: Returns the descriptor which the policy belongs to.

getParentClassback to summary
public abstract Class<?> getParentClass()

PUBLIC: Return the parent class.

getParentDescriptorback to summary
public abstract DESCRIPTOR getParentDescriptor()

INTERNAL: Return the parent descriptor.

hasClassExtractorback to summary
public abstract boolean hasClassExtractor()

INTERNAL:

isRootParentDescriptorback to summary
public abstract boolean isRootParentDescriptor()

INTERNAL: Return whether or not is root parent descriptor

setClassExtractorNameback to summary
public abstract void setClassExtractorName(String classExtractorName)

ADVANCED: Set the class extractor class name. At descriptor initialize time this class will be converted to a Class and set as the ClassExtractor. This method is called from JPA.

See Also
setClassExtractor for more information on the ClassExtractor class.
setClassIndicatorFieldback to summary
public abstract void setClassIndicatorField(FIELD classIndicatorField)

ADVANCED: To set the class indicator field. This can be used for advanced field types, such as XML nodes, or to set the field type.

setClassIndicatorMappingback to summary
public abstract void setClassIndicatorMapping(Map<K, V> classIndicatorMapping)

PUBLIC: Set the association of indicators and classes. This may be desired to be used by clients in strange inheritance models.

setDescriptorback to summary
public abstract void setDescriptor(DESCRIPTOR descriptor)

INTERNAL: Set the descriptor.

setParentClassNameback to summary
public abstract void setParentClassName(String parentClassName)

INTERNAL: Set the parent class name, used by MW to avoid referencing the real class for deployment XML generation.

setShouldReadSubclassesback to summary
public abstract void setShouldReadSubclasses(Boolean shouldReadSubclasses)

INTERNAL: Set the descriptor to read instance of itself and its subclasses when queried. This is used with inheritance to configure the result of queries. By default this is true for root inheritance descriptors, and false for all others.