|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) B32476-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.toplink.descriptors.InheritancePolicy
public class InheritancePolicy
Purpose: Allows customization of an object's inheritance. The primary supported inheritance model uses a class type indicator column in the table that stores the object's class type. The class-to-type mapping is specified on this policy. The full class name can also be used for the indicator instead of the mapping.
Each subclass can either share their parents table, or in addition add their own table(s).
For legacy models a customized inheritance class-extractor can be provided. This allows Java code to be used to compute the class type to use for a row. When this customized inheritance model is used an only-instances and with-all-subclasses filter expression may be required for concrete and branch querying.
Method Summary | |
---|---|
void |
addClassIndicator(java.lang.Class childClass,
java.lang.Object typeValue)
Add a class indicator for the root classes subclass. |
void |
dontReadSubclassesOnQueries()
Set the descriptor to only read instance of itself when queried. |
void |
dontUseClassNameAsIndicator()
Set the descriptor not to use the class' full name as the indicator. |
java.lang.String |
getClassExtractionMethodName()
ADVANCED: A class extraction method can be registered with the descriptor to override the default inheritance mechanism. |
ClassExtractor |
getClassExtractor()
ADVANCED: A class extractor can be registered with the descriptor to override the default inheritance mechanism. |
java.lang.String |
getClassIndicatorFieldName()
Return the class indicator field name. |
Expression |
getOnlyInstancesExpression()
ADVANCED: Return the 'only instances expression'. |
java.lang.Class |
getParentClass()
Return the parent class. |
java.lang.String |
getReadAllSubclassesViewName()
ADVANCED: The view can be used to optimize/customize the query for all subclasses where they have multiple tables. |
Expression |
getWithAllSubclassesExpression()
ADVANCED: Return the Expression which gets all subclasses. |
void |
readSubclassesOnQueries()
Set the descriptor to read instance of itself and its subclasses when queried. |
void |
setAlwaysUseOuterJoinForClassType(boolean choice)
Sets the inheritance policy to always use an outer join when quering across a relationship of class. |
void |
setClassExtractionMethodName(java.lang.String staticClassClassExtractionMethod)
ADVANCED: A class extraction method can be registered with the descriptor to override the default inheritance mechanism. |
void |
setClassExtractor(ClassExtractor classExtractor)
ADVANCED: A class extractor can be registered with the descriptor to override the default inheritance mechanism. |
void |
setClassIndicatorField(DatabaseField classIndicatorField)
ADVANCED: To set the class indicator field. |
void |
setClassIndicatorFieldName(java.lang.String fieldName)
To set the class indicator field name. |
void |
setClassIndicatorMapping(java.util.Map classIndicatorMapping)
Set the association of indicators and classes. |
void |
setOnlyInstancesExpression(Expression onlyInstancesExpression)
ADVANCED: Sets the expression used to select instance of the class only. |
void |
setParentClass(java.lang.Class parentClass)
Set the parent class. |
void |
setReadAllSubclassesViewName(java.lang.String readAllSubclassesViewName)
ADVANCED: The view can be used to optimize/customize the query for all subclasses where they have multiple tables. |
void |
setShouldOuterJoinSubclasses(boolean shouldOuterJoinSubclasses)
Set if an outer join should be used to read subclasses. |
void |
setShouldReadSubclasses(boolean shouldReadSubclasses)
Set the descriptor to read instance of itself and its subclasses when queried. |
void |
setShouldUseClassNameAsIndicator(boolean shouldUseClassNameAsIndicator)
Set if the descriptor uses the classes fully qualified name as the indicator. |
void |
setWithAllSubclassesExpression(Expression withAllSubclassesExpression)
ADVANCED: Sets the expression to be used for querying for a class and all its subclasses. |
boolean |
shouldAlwaysUseOuterJoin()
returns if the inheritance policy will always use an outerjoin when selecting class type |
boolean |
shouldOuterJoinSubclasses()
Return if an outer join should be used to read subclasses. |
boolean |
shouldReadSubclasses()
Return true if this descriptor should read instances of itself and subclasses on queries. |
boolean |
shouldUseClassNameAsIndicator()
Return true if the descriptor use the classes full name as the indicator. |
void |
useClassNameAsIndicator()
Set the descriptor to use the classes full name as the indicator. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public void addClassIndicator(java.lang.Class childClass, java.lang.Object typeValue)
public void dontReadSubclassesOnQueries()
public void dontUseClassNameAsIndicator()
public java.lang.String getClassExtractionMethodName()
setWithAllSubclassesExpression(Expression)
,
setOnlyInstancesExpression(Expression)
public ClassExtractor getClassExtractor()
setWithAllSubclassesExpression(Expression)
,
setOnlyInstancesExpression(Expression)
public void setClassExtractor(ClassExtractor classExtractor)
setWithAllSubclassesExpression(Expression)
,
setOnlyInstancesExpression(Expression)
public java.lang.String getClassIndicatorFieldName()
public Expression getOnlyInstancesExpression()
public java.lang.Class getParentClass()
public java.lang.String getReadAllSubclassesViewName()
public Expression getWithAllSubclassesExpression()
public void readSubclassesOnQueries()
public void setClassExtractionMethodName(java.lang.String staticClassClassExtractionMethod)
setWithAllSubclassesExpression(Expression)
,
setOnlyInstancesExpression(Expression)
public void setClassIndicatorField(DatabaseField classIndicatorField)
public void setClassIndicatorFieldName(java.lang.String fieldName)
public void setClassIndicatorMapping(java.util.Map classIndicatorMapping)
public void setOnlyInstancesExpression(Expression onlyInstancesExpression)
public void setParentClass(java.lang.Class parentClass)
public void setReadAllSubclassesViewName(java.lang.String readAllSubclassesViewName)
public void setShouldReadSubclasses(boolean shouldReadSubclasses)
public void setShouldUseClassNameAsIndicator(boolean shouldUseClassNameAsIndicator)
public void setAlwaysUseOuterJoinForClassType(boolean choice)
public void setWithAllSubclassesExpression(Expression withAllSubclassesExpression)
public boolean shouldReadSubclasses()
public boolean shouldAlwaysUseOuterJoin()
public boolean shouldOuterJoinSubclasses()
public void setShouldOuterJoinSubclasses(boolean shouldOuterJoinSubclasses)
public boolean shouldUseClassNameAsIndicator()
public void useClassNameAsIndicator()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |