Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.4.0)

E10653-05

oracle.jbo.server
Class RowReference

java.lang.Object
  extended by oracle.jbo.common.NamedObjectImpl
      extended by oracle.jbo.server.NamedObjectImpl
          extended by oracle.jbo.server.ComponentObjectImpl
              extended by oracle.jbo.server.RowReference
All Implemented Interfaces:
ComponentObject, GenericHints, PersistentDefinition, OperationContainer, Properties, VariableManagerOwner, VariableManagerOwnerBase
Direct Known Subclasses:
EntityReference, ViewReference

public class RowReference
extends ComponentObjectImpl
implements PersistentDefinition

 NAME
      RowReference.java - Base class for view object bases.
 DESCRIPTION


 NOTES


 VERSION
 MODIFIED   (MM/DD/YY)
 


Field Summary
static byte EFFDT_USAGE_NO_OVERRIDE
           
static byte EFFDT_USAGE_OVERRIDE_FALSE
           
static java.lang.String EFFDT_USAGE_OVERRIDE_FALSE_STR
           
 
Fields inherited from class oracle.jbo.common.NamedObjectImpl
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX
 
Fields inherited from interface oracle.jbo.GenericHints
PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP
 
Method Summary
protected  ViewAttributeDefImpl findViewAttrDefByBaseAttrName(java.lang.String name, AttributeDefImpl attr)
           
protected  ViewAttributeDefImpl findViewAttrDefByViewAttrName(java.lang.String name, AttributeDefImpl attr)
           
protected  ViewAttributeDefImpl findViewAttributeDefImpl(java.lang.String name)
           
protected  java.util.ArrayList findViewAttributeDefImpls(AttributeDefImpl attr)
           
 DefObject getDef()
          Gets the Def Object.
 java.lang.String getDefXMLElementTag()
           
 java.lang.String getDefXMLNameSpace()
           
 int getJoinType()
          Returns the join type if the Entity Reference participates in one.
static int getJoinType(java.lang.String type)
           
static java.lang.String getJoinTypeAsString(int joinType)
          Returns the join type as a String so that it can be used in SQL generation.
 java.lang.String getXMLElementTag()
          Returns a piece of static info for the type of object this is invoked upon.
 boolean isDeleteParticipant()
          Does this Referant Entity participate in the Delete processing in this usage.
 boolean isEffectiveDated()
          Checks if the underlying entity is used in an effective dated fashion or not.
 boolean isEntireObjectTable()
           
 boolean isInsertParticipant()
          Does this Referant Entity participate in the Delete processing in this usage.
 boolean isLockParticipant()
          Does this Referant Entity participate in the Lock processing in this usage.
 boolean isReadOnly()
           
 boolean isReference()
          Does this Referant Entity participate in the DML.
 void setEntireObjectTable(boolean b)
           
 void setJoinType(int joinType)
          Set the type of join.
 void setReadOnly(boolean state)
          Set the Referant Entity to READ-ONLY entity usage
 void setReference(boolean state)
          Set the Referant Entity to REFERENCE-ONLY enable entity lookup on source key attribute change.
 void writeChildren(DefWriter jos)
          Writes the Object's children to the Persistent storage
 void writeContents(DefWriter jos)
          Objects should write their persistence output in this method
 void writeObject(DefWriter jos)
          Objects should write their persistence output in this method
 
Methods inherited from class oracle.jbo.server.ComponentObjectImpl
addListener, applyPersonalization, create, createRef, createVariableValueManager, ensureVariableManager, findOperationDefinitions, getAllProperties, getApplicationModule, getCompListeners, getCompListenersList, getDefFullName, getDefinitionManager, getDefName, getFullNameForPersDef, getHintValue, getLabel, getLabelPlural, getMessageBundleClass, getProxyClassName, getProxyClassName, getResourceBundleDef, getRootApplicationModule, getStringFromMessageBundle, getTooltip, getVariableManager, hasVariables, isDead, isPersonalized, isRegWithPiggyMan, remove, resolvePropertyRaw, setName, setParent, setProxyClassName
 
Methods inherited from class oracle.jbo.server.NamedObjectImpl
setParent, setPropertiesMap
 
Methods inherited from class oracle.jbo.common.NamedObjectImpl
allocatePropertyMap, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionsMap, getPropertyMap, getResourcesFromBundle, isPropertyExpression, mergePropertyMap, refreshProperty, removeProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setFullName, setPropertiesMap2, setProperty, setProperty, setPropertyExpression, setPropertyMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.jbo.ComponentObject
getFullName, getName
 
Methods inherited from interface oracle.jbo.Properties
getProperties, getProperty, getProperty, refreshProperty
 
Methods inherited from interface oracle.jbo.VariableManagerOwner
getName
 

Field Detail

EFFDT_USAGE_NO_OVERRIDE

public static final byte EFFDT_USAGE_NO_OVERRIDE
See Also:
Constant Field Values

EFFDT_USAGE_OVERRIDE_FALSE

public static final byte EFFDT_USAGE_OVERRIDE_FALSE
See Also:
Constant Field Values

EFFDT_USAGE_OVERRIDE_FALSE_STR

public static final java.lang.String EFFDT_USAGE_OVERRIDE_FALSE_STR
See Also:
Constant Field Values
Method Detail

getDef

public DefObject getDef()
Description copied from class: ComponentObjectImpl
Gets the Def Object.

Returns:
The DefObject this references.

isLockParticipant

public boolean isLockParticipant()
Does this Referant Entity participate in the Lock processing in this usage. TODO: Unless EntityReference objects are _only_ used by ViewDefImpl's this functionality should be inside of some QBI specific ER object.

Returns:
true if it does participate, false otherwise.

isDeleteParticipant

public boolean isDeleteParticipant()
Does this Referant Entity participate in the Delete processing in this usage. TODO: Unless EntityReference objects are _only_ used by ViewDefImpl's this functionality should be inside of some QBI specific ER object.

Returns:
true if it does participate, false otherwise.

isInsertParticipant

public boolean isInsertParticipant()
Does this Referant Entity participate in the Delete processing in this usage. TODO: Unless EntityReference objects are _only_ used by ViewDefImpl's this functionality should be inside of some QBI specific ER object.

Returns:
true if it does participate, false otherwise.

isEntireObjectTable

public boolean isEntireObjectTable()

setEntireObjectTable

public void setEntireObjectTable(boolean b)

setReference

public void setReference(boolean state)
Set the Referant Entity to REFERENCE-ONLY enable entity lookup on source key attribute change.

Parameters:
state - True to be REFERENCE, false otherwise.

setReadOnly

public void setReadOnly(boolean state)
Set the Referant Entity to READ-ONLY entity usage

Parameters:
state - True to be READONLY , false otherwise.

isReference

public boolean isReference()
Does this Referant Entity participate in the DML.

Returns:
true if it does participate, false otherwise.

findViewAttrDefByViewAttrName

protected ViewAttributeDefImpl findViewAttrDefByViewAttrName(java.lang.String name,
                                                             AttributeDefImpl attr)

findViewAttrDefByBaseAttrName

protected ViewAttributeDefImpl findViewAttrDefByBaseAttrName(java.lang.String name,
                                                             AttributeDefImpl attr)

findViewAttributeDefImpl

protected ViewAttributeDefImpl findViewAttributeDefImpl(java.lang.String name)

findViewAttributeDefImpls

protected java.util.ArrayList findViewAttributeDefImpls(AttributeDefImpl attr)

isReadOnly

public boolean isReadOnly()

writeObject

public void writeObject(DefWriter jos)
Description copied from interface: PersistentDefinition
Objects should write their persistence output in this method

Specified by:
writeObject in interface PersistentDefinition
Parameters:
jos - the Output storage for persistence

writeContents

public void writeContents(DefWriter jos)
Description copied from interface: PersistentDefinition
Objects should write their persistence output in this method

Specified by:
writeContents in interface PersistentDefinition
Parameters:
jos - the Output storage for persistence

writeChildren

public void writeChildren(DefWriter jos)
Description copied from interface: PersistentDefinition
Writes the Object's children to the Persistent storage

Specified by:
writeChildren in interface PersistentDefinition
Parameters:
jos - the Output storage for persistence

getXMLElementTag

public java.lang.String getXMLElementTag()
Description copied from interface: PersistentDefinition
Returns a piece of static info for the type of object this is invoked upon. Examples are PreparedStatements for insert, update, delete, and String containing a base the select statement for retrieving instances of this type through the SQLInputStream

Specified by:
getXMLElementTag in interface PersistentDefinition
Returns:
returns the Statement required to store in Persitent Storage. Incase of XML, it just returns the String. In the case of SQL a JDBC PreparedStatement is returned.

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()
Specified by:
getDefXMLElementTag in interface PersistentDefinition

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()
Specified by:
getDefXMLNameSpace in interface PersistentDefinition

setJoinType

public void setJoinType(int joinType)
Set the type of join. Valid values are the constants INNER_JOIN, LEFT_OUTER_JOIN, RIGHT_OUTER_JOIN and FULL_OUTER_JOIN. This setting is used to detect if the Entity Reference could be empty in a View Row. It does not effect the generation of SQL because it is done by the design time. For effecting the runtime SQL use the methods setFromClause and setWhereClause on the ViewDefImpl class.

Parameters:
joinType - The type of join

getJoinType

public int getJoinType()
Returns the join type if the Entity Reference participates in one.

Returns:
constant values NONE_JOIN_TYPE, INNER_JOIN_TYPE, LEFT_OUTER_JOIN_TYPE, RIGHT_OUTER_JOIN_TYPE or FULL_OUTER_JOIN_TYPE

getJoinTypeAsString

public static java.lang.String getJoinTypeAsString(int joinType)
Returns the join type as a String so that it can be used in SQL generation.

Returns:
a String object

getJoinType

public static int getJoinType(java.lang.String type)

isEffectiveDated

public boolean isEffectiveDated()
Checks if the underlying entity is used in an effective dated fashion or not. It is possible to query in all the effective dated entities irrespective of their start and end effective dates by turning off date effectivity in the usage. Once queried in, the entity will continue to exhibit its effective dated nature when updates are made.

Returns:
true if the usage is effective dated, otherwise.

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 1 (11.1.1.4.0)

E10653-05

Copyright © 1997, 2011, Oracle. All rights reserved.