oracle.jbo.server
Class EntityReference

java.lang.Object
  oracle.jbo.server.NamedObjectImpl
      oracle.jbo.server.ComponentObjectImpl
          oracle.jbo.server.EntityReference

All Implemented Interfaces:

Formattable, ComponentObject, Properties, VariableManagerOwner, VariableManagerOwnerBase

public class EntityReference
extends ComponentObjectImpl

Field Summary

static java.lang.Class	CLASS_INSTANCE
static byte	EFFDT_USAGE_NO_OVERRIDE
static byte	EFFDT_USAGE_OVERRIDE_FALSE
static int	FULL_OUTER_JOIN_TYPE
static int	INNER_JOIN_TYPE
static int	LEFT_OUTER_JOIN_TYPE
protected EntityDefImpl	mEOInfo
static int	NONE_JOIN_TYPE
static int	RIGHT_OUTER_JOIN_TYPE

Fields inherited from class oracle.jbo.server.NamedObjectImpl

mObjName, mParent, mProperties, mUserData, RES_ID_SUFFIX

Method Summary

protected ViewAttributeDefImpl	findViewAttrDefByEntityAttrName(java.lang.String name, AttributeDefImpl attr)
protected ViewAttributeDefImpl	findViewAttrDefByViewAttrName(java.lang.String name, AttributeDefImpl attr)
protected ViewAttributeDefImpl	findViewAttributeDefImpl(java.lang.String name)
protected ViewAttributeDefImpl	findViewAttributeDefImpl(java.lang.String name, AttributeDefImpl attr)
protected ArrayList	findViewAttributeDefImpls(AttributeDefImpl attr)
java.lang.String	formatForOutput(OutputFormatter formatter)
DefObject	getDef()
EntityDefImpl	getEntityDef()
int	getJoinType() Returns the join type if the Entity Reference participates in one.
java.lang.String	getJoinTypeAsString() Returns the join type as a String so that it can be used in SQL generation.
boolean	isEffectiveDated() Checks if the underlying entity is used in an effective dated fashion or not.
boolean	isEntireObjectTable()
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.

Methods inherited from class oracle.jbo.server.ComponentObjectImpl

addListener, applyPersonalization, create, createRef, ensureVariableManager, getAllProperties, getApplicationModule, getCompListeners, getCompListenersList, getDefFullName, getDefName, getMessageBundleClass, getResourceBundleDef, getRootApplicationModule, getVariableManager, hasVariables, isDead, remove, resolvePropertyRaw

Methods inherited from class oracle.jbo.server.NamedObjectImpl

formatChildCollectionForOutput, formatChildCollectionForOutput, formatChildCollectionForOutput, formatForOutput, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getResourcesFromBundle, getUserData, parseAttrArrayElements, refreshProperty, requiresNamePrefixedResId, setFullName, setName, setParent, setPropertiesMap, setProperty

Methods inherited from class java.lang.Object

equals, 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

CLASS_INSTANCE

public static final java.lang.Class CLASS_INSTANCE

NONE_JOIN_TYPE

public static final int NONE_JOIN_TYPE

See Also:

Constant Field Values

INNER_JOIN_TYPE

public static final int INNER_JOIN_TYPE

See Also:

Constant Field Values

LEFT_OUTER_JOIN_TYPE

public static final int LEFT_OUTER_JOIN_TYPE

See Also:

Constant Field Values

RIGHT_OUTER_JOIN_TYPE

public static final int RIGHT_OUTER_JOIN_TYPE

See Also:

Constant Field Values

FULL_OUTER_JOIN_TYPE

public static final int FULL_OUTER_JOIN_TYPE

See Also:

Constant Field Values

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

mEOInfo

protected EntityDefImpl mEOInfo

Method Detail

getEntityDef

public EntityDefImpl getEntityDef()

Returns:

The EntityDefImpl this references.

getDef

public DefObject getDef()

Returns:

The DefObject this references.

findViewAttrDefByViewAttrName

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

isReference

public boolean isReference()

Does this Referant Entity participate in the DML.

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.

findViewAttributeDefImpl

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

findViewAttrDefByEntityAttrName

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

findViewAttributeDefImpl

protected ViewAttributeDefImpl findViewAttributeDefImpl(java.lang.String name)

findViewAttributeDefImpls

protected ArrayList findViewAttributeDefImpls(AttributeDefImpl attr)

isReadOnly

public boolean isReadOnly()

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 java.lang.String getJoinTypeAsString()

Returns the join type as a String so that it can be used in SQL generation.

Returns:

a String object

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.

formatForOutput

public java.lang.String formatForOutput(OutputFormatter formatter)

Specified by:

formatForOutput in interface Formattable

Overrides:

formatForOutput in class NamedObjectImpl