Skip navigation links

oracle.jbo.server
Class ViewDefImpl

java.lang.Object
oracle.jbo.common.NamedObjectImpl
oracle.jbo.mom.DefinitionObject
oracle.jbo.mom.PersistableDefObject
oracle.jbo.server.DefObject
oracle.jbo.server.MetaObject
oracle.jbo.server.RowDef
oracle.jbo.server.ViewDefImpl

All Implemented Interfaces:

ResourceBundleOwner, ViewCriteriaManagerOwner, ExprValueSupplier, ExprWrappable, DefPersistable, PersistentDefinition, AttributeDependencyManager, OperationDefinitionContainer, StructureDef, VariableManagerOwner, VariableManagerOwnerBase, ViewCriteriaResolver, ViewDef

Direct Known Subclasses:

DCDataViewDef

public class ViewDefImpl

extends RowDef

implements StructureDef, ViewCriteriaResolver, ViewDef, ViewCriteriaManagerOwner

ViewDefImpl is the meta-object for View Object instances. It describes the View Object's structure.

A View Def can be created either through XML loading or programmatically. For the former, the client is expected to generate the XML file from design-time and make the file accessible from the classpath. When the client asks MetaObjectManager for the View Def, it finds the XML file, opens it, parses it, and builds a View Def from it.

When creating a View Def programmatically, the client is expected to start with

    ViewDefImpl viewDef = new ViewDefImpl("MyViewDef");
 

where "MyViewDef" is the name by which the View Def will identified by MetaObjectManager. This is the name that the client should pass when an API requires a View Def name, e.g., the defName parameter to ApplicationModule.createViewObject(String, String).

After instantiating the View Def, the client adds entity usages, attributes, etc. Then, he must resolve the definition object through resolveDefObject() and regsiter it with MetaObjectManager through RowDef.registerDefObject(). For a View Def created from an XML file, the client does not need to call these methods, as the framework calls them itself.

Here is an example code snippet:

    ViewDefImpl viewDef = new ViewDefImpl("MyViewDef");

    viewDef.addEntityUsage("MyEmpUsage", "testp.kava.VO3.si03mt.Emp",
                           false);  // false means it's not refOnly

    viewDef.setComponentClass(null);  // take the default ViewObjectImpl
    viewDef.setRowClass(null);  // take the default ViewRowImpl
    viewDef.setSelectClause("EmpUsage.EMPNO, EmpUsage.ENAME, EmpUsage.JOB, EmpUsage.DEPTNO");
    viewDef.setFromClause("EMP EmpUsage");

    viewDef.addEntityAttribute("MyEmpNum", "MyEmpUsage", "EmpNum", true);  // true is for persistent
    viewDef.addEntityAttribute("MyEmpName", "MyEmpUsage", "EmpName", true);
    viewDef.addEntityAttribute("MyEmpJob", "MyEmpUsage", "EmpJob", true);
    viewDef.addEntityAttribute("MyEmpDeptNum", "MyEmpUsage", "EmpDeptNum", true);

    viewDef.resolveDefObject();
    viewDef.registerDefObject();
 

Nested Class Summary

Nested classes/interfaces inherited from class oracle.jbo.mom.PersistableDefObject

PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType

Field Summary

static int	CLAUSE_ADDITIVE
static int	CLAUSE_GENERATE_RT
static java.lang.String	COMPOSITE_VIEW_OBJECT
static java.lang.String	COMPVO_BASE_VIEW_QUERIES_INLINED
static byte	PASSIVATE_DEFAULT
static byte	PASSIVATE_DISABLED
static byte	PASSIVATE_TRANISENTS_TOO

Fields inherited from class oracle.jbo.server.RowDef

mAliasName, mBindingStyle

Fields inherited from class oracle.jbo.server.MetaObject

mComponentClass

Fields inherited from class oracle.jbo.mom.DefinitionObject

DEF_MDS_CLIENT_KEY, DEF_SCOPE_PERS, DEF_SCOPE_SESSION, DEF_SCOPE_SHARED, mBaseDefObject, mExtendedDefObjects, mObjectResolved, PERSDEF_MDS_CLIENT_KEY, PROPERTY_EXPRMAP

Fields inherited from class oracle.jbo.common.NamedObjectImpl

mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX

Fields inherited from interface oracle.jbo.ViewDef

FULL_OUTER_JOIN_TYPE, INNER_JOIN_TYPE, LEFT_OUTER_JOIN_TYPE, NONE_JOIN_TYPE, RIGHT_OUTER_JOIN_TYPE

Fields inherited from interface oracle.jbo.mom.xml.DefPersistable

XML_STATEMENT

Constructor Summary

ViewDefImpl()
Constructs a ViewDefImpl.

ViewDefImpl(int defScope, java.lang.String name)

ViewDefImpl(int defScope, java.lang.String name, java.lang.String baseViewDefName)

ViewDefImpl(java.lang.String name)
Constructs a ViewDefImpl.

Method Summary

void	addAllEntityAttributes(java.lang.String entityUsageName)
void	addAllRowAttributes(java.lang.String rowRefName)
void	addApplyViewCriteriaNames(java.lang.String rowRefName, java.lang.String[] applyVCNames)
AttributeDefImpl	addEntityAttribute(java.lang.String attrName, java.lang.String entityUsageName, java.lang.String entityAttrName, boolean isPersistent) Adds the named attribute to the view definition.
void	addEntityUsage(java.lang.String usageName, java.lang.String entityDefName, boolean referenceOnly) Deprecated. since 9.0.3, use addEntityUsage() that takes readOnly flag as well.
void	addEntityUsage(java.lang.String usageName, java.lang.String entityDefName, boolean referenceOnly, boolean readOnly)
void	addEntityUsage(java.lang.String usageName, java.lang.String entityDefName, boolean referenceOnly, boolean readOnly, boolean deleteParticipant, java.lang.String assocName, java.lang.String assocEndName, java.lang.String srcUsageName, java.lang.String joinType) Adds an Entity Usage to the View Object Definition
void	addEntityUsage(java.lang.String usageName, java.lang.String entityDefName, boolean referenceOnly, boolean readOnly, java.lang.String assocName, java.lang.String assocEndName, java.lang.String srcUsageName)
void	addEntityUsage(java.lang.String usageName, java.lang.String entityDefName, boolean referenceOnly, java.lang.String assocName, java.lang.String assocEndName, java.lang.String srcUsageName) Deprecated. since 9.0.3, use addEntityUsage() that takes readOnly flag as well.
void	addListBindingDef(ListBindingDef cld)
void	addOperation(OperationDefinitionImpl opDef) Deprecated.
AttributeDef	addRowAttribute(java.lang.String attrName, java.lang.String rowRefName, java.lang.String baseAttrName)
void	addRowOperation(OperationDefinitionImpl opDef) Deprecated.
OperationDefinitionImpl	addRowScriptOperation(java.lang.String id, java.lang.String name, java.lang.String returnType, java.util.LinkedHashMap<java.lang.String,java.lang.String> params, java.lang.String body) Deprecated.
AttributeDefImpl	addRowSetViewAttribute(java.lang.String attrName, java.lang.String expression, java.lang.Class javaType)
OperationDefinitionImpl	addScriptOperation(java.lang.String id, java.lang.String name, java.lang.String returnType, java.util.LinkedHashMap<java.lang.String,java.lang.String> params, java.lang.String body) Deprecated.
OperationDefinitionImpl	addScriptRowOperation(java.lang.String id, java.lang.String name, java.lang.String returnType, java.util.LinkedHashMap<java.lang.String,java.lang.String> params, java.lang.String body) Deprecated.
AttributeDefImpl	addViewAttribute(java.lang.String attrName, java.lang.String expression, java.lang.Class javaType)
ViewAttributeDefImpl	addViewLinkAccessor(java.lang.String accName, java.lang.String viewLinkName, java.lang.Class javaType)
ViewAttributeDefImpl	addViewLinkAccessor(java.lang.String accName, java.lang.String viewLinkName, java.lang.Class javaType, boolean isReversed)
void	addViewUsage(java.lang.String usageName, java.lang.String viewDefName)
void	addViewUsage(java.lang.String usageName, java.lang.String viewDefName, java.lang.String viewLinkName, java.lang.String viewLinkEndName, java.lang.String srcUsageName)
java.lang.String	buildDefaultFrom() Generates a "from" clause based on the entity references in this View Definition.
java.lang.String	buildDefaultFrom(AttributeDef[] attrDefs, SQLBuilder builder, BaseViewCriteriaManagerImpl vcManager)
java.lang.String	buildDefaultFrom(SQLBuilder builder) Generates a "from" clause based on the entity references in this View Definition.
java.lang.String	buildDefaultFromAttrs(AttributeDef[] attrDefs, AttributeDef[] forcedAttrDefs, java.util.List addEntRefs, SQLBuilder builder, BaseViewCriteriaManagerImpl vcManager)
static java.lang.String	buildDefaultSelect(AttributeDef[] attrDefs)
static java.lang.String	buildDefaultSelect(AttributeDef[] attrDefs, AttributeDef[] forcedSelectAttrs)
protected KeyDef	createAltKey(java.lang.String keyName, int keyIndex, java.lang.String[] components)
protected ViewAttributeDefImpl	createAttributeDef() Internal use only.
static ViewDefImpl	createCompositeViewDef(int defScope, java.lang.String name)
ViewCriteria	createViewCriteria()
static ViewDefImpl	createViewDef(int defScope, java.lang.String defClassName)
void	criteriaChanged(ViewCriteria vc)
AttributeDef	findAttrDefByEntAttrDef(AttributeDef entAttrDef) Get an attribute definition for an entity attribute definition.
AttributeDef	findAttributeDef(java.lang.String attrName) Get an attribute definition by the attribute name.
static ViewDefImpl	findDefObject(java.lang.String viewDefName) Finds the ViewDefImpl from the list of Meta Objects.
static ViewDefImpl	findDefObjectNoSub(java.lang.String viewDefName) Finds the named View Object definition.
OperationDefinitionImpl	findOperationDefinition(java.lang.String id) Deprecated.
OperationDefinitionImpl	findRowOperationDefinition(java.lang.String id) Deprecated.
StructureDef	findStructureDefByName(java.lang.String structDefFullName)
ViewLinkDefImpl	findViewLinkDefImpl(ViewAttributeDefImpl attr)
protected void	finishedLoading()
byte	getAccessMode() Get the access mode for rows from the query.
static java.lang.String[]	getAllDefNames()
java.lang.String[]	getAllViewCriteriaNames()
ViewCriteria[]	getAllViewCriterias()
AttributeDefImpl[]	getAltKeyAttrDefs(int keyIndex)
AttributeDefImpl[]	getAltKeyAttrDefs(java.lang.String name)
int	getAttributeCount() Returns the number of defined attributes.
AttributeDef	getAttributeDef(int index) Gets an attribute definition, given its index.
protected AttributeDefImpl[]	getAttributeDefImpls() Gets an array of attribute definitions in this View Def.
AttributeDef[]	getAttributeDefs() Gets an array of attribute definitions in this View Def.
java.lang.Class	getBaseComponentClass()
int	getCalculatedAttributeCount()
java.lang.String	getClientProxyClassName()
java.lang.String	getColumnNameForQuery(int index)
int	getColumns()
java.lang.Class	getComponentClass()
java.lang.String	getComponentInterfaceName()
protected ComponentOperations	getComponentOperations() Deprecated.
java.util.HashMap<java.lang.String,java.util.HashMap>	getCtrlHints(java.util.List<java.lang.String> attrNames, java.lang.String localeName, ViewRowImpl viewRow)
SortCriteria[]	getDBSortCriteria()
static byte	getDefaultFetchMode()
ViewCriteria	getDefaultViewCriteria()
int	getDefTypeId()
java.lang.String	getDefXMLElementTag()
java.util.HashMap<java.lang.String,java.util.HashMap>	getDfltCtrlHints(java.util.List<java.lang.String> attrNames, java.lang.String localeName)
protected java.lang.String	getEffectiveClientProxyClassName()
protected java.lang.String	getEffectiveComponentInterfaceName()
AttributeDefImpl	getEffectiveDateTransientAttr() Retuns the Attribute definition that stores the Effective Date value in a row.
protected AttributeDefImpl	getEffectiveDateTransientAttrInternal()
protected java.lang.String	getEffectiveDateTransientAttrName()
protected java.lang.String	getEffectiveRowClientProxyClassName()
java.lang.String	getEJBAppProviderURL()
java.lang.Object	getEJBHome()
java.lang.String	getEJBHomeJNDIName()
protected AttributeDefImpl[]	getEntityDiscrColumns()
int	getEntityIndex(EntityReference entityRef)
protected EntityReference	getEntityReference(int index)
EntityReference	getEntityReference(java.lang.String name) Returns the EntityReference of the given name.
protected EntityReference[]	getEntityReferences() Returns an array of EntityReference's upon which this ViewObject is based.
protected EntityReference[]	getEntityReferences(AttributeDef[] attrDefs) Returns an array of EntityReference's upon which this ViewObject is based.
EntityReference[]	getEntityRefsParentOrder()
EntityReference	getEntityUsage(java.lang.String name)
EntityReference[]	getEntityUsages()
byte	getFetchMode() Get the fetch mode for rows from the query.
short	getFetchSize() Get the size of the fetch.
java.lang.String	getFromClause() Returns the from clause associated with this View Definition.
java.lang.String	getFromClause(SQLBuilder builder) Returns the from clause associated with this View Definition.
int	getFromClauseFlags()
java.lang.String	getHintValue(LocaleContext locale, java.lang.String sHintName)
int	getIterMode()
ViewDefImpl	getListBindingViewDef()
int	getMaxActiveNodes()
static int	getMaxAttrConst(java.lang.String viewDefName)
int	getMaxFetchSize()
int	getMaxRowsPerNode()
OperationDefinitionsImpl	getOperationDefinitions() Deprecated.
java.lang.String	getOrderByClause()
protected AttributeDefImpl[]	getPrimaryKeys()
java.lang.Object	getProperty(java.lang.String hintName) Retrieves the specified property, if it exists.
java.lang.String	getQuery() Returns the query set via setQuery or via expert mode query at designtime.
java.lang.String	getQueryHint()
int	getRangePagingCacheFactor() Get the range paging cache factor.
int	getRangeSize()
AttributeDef[]	getRawAttributeDefs(boolean procAccessors)
ViewCriteria	getReqdVC()
java.lang.Class	getRowClass()
java.lang.String	getRowClientProxyClassName()
java.lang.String	getRowInterfaceName()
java.lang.String	getRowMatch()
OperationDefinitionsImpl	getRowOperationDefinitions() Deprecated.
int	getRows()
java.lang.String	getSdoName()
java.lang.String	getSdoNameSpace()
java.lang.String	getSDOPackageName()
java.lang.String	getSelectClause()
int	getSelectClauseFlags()
java.util.List<java.lang.String>	getSIFContextKey()
protected static java.lang.String	getStaticListCellId(java.lang.String voClassPath, int row, int col)
java.lang.String	getStoredProcedureName()
protected VariableValueManager[]	getVarMgrParents()
ViewCriteria	getViewCriteria(java.lang.String name)
ViewCriteriaManager	getViewCriteriaManager()
AttributeDefImpl[]	getViewKeyAttrDefs(ViewKeyDef viewKeyDef)
java.lang.String	getWhereClause()
protected StmtWithBindVars	getWhereClause(AttributeDef[] attrDefs, int noBindVars, SQLBuilder builder)
java.lang.String	getWhereClause(SQLBuilder builder)
int	getWhereClauseFlags()
java.lang.String	getXMLElementTag() Returns a piece of static info for the type of object this is invoked upon.
java.lang.String	getXMLRowElementTag()
boolean	hasDataSecurity()
protected boolean	hasPrimaryEntity()
boolean	hasQuery()
boolean	hasVariables() Returns a flag indicating whether this object has Variables or not.
boolean	isAutoRefreshEnabled()
boolean	isComposite()
protected boolean	isDynamic()
boolean	isEffectiveDated() Tests if the row definition corresponds to an Effective Dated object.
boolean	isFinderView()
boolean	isFullSql()
boolean	isManageRowsByKey()
boolean	isPassivationEnabled()
boolean	isPLSQLView() A View Object is PLSQL view if it is defined as PL/SQL view object.
boolean	isQueryThruEntity()
boolean	isReadOnly() A view is readonly if it does not have primary keys or all its entity references are reference-only.
boolean	isRuntimeSQLGeneration()
boolean	isSdoDirty()
boolean	isSdoGen()
boolean	isSDOGeneric()
boolean	isSelectAllAttributes()
boolean	isServiceWarningsEnabled()
boolean	isStatic() A View Object is static if it is defined as static.
boolean	isUseGlueCode()
boolean	isViewLinkAccessorRetained()
protected void	loadCustomDef(DefElement xmlElement)
protected static void	loadFromXML(DefElement xmlElement, oracle.jbo.server.RemotableCompDef defObj)
protected void	loadOperationDefinitions(DefElement xmlElement) For internal framework use only.
void	loadXMLContents(DefElement xmlElement, java.lang.String fullName)
AttributeDef	lookupAttributeDef(java.lang.String attrName) Gets an attribute definition by name.
OperationDefinitionImpl	lookupOperationDefinition(java.lang.String id) Deprecated.
OperationDefinitionImpl	lookupRowOperationDefinition(java.lang.String id) Deprecated.
ViewAccessorDef	lookupViewAccessorDef(java.lang.String name)
void	putPDefViewCriteria(java.lang.String name, PDefViewCriteria pdvcriteria)
void	putViewCriteria(java.lang.String name, ViewCriteria criteria)
void	removeOperation(OperationDefinitionImpl opDef) Deprecated.
void	removeRowOperation(OperationDefinitionImpl opDef) Deprecated.
void	resolveDefObject() Resolves this View Def.
protected void	resolveReferences() Since this gets called from lazyload
void	setAccessMode(byte accessMode) Set the access mode for rows from the query.
void	setAutoRefresh(boolean flag)
void	setClientProxyClassName(java.lang.String name)
void	setColumns(int i)
void	setComponentClass(java.lang.Class refClass)
void	setComponentInterfaceName(java.lang.String interfaceName)
void	setDBSortCriteria(SortCriteria[] sortCriteria)
protected void	setDefForComponent(ComponentObjectImpl comp)
void	setEffectiveDated(boolean b)
protected void	setEntityDiscrColumns(AttributeDefImpl[] entityDiscrCols)
void	setFetchMode(byte fetchMode) Set the fetch mode for rows from the query.
void	setFetchSize(short size) Set the size of the fetch.
void	setFromClause(java.lang.String fromClause)
void	setFromClauseFlags(int flags)
void	setFullSql(boolean b)
void	setIterMode(int iterMode)
void	setJoinType(java.lang.String usageName, int joinType)
void	setMaxActiveNodes(int maxActiveNodes)
void	setMaxFetchSize(int size) Set the maximum number of rows to fetch during query processing.
void	setMaxRowsPerNode(int maxRowsPerNode)
void	setOrderByClause(java.lang.String orderByClause)
protected void	setPassivationMode(byte passivationMode)
void	setQuery(java.lang.String query) Sets the string for a user-defined query.
void	setQueryHint(java.lang.String queryHint)
void	setRangePagingCacheFactor(int factor) Set the range paging cache factor.
void	setRangeSize(int r)
void	setReqdVC(ViewCriteria vc)
void	setRowClass(java.lang.Class rowClass)
protected void	setRowClientProxyClassName(java.lang.String name)
protected void	setRowInterfaceName(java.lang.String name)
void	setRowMatch(java.lang.String rowMatch)
void	setRows(int i)
void	setSdoDirty(boolean b)
void	setSdoGen(boolean value)
void	setSdoName(java.lang.String value)
void	setSdoNameSpace(java.lang.String value)
void	setSelectAllAttributes(boolean val)
void	setSelectClause(java.lang.String selectClause)
void	setSelectClauseFlags(int flags)
void	setServiceWarnings(boolean value)
protected void	setStoredProcedureName(java.lang.String name)
void	setupForLov(ViewObjectImpl vo) Deprecated.
void	setUseGlueCode(boolean b)
void	setViewLinkAccessorRetained(boolean b)
void	setWhereClause(java.lang.String whereClause)
void	setWhereClauseFlags(int flags)
boolean	shouldPutJoinConstraintInWhereClause()
protected void	unsetDefForComponent(ComponentObjectImpl comp)
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

Methods inherited from class oracle.jbo.server.RowDef

addAltKey, addExtendedDefObject, addForwardDependency, addForwardDependency, addListBindingDef, addViewAccessorDef, appendBindingNameForAttr, appendBindingSpec, appendBindingSpec, createDef, discrValuesQualify, findAltKeyDef, findAttrDefIncludingPDef, findDefForDiscrValues, findListBindingDef, findViewAccessorDef, getAliasName, getAllProperties, getAltKeyCount, getAltKeyDef, getAltKeyIndex, getAltKeyNames, getAttributeIndexOf, getBackwardDependencies, getBackwardDependencyAttributes, getBindingStyle, getDataSourceDef, getDefFullName, getDefName, getDiscrColumns, getExprVarVal, getForwardDependencies, getForwardDependencyAttributes, getListBindingDefs, getViewAccessorDefs, loadListBindings, loadViewAccessor, loadViewAccessors, lookupAltKeyDef, lookupListBindingDef, registerDefObject, removeAltKey, removeListBindingDef, removeViewAccessorDef, resolvePropertyRaw, setAliasName, setBindingStyle, setDiscrColumns, setExprVarVal, setThrowOnListBindingMismatch, throwOnListBindingMismatch, verifyExtendedDefObjects, writeXMLContents

Methods inherited from class oracle.jbo.server.MetaObject

deregisterSessionObject, getMessageBundleClass, getMsgBundleDef, getPackageDef, getPackageName, getPersDef, getPersDefNoUpdateCheck, getResourceBundleDef, getResourcePrefix, loadResourceBundle, registerSessionDefObject, setMessageBundleClass, setResourceBundleDef

Methods inherited from class oracle.jbo.server.DefObject

ensureVariableManager, getBaseDefObject, getDefXMLNameSpace, getVariableManager, loadProperties, loadVariables, setBaseDefObject, setBaseDefObject, setName, setParent

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addDefImport, allocatePropertyMap, checkEditable, close, createFromXML, findDefImport, getBaseDir, getBasePackage, getDefImports, getDefManager, getDefWriter, getEditObject, getExtendedDefObjectsInternal, getFileName, getFullDirName, getFullFileName, getOrigObject, getPropertyMap, getSubstitutedNames, guaranteePath, hasExtendedDefObjects, isCustomizationEnabled, isCustomizationEnabled, isDirty, isEditable, isNew, isPersonalizationEnabled, isPersonalizationEnabled, loadDefImports, mergePropertyMap, objectRemoved, registerClass, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setEditable, setNew, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, updateChildrenList, verifyVersion, writeObject, writeVersion

Methods inherited from class oracle.jbo.mom.DefinitionObject

addPropertySetName, enableUpdateCheck, getContainerDef, getContainerName, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, isBaseDefFor, isDynamicDefinitionObject, isObjectResolved, isSuppressUpdateCheck, loadCustomProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, setDefScope, setMdsKey, setMdsReference, setObjectResolved, setPropertySetName, suppressUpdateCheck

Methods inherited from class oracle.jbo.common.NamedObjectImpl

getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getPropertyExpressionsMap, getResourcesFromBundle, getStringFromMessageBundle, isPropertyExpression, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setFullName, setPropertiesMap, setPropertiesMap2, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.jbo.ViewDef

registerDefObject, saveXMLContents, setDefaultBaseDir, writeXMLContents

Methods inherited from interface oracle.jbo.StructureDef

getAttributeIndexOf, getDefFullName, getDefName, getFullName, getName

Methods inherited from interface oracle.jbo.VariableManagerOwner

getName

Methods inherited from interface oracle.jbo.mom.xml.DefPersistable

getFullName

Field Detail

CLAUSE_GENERATE_RT

public static final int CLAUSE_GENERATE_RT

See Also:

Constant Field Values

CLAUSE_ADDITIVE

public static final int CLAUSE_ADDITIVE

See Also:

Constant Field Values

PASSIVATE_DEFAULT

public static final byte PASSIVATE_DEFAULT

See Also:

Constant Field Values

PASSIVATE_TRANISENTS_TOO

public static final byte PASSIVATE_TRANISENTS_TOO

See Also:

Constant Field Values

PASSIVATE_DISABLED

public static final byte PASSIVATE_DISABLED

See Also:

Constant Field Values

COMPOSITE_VIEW_OBJECT

public static final java.lang.String COMPOSITE_VIEW_OBJECT

See Also:

Constant Field Values

COMPVO_BASE_VIEW_QUERIES_INLINED

public static final java.lang.String COMPVO_BASE_VIEW_QUERIES_INLINED

See Also:

Constant Field Values

Constructor Detail

ViewDefImpl

public ViewDefImpl()

Constructs a ViewDefImpl.

ViewDefImpl

public ViewDefImpl(int defScope,
                   java.lang.String name)

ViewDefImpl

public ViewDefImpl(java.lang.String name)

Constructs a ViewDefImpl. This constructor should be used when creating a View Def programmatically. See above for further discussion.

Parameters:

name - name by which this View Def will be registered in MetaObjectManager.

ViewDefImpl

public ViewDefImpl(int defScope,
                   java.lang.String name,
                   java.lang.String baseViewDefName)

Method Detail

getDefaultFetchMode

public static byte getDefaultFetchMode()

getAllDefNames

public static java.lang.String[] getAllDefNames()

findDefObjectNoSub

public static ViewDefImpl findDefObjectNoSub(java.lang.String viewDefName)

Finds the named View Object definition. Performs essentially the same operation as findDefObject, except that it does not observe meta-object substitution.

Parameters:

viewObjectName - The fully qualified Name of the ViewDefImpl.

Returns:

The View definition object corresponding to the specified name.

See Also:

MetaObjectManager

findDefObject

public static ViewDefImpl findDefObject(java.lang.String viewDefName)

Finds the ViewDefImpl from the list of Meta Objects.

Parameters:

viewDefName - The fully qualified Name of the ViewDefImpl.

Returns:

The View definition object corresponding to the specified name.

See Also:

MetaObjectManager

createCompositeViewDef

public static ViewDefImpl createCompositeViewDef(int defScope,
                                                 java.lang.String name)

getMaxAttrConst

public static int getMaxAttrConst(java.lang.String viewDefName)

isComposite

public boolean isComposite()

getAttributeDefImpls

protected AttributeDefImpl[] getAttributeDefImpls()

Gets an array of attribute definitions in this View Def.

Specified by:

getAttributeDefImpls in class RowDef

Returns:

an array of attribute definitions.

getAttributeDefs

public AttributeDef[] getAttributeDefs()

Gets an array of attribute definitions in this View Def.

Specified by:

getAttributeDefs in interface StructureDef

Specified by:

getAttributeDefs in class RowDef

Returns:

an array of attribute definitions.

getRawAttributeDefs

public AttributeDef[] getRawAttributeDefs(boolean procAccessors)

Specified by:

getRawAttributeDefs in class RowDef

findAttributeDef

public AttributeDef findAttributeDef(java.lang.String attrName)

Get an attribute definition by the attribute name.

Specified by:

findAttributeDef in interface StructureDef

Specified by:

findAttributeDef in class RowDef

Parameters:

attrName - name of the attribute.

Returns:

the attribute definition.

Throws:

NoDefException - thrown if the named atribute is not found.

findAttrDefByEntAttrDef

public AttributeDef findAttrDefByEntAttrDef(AttributeDef entAttrDef)

Get an attribute definition for an entity attribute definition.

Parameters:

entAttrDef - entity attribute def

Returns:

the view attribute which is mapped to the entity attr. null if not found.

lookupAttributeDef

public AttributeDef lookupAttributeDef(java.lang.String attrName)

Gets an attribute definition by name.

Specified by:

lookupAttributeDef in interface AttributeDependencyManager

Specified by:

lookupAttributeDef in interface StructureDef

Specified by:

lookupAttributeDef in class RowDef

Parameters:

attrName - the name of an AttributeDef.

Returns:

an attribute definition, or null if not found.

getEntityUsages

public EntityReference[] getEntityUsages()

getEntityReferences

protected EntityReference[] getEntityReferences()

Returns an array of EntityReference's upon which this ViewObject is based. Each EntityReference refers to EntityDef that describes the Entity.

Returns:

the EntityReference array.

getEntityReferences

protected EntityReference[] getEntityReferences(AttributeDef[] attrDefs)

Returns an array of EntityReference's upon which this ViewObject is based. Each EntityReference refers to EntityDef that describes the Entity. Only return the EntityDef's that are not hidden

Returns:

the EntityReference array.

getEntityRefsParentOrder

public EntityReference[] getEntityRefsParentOrder()

isManageRowsByKey

public boolean isManageRowsByKey()

getEntityUsage

public EntityReference getEntityUsage(java.lang.String name)

getEntityReference

public EntityReference getEntityReference(java.lang.String name)

Returns the EntityReference of the given name. name is the Entity usage name of this ViewObject's Entity base.

If no matching EntityReference is found, it returns null.

Parameters:

name - the Entity usage name.

Returns:

the EntityReference. null if no matching Entity usage is found.

getEntityReference

protected EntityReference getEntityReference(int index)

Returns:

The EntityReference of the given index.

getEntityDiscrColumns

protected AttributeDefImpl[] getEntityDiscrColumns()

setEntityDiscrColumns

protected void setEntityDiscrColumns(AttributeDefImpl[] entityDiscrCols)

getQuery

public java.lang.String getQuery()

Returns the query set via setQuery or via expert mode query at designtime. Returns null otherwise.

setQuery

public void setQuery(java.lang.String query)

Sets the string for a user-defined query. Note that the flag isFullSql is set to true if this call is used to set a non-null value. If the parameter is null, then the isFullSql flag is set to false, so that the component parts of the SQL can be set with the setSelectClause(), setFromClause(), and setWhereClause() methods.

Parameters:

query - The sql statement of the query.

setQueryHint

public void setQueryHint(java.lang.String queryHint)

getQueryHint

public java.lang.String getQueryHint()

setRowMatch

public void setRowMatch(java.lang.String rowMatch)

getRowMatch

public java.lang.String getRowMatch()

findStructureDefByName

public StructureDef findStructureDefByName(java.lang.String structDefFullName)

Specified by:

findStructureDefByName in interface ViewCriteriaResolver

shouldPutJoinConstraintInWhereClause

public boolean shouldPutJoinConstraintInWhereClause()

Specified by:

shouldPutJoinConstraintInWhereClause in interface ViewCriteriaManagerOwner

getViewCriteriaManager

public ViewCriteriaManager getViewCriteriaManager()

Specified by:

getViewCriteriaManager in interface ViewCriteriaManagerOwner

criteriaChanged

public void criteriaChanged(ViewCriteria vc)

Specified by:

criteriaChanged in interface ViewCriteriaManagerOwner

getDefaultViewCriteria

public ViewCriteria getDefaultViewCriteria()

getAllViewCriteriaNames

public java.lang.String[] getAllViewCriteriaNames()

Returns:

a list with all criteria names available in this definition

getAllViewCriterias

public ViewCriteria[] getAllViewCriterias()

getViewCriteria

public ViewCriteria getViewCriteria(java.lang.String name)

putViewCriteria

public void putViewCriteria(java.lang.String name,
                            ViewCriteria criteria)

putPDefViewCriteria

public void putPDefViewCriteria(java.lang.String name,
                                PDefViewCriteria pdvcriteria)

getEntityIndex

public int getEntityIndex(EntityReference entityRef)

Returns:

The index of an EntityReference in this object.

getCalculatedAttributeCount

public int getCalculatedAttributeCount()

Returns:

Count of calculated attributes

getPrimaryKeys

protected AttributeDefImpl[] getPrimaryKeys()

Specified by:

getPrimaryKeys in class RowDef

Returns:

A list of primary keys.

getAltKeyAttrDefs

public AttributeDefImpl[] getAltKeyAttrDefs(java.lang.String name)

Overrides:

getAltKeyAttrDefs in class RowDef

getAltKeyAttrDefs

public AttributeDefImpl[] getAltKeyAttrDefs(int keyIndex)

Overrides:

getAltKeyAttrDefs in class RowDef

getAttributeCount

public int getAttributeCount()

Description copied from class: RowDef

Returns the number of defined attributes.

Specified by:

getAttributeCount in interface StructureDef

Specified by:

getAttributeCount in class RowDef

Returns:

The number of attributes.

getAttributeDef

public AttributeDef getAttributeDef(int index)

Description copied from class: RowDef

Gets an attribute definition, given its index.

Specified by:

getAttributeDef in interface StructureDef

Specified by:

getAttributeDef in class RowDef

Parameters:

index - the index of an AttributeDef, where the leftmost attribute has index zero.

Returns:

an attribute definition.

getColumnNameForQuery

public java.lang.String getColumnNameForQuery(int index)

Specified by:

getColumnNameForQuery in interface StructureDef

setRowClass

public void setRowClass(java.lang.Class rowClass)

Parameters:

rowClass - The Class of the instance.

getRowClass

public java.lang.Class getRowClass()

Specified by:

getRowClass in class RowDef

Returns:

The Class of the instance.

getRowClientProxyClassName

public java.lang.String getRowClientProxyClassName()

setRowClientProxyClassName

protected void setRowClientProxyClassName(java.lang.String name)

getRowInterfaceName

public java.lang.String getRowInterfaceName()

setRowInterfaceName

protected void setRowInterfaceName(java.lang.String name)

getStoredProcedureName

public java.lang.String getStoredProcedureName()

setStoredProcedureName

protected void setStoredProcedureName(java.lang.String name)

getEffectiveRowClientProxyClassName

protected java.lang.String getEffectiveRowClientProxyClassName()

getBaseComponentClass

public java.lang.Class getBaseComponentClass()

Returns:

the Class of the reference object.

getSelectClauseFlags

public int getSelectClauseFlags()

setSelectClauseFlags

public void setSelectClauseFlags(int flags)

getFromClauseFlags

public int getFromClauseFlags()

setFromClauseFlags

public void setFromClauseFlags(int flags)

getWhereClauseFlags

public int getWhereClauseFlags()

setWhereClauseFlags

public void setWhereClauseFlags(int flags)

getSelectClause

public java.lang.String getSelectClause()

Returns:

The SELECT list

setSelectClause

public void setSelectClause(java.lang.String selectClause)

Parameters:

selectClause - The SELECT list

getFromClause

public java.lang.String getFromClause()

Returns the from clause associated with this View Definition. If the clause is configured to be generated at runtime, it is constructed based on the entity references. See setFromClauseFlags(int). Use the getFromClause(SQLBuilder) API if a SQLBuilder is available for the Database platform that you are working against.

Returns:

The "from" clause

getFromClause

public java.lang.String getFromClause(SQLBuilder builder)

Returns the from clause associated with this View Definition. If the clause is configured to be generated at runtime, it is constructed based on the entity references. See setFromClauseFlags(int).

Parameters:

builder - The SQLBuilder abstracts the actual database specific syntax generation.

Returns:

The "from" clause

getReqdVC

public ViewCriteria getReqdVC()

setReqdVC

public void setReqdVC(ViewCriteria vc)

setFromClause

public void setFromClause(java.lang.String fromClause)

Parameters:

fromClause - The FROM clause

getWhereClause

public java.lang.String getWhereClause()

getWhereClause

public java.lang.String getWhereClause(SQLBuilder builder)

getWhereClause

protected StmtWithBindVars getWhereClause(AttributeDef[] attrDefs,
                                          int noBindVars,
                                          SQLBuilder builder)

Returns:

The WHERE clause

setWhereClause

public void setWhereClause(java.lang.String whereClause)

Parameters:

whereClause - The WHERE clause

getOrderByClause

public java.lang.String getOrderByClause()

Returns:

The ORDER BY clause

setOrderByClause

public void setOrderByClause(java.lang.String orderByClause)

Specified by:

setOrderByClause in interface ViewDef

Parameters:

orderByClause - The ORDER BY clause

buildDefaultFrom

public java.lang.String buildDefaultFrom()

Generates a "from" clause based on the entity references in this View Definition. Use the buildDefaultFrom(SQLBuilder) API if a SQLBuilder is available for the Database platform that you are working against.

Returns:

The "from" clause

buildDefaultFrom

public java.lang.String buildDefaultFrom(SQLBuilder builder)

Generates a "from" clause based on the entity references in this View Definition.

Parameters:

builder - The SQLBuilder abstracts the actual database specific syntax generation.

Returns:

The "from" clause

buildDefaultFrom

public java.lang.String buildDefaultFrom(AttributeDef[] attrDefs,
                                         SQLBuilder builder,
                                         BaseViewCriteriaManagerImpl vcManager)

buildDefaultFromAttrs

public java.lang.String buildDefaultFromAttrs(AttributeDef[] attrDefs,
                                              AttributeDef[] forcedAttrDefs,
                                              java.util.List addEntRefs,
                                              SQLBuilder builder,
                                              BaseViewCriteriaManagerImpl vcManager)

getFetchMode

public byte getFetchMode()

Get the fetch mode for rows from the query. The value returned will be FETCH_AS_NEEDED or FETCH_ALL.

Returns:

FETCH_AS_NEEDED or FETCH_ALL.

setFetchMode

public void setFetchMode(byte fetchMode)

Set the fetch mode for rows from the query. The valid modes are FETCH_AS_NEEDED an FETCH_ALL, or FETCH_DEFAULT. FETCH_AS_NEEDED will only fetch the number of rows requested whilst FETCH_ALL will pull all of the rows from the database and close out the cursor. FETCH_DEFAULT means this view object will use the system-level default.

Parameters:

fetchMode - is FETCH_AS_NEEDED, FETCH_ALL or FETCH_DEFAULT.

getFetchSize

public short getFetchSize()

Get the size of the fetch.

Returns:

the size, in rows, of the chunk to fetch.

setFetchSize

public void setFetchSize(short size)

Set the size of the fetch. ViewRowSets of the query are returned in chunks. This method permits the setting of the size of these chunks.

Parameters:

size - the size, in rows, of the chunk to fetch.

getMaxFetchSize

public int getMaxFetchSize()

setMaxFetchSize

public void setMaxFetchSize(int size)

Set the maximum number of rows to fetch during query processing. When the maximum number of rows has been fetched, the query is closed and no more rows are returned. Setting a value of 0 means that there is no maximum to the number of rows fetched.

Parameters:

size - the number of rows.

isUseGlueCode

public boolean isUseGlueCode()

setUseGlueCode

public void setUseGlueCode(boolean b)

setMaxRowsPerNode

public void setMaxRowsPerNode(int maxRowsPerNode)

getMaxRowsPerNode

public int getMaxRowsPerNode()

setMaxActiveNodes

public void setMaxActiveNodes(int maxActiveNodes)

getMaxActiveNodes

public int getMaxActiveNodes()

getRangeSize

public int getRangeSize()

setRangeSize

public void setRangeSize(int r)

getAccessMode

public byte getAccessMode()

Get the access mode for rows from the query. The value returned will be: RowSet.SCROLLABLE, RowSet.FORWARD_ONLY, RowSet.RANGE_PAGING, RowSet.RANGE_PAGING_AUTO_POST, or RowSet.RANGE_PAGING_INCR.

Returns:

RowSet.SCROLLABLE, RowSet.FORWARD_ONLY, RowSet.RANGE_PAGING, RowSet.RANGE_PAGING_AUTO_POST, or RowSet.RANGE_PAGING_INCR.

setAccessMode

public void setAccessMode(byte accessMode)

Set the access mode for rows from the query. The valid modes are RowSet.SCROLLABLE, RowSet.FORWARD_ONLY, RowSet.RANGE_PAGING, RowSet.RANGE_PAGING_AUTO_POST, or RowSet.RANGE_PAGING_INCR.

Parameters:

accessMode - is RowSet.SCROLLABLE, RowSet.FORWARD_ONLY, RowSet.RANGE_PAGING, RowSet.RANGE_PAGING_AUTO_POST, or RowSet.RANGE_PAGING_INCR.

getRangePagingCacheFactor

public int getRangePagingCacheFactor()

Get the range paging cache factor.

Returns:

the range paging cache factor.

setRangePagingCacheFactor

public void setRangePagingCacheFactor(int factor)

Set the range paging cache factor. ViewRowSets of the query are returned in chunks. This method permits the setting of the size of these chunks.

Parameters:

factor - range paging cache factor.

hasPrimaryEntity

protected boolean hasPrimaryEntity()

Returns:

true if the View Object has primary Entity base.

finishedLoading

protected void finishedLoading()

Overrides:

finishedLoading in class DefObject

createViewDef

public static ViewDefImpl createViewDef(int defScope,
                                        java.lang.String defClassName)

resolveReferences

protected void resolveReferences()

Since this gets called from lazyload

Overrides:

resolveReferences in class DefObject

loadXMLContents

public void loadXMLContents(DefElement xmlElement,
                            java.lang.String fullName)

setPassivationMode

protected void setPassivationMode(byte passivationMode)

Parameters:

passivationMode - - Value of this argument must be among one of these 3 values ViewDefImpl.PASSIVATE_DEFAULT ViewDefImpl.PASSIVATE_TRANISENTS_TOO ViewDefImpl.PASSIVATE_DISABLED

For internal use only. Application developers should not use this

-- It's an advanced method and should not be modified for any def at will. Sets the passivation mode

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

Overrides:

writeChildren in class RowDef

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

resolveDefObject

public void resolveDefObject()

Resolves this View Def. It resolves attribute definitions with its entity bases.

This method must be called after the View Def is set up and before registerDefObject().

Specified by:

resolveDefObject in interface ViewDef

Specified by:

resolveDefObject in class MetaObject

createAltKey

protected KeyDef createAltKey(java.lang.String keyName,
                              int keyIndex,
                              java.lang.String[] components)

Specified by:

createAltKey in class RowDef

addAllEntityAttributes

public void addAllEntityAttributes(java.lang.String entityUsageName)

addViewLinkAccessor

public ViewAttributeDefImpl addViewLinkAccessor(java.lang.String accName,
                                                java.lang.String viewLinkName,
                                                java.lang.Class javaType)

addViewLinkAccessor

public ViewAttributeDefImpl addViewLinkAccessor(java.lang.String accName,
                                                java.lang.String viewLinkName,
                                                java.lang.Class javaType,
                                                boolean isReversed)

addEntityAttribute

public AttributeDefImpl addEntityAttribute(java.lang.String attrName,
                                           java.lang.String entityUsageName,
                                           java.lang.String entityAttrName,
                                           boolean isPersistent)

Adds the named attribute to the view definition. This attribute is mapped to an attribute in the entity reference, i.e., the attribute must exist in the underlying entity definition.

If isPersistent is true, the view object is to draw the data from its query statement. The underlying entity attribute may or may not be persistent. In this case, the attribute must have a valid database table column or expression in the view object's query statement. If there is a mismatch between the query statement and the VO attribute definition list, you may see AttributeLoadException or DataCreationException.

If the view attribute is marked not persistent and if the underlying entity attribute is transient, the view attribute will be of the ATTR_ENTITY_DERIVED kind.

Returns:

The View definition object corresponding to the specified name.

Throws:

NoDefException - if the entity attribute is not found.

addRowSetViewAttribute

public AttributeDefImpl addRowSetViewAttribute(java.lang.String attrName,
                                               java.lang.String expression,
                                               java.lang.Class javaType)

addViewAttribute

public AttributeDefImpl addViewAttribute(java.lang.String attrName,
                                         java.lang.String expression,
                                         java.lang.Class javaType)

addEntityUsage

public void addEntityUsage(java.lang.String usageName,
                           java.lang.String entityDefName,
                           boolean referenceOnly,
                           java.lang.String assocName,
                           java.lang.String assocEndName,
                           java.lang.String srcUsageName)

Deprecated. since 9.0.3, use addEntityUsage() that takes readOnly flag as well.

addEntityUsage

public void addEntityUsage(java.lang.String usageName,
                           java.lang.String entityDefName,
                           boolean referenceOnly,
                           boolean readOnly,
                           java.lang.String assocName,
                           java.lang.String assocEndName,
                           java.lang.String srcUsageName)

Specified by:

addEntityUsage in interface ViewDef

addEntityUsage

public void addEntityUsage(java.lang.String usageName,
                           java.lang.String entityDefName,
                           boolean referenceOnly,
                           boolean readOnly,
                           boolean deleteParticipant,
                           java.lang.String assocName,
                           java.lang.String assocEndName,
                           java.lang.String srcUsageName,
                           java.lang.String joinType)

Adds an Entity Usage to the View Object Definition

Parameters:

usageName - The name of the Entity Usage to uniquely identify it

entityDefName - The Entity Definition

referenceOnly - Flag to indicate if the changes in the primary key of the base entity brings the rows of this entity with matching foreign key values

readOnly - Flag to indicate if the attribute values could be changed

deleteParticipant - Flag to indicate if this Entity Usage instance is deleted when the View Row is deleted

assocName - The name of the Association between the base entity and this Entity Usage

assocEndName - The Association end that is used to form relationship between the base entity and this Entity Usage

srcUsageName - The name of the base entity usage

joinType - An optional join type between this entity usage and base entity usage

setJoinType

public void setJoinType(java.lang.String usageName,
                        int joinType)

Specified by:

setJoinType in interface ViewDef

addEntityUsage

public void addEntityUsage(java.lang.String usageName,
                           java.lang.String entityDefName,
                           boolean referenceOnly)

Deprecated. since 9.0.3, use addEntityUsage() that takes readOnly flag as well.

addEntityUsage

public void addEntityUsage(java.lang.String usageName,
                           java.lang.String entityDefName,
                           boolean referenceOnly,
                           boolean readOnly)

Specified by:

addEntityUsage in interface ViewDef

addViewUsage

public void addViewUsage(java.lang.String usageName,
                         java.lang.String viewDefName)

Specified by:

addViewUsage in interface ViewDef

addViewUsage

public void addViewUsage(java.lang.String usageName,
                         java.lang.String viewDefName,
                         java.lang.String viewLinkName,
                         java.lang.String viewLinkEndName,
                         java.lang.String srcUsageName)

Specified by:

addViewUsage in interface ViewDef

addRowAttribute

public AttributeDef addRowAttribute(java.lang.String attrName,
                                    java.lang.String rowRefName,
                                    java.lang.String baseAttrName)

Specified by:

addRowAttribute in interface ViewDef

addAllRowAttributes

public void addAllRowAttributes(java.lang.String rowRefName)

Specified by:

addAllRowAttributes in interface ViewDef

addApplyViewCriteriaNames

public void addApplyViewCriteriaNames(java.lang.String rowRefName,
                                      java.lang.String[] applyVCNames)

isReadOnly

public boolean isReadOnly()

A view is readonly if it does not have primary keys or all its entity references are reference-only. Or if it is static.

Returns:

True if view is readonly.

isStatic

public boolean isStatic()

A View Object is static if it is defined as static. A static view object has a static list used as data source to populate the view object.

Returns:

True if view is static.

isRuntimeSQLGeneration

public boolean isRuntimeSQLGeneration()

Specified by:

isRuntimeSQLGeneration in interface ViewCriteriaManagerOwner

setSelectAllAttributes

public void setSelectAllAttributes(boolean val)

isSelectAllAttributes

public boolean isSelectAllAttributes()

isPLSQLView

public boolean isPLSQLView()

A View Object is PLSQL view if it is defined as PL/SQL view object. A PLSQL view object is populated by calling PL/SQL stored procedure or function.

Returns:

True if the view is PLSQL view object.

createViewCriteria

public ViewCriteria createViewCriteria()

getStaticListCellId

protected static java.lang.String getStaticListCellId(java.lang.String voClassPath,
                                                      int row,
                                                      int col)

isFullSql

public boolean isFullSql()

setFullSql

public void setFullSql(boolean b)

isQueryThruEntity

public boolean isQueryThruEntity()

isDynamic

protected boolean isDynamic()

Overrides:

isDynamic in class MetaObject

getDefTypeId

public int getDefTypeId()

Specified by:

getDefTypeId in class DefObject

setDefForComponent

protected void setDefForComponent(ComponentObjectImpl comp)

Specified by:

setDefForComponent in class DefObject

unsetDefForComponent

protected void unsetDefForComponent(ComponentObjectImpl comp)

Specified by:

unsetDefForComponent in class DefObject

findViewLinkDefImpl

public ViewLinkDefImpl findViewLinkDefImpl(ViewAttributeDefImpl attr)

isPassivationEnabled

public final boolean isPassivationEnabled()

loadCustomDef

protected void loadCustomDef(DefElement xmlElement)
                      throws PersistenceException

Throws:

PersistenceException

getRows

public int getRows()

setRows

public void setRows(int i)

getColumns

public int getColumns()

setColumns

public void setColumns(int i)

hasQuery

public boolean hasQuery()

getXMLRowElementTag

public java.lang.String getXMLRowElementTag()

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

Overrides:

getXMLElementTag in class PersistableDefObject

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

Overrides:

getDefXMLElementTag in class PersistableDefObject

getIterMode

public int getIterMode()

setIterMode

public void setIterMode(int iterMode)

isViewLinkAccessorRetained

public boolean isViewLinkAccessorRetained()

setViewLinkAccessorRetained

public void setViewLinkAccessorRetained(boolean b)

isEffectiveDated

public boolean isEffectiveDated()

Description copied from class: RowDef

Tests if the row definition corresponds to an Effective Dated object.

Overrides:

isEffectiveDated in class RowDef

setEffectiveDated

public void setEffectiveDated(boolean b)

getEJBHomeJNDIName

public java.lang.String getEJBHomeJNDIName()

getEJBAppProviderURL

public java.lang.String getEJBAppProviderURL()

isFinderView

public boolean isFinderView()

getEJBHome

public java.lang.Object getEJBHome()

setSdoGen

public void setSdoGen(boolean value)

isSdoGen

public boolean isSdoGen()

setSdoName

public void setSdoName(java.lang.String value)

getSdoName

public java.lang.String getSdoName()

setSdoNameSpace

public void setSdoNameSpace(java.lang.String value)

getSdoNameSpace

public java.lang.String getSdoNameSpace()

setServiceWarnings

public void setServiceWarnings(boolean value)

isServiceWarningsEnabled

public boolean isServiceWarningsEnabled()

isSDOGeneric

public boolean isSDOGeneric()

buildDefaultSelect

public static java.lang.String buildDefaultSelect(AttributeDef[] attrDefs)

buildDefaultSelect

public static java.lang.String buildDefaultSelect(AttributeDef[] attrDefs,
                                                  AttributeDef[] forcedSelectAttrs)

getVarMgrParents

protected VariableValueManager[] getVarMgrParents()

Overrides:

getVarMgrParents in class DefObject

hasVariables

public boolean hasVariables()

Description copied from interface: VariableManagerOwnerBase

Returns a flag indicating whether this object has Variables or not.

Specified by:

hasVariables in interface VariableManagerOwnerBase

Overrides:

hasVariables in class DefObject

Returns:

the flag indicating whether this object has Variables.

getEffectiveDateTransientAttrName

protected java.lang.String getEffectiveDateTransientAttrName()

getEffectiveDateTransientAttr

public AttributeDefImpl getEffectiveDateTransientAttr()

Description copied from class: RowDef

Retuns the Attribute definition that stores the Effective Date value in a row. This method is overridden in ViewDefImpl and EntityDefImpl.

Overrides:

getEffectiveDateTransientAttr in class RowDef

getEffectiveDateTransientAttrInternal

protected AttributeDefImpl getEffectiveDateTransientAttrInternal()

hasDataSecurity

public boolean hasDataSecurity()

Specified by:

hasDataSecurity in class RowDef

lookupViewAccessorDef

public ViewAccessorDef lookupViewAccessorDef(java.lang.String name)

Overrides:

lookupViewAccessorDef in class RowDef

getListBindingViewDef

public ViewDefImpl getListBindingViewDef()

addListBindingDef

public void addListBindingDef(ListBindingDef cld)

Overrides:

addListBindingDef in class RowDef

setupForLov

public void setupForLov(ViewObjectImpl vo)

Deprecated.

Internal use only. Used by the runtime generated view def for view criteria purposes to copy the list binding defs from the underlying view object.

Parameters:

vo - The view object that owns the view criteria

getHintValue

public java.lang.String getHintValue(LocaleContext locale,
                                     java.lang.String sHintName)

getProperty

public java.lang.Object getProperty(java.lang.String hintName)

Description copied from class: NamedObjectImpl

Retrieves the specified property, if it exists.

Overrides:

getProperty in class NamedObjectImpl

Parameters:

hintName - a string to be used as a hash table key.

Returns:

the value associated with hintName, if any, otherwise null.

getDBSortCriteria

public SortCriteria[] getDBSortCriteria()

setDBSortCriteria

public void setDBSortCriteria(SortCriteria[] sortCriteria)

getViewKeyAttrDefs

public AttributeDefImpl[] getViewKeyAttrDefs(ViewKeyDef viewKeyDef)

setAutoRefresh

public void setAutoRefresh(boolean flag)

isAutoRefreshEnabled

public boolean isAutoRefreshEnabled()

getDfltCtrlHints

public java.util.HashMap<java.lang.String,java.util.HashMap> getDfltCtrlHints(java.util.List<java.lang.String> attrNames,
                                                                              java.lang.String localeName)

getCtrlHints

public java.util.HashMap<java.lang.String,java.util.HashMap> getCtrlHints(java.util.List<java.lang.String> attrNames,
                                                                          java.lang.String localeName,
                                                                          ViewRowImpl viewRow)

getSIFContextKey

public java.util.List<java.lang.String> getSIFContextKey()

createAttributeDef

protected ViewAttributeDefImpl createAttributeDef()

Internal use only.

getSDOPackageName

public java.lang.String getSDOPackageName()

isSdoDirty

public boolean isSdoDirty()

setSdoDirty

public void setSdoDirty(boolean b)

getComponentClass

public java.lang.Class getComponentClass()

setComponentClass

public void setComponentClass(java.lang.Class refClass)

setComponentInterfaceName

public void setComponentInterfaceName(java.lang.String interfaceName)

getComponentInterfaceName

public java.lang.String getComponentInterfaceName()

getClientProxyClassName

public java.lang.String getClientProxyClassName()

setClientProxyClassName

public void setClientProxyClassName(java.lang.String name)

getEffectiveClientProxyClassName

protected java.lang.String getEffectiveClientProxyClassName()

getEffectiveComponentInterfaceName

protected java.lang.String getEffectiveComponentInterfaceName()

loadFromXML

protected static void loadFromXML(DefElement xmlElement,
                                  oracle.jbo.server.RemotableCompDef defObj)

getComponentOperations

protected ComponentOperations getComponentOperations()

Deprecated.

For internal framework use only.

getOperationDefinitions

public OperationDefinitionsImpl getOperationDefinitions()

Deprecated.

For internal framework use only.

Specified by:

getOperationDefinitions in interface OperationDefinitionContainer

lookupOperationDefinition

public OperationDefinitionImpl lookupOperationDefinition(java.lang.String id)

Deprecated.

For internal framework use only.

findOperationDefinition

public OperationDefinitionImpl findOperationDefinition(java.lang.String id)

Deprecated.

For internal framework use only.

addOperation

public void addOperation(OperationDefinitionImpl opDef)

Deprecated.

For internal framework use only.

addScriptOperation

public OperationDefinitionImpl addScriptOperation(java.lang.String id,
                                                  java.lang.String name,
                                                  java.lang.String returnType,
                                                  java.util.LinkedHashMap<java.lang.String,java.lang.String> params,
                                                  java.lang.String body)

Deprecated.

For internal framework use only.

addScriptRowOperation

public OperationDefinitionImpl addScriptRowOperation(java.lang.String id,
                                                     java.lang.String name,
                                                     java.lang.String returnType,
                                                     java.util.LinkedHashMap<java.lang.String,java.lang.String> params,
                                                     java.lang.String body)

Deprecated.

For internal framework use only.

removeOperation

public void removeOperation(OperationDefinitionImpl opDef)

Deprecated.

For internal framework use only.

loadOperationDefinitions

protected void loadOperationDefinitions(DefElement xmlElement)

For internal framework use only.

getRowOperationDefinitions

public OperationDefinitionsImpl getRowOperationDefinitions()

Deprecated.

For internal framework use only.

lookupRowOperationDefinition

public OperationDefinitionImpl lookupRowOperationDefinition(java.lang.String id)

Deprecated.

For internal framework use only.

findRowOperationDefinition

public OperationDefinitionImpl findRowOperationDefinition(java.lang.String id)

Deprecated.

For internal framework use only.

addRowOperation

public void addRowOperation(OperationDefinitionImpl opDef)

Deprecated.

For internal framework use only.

addRowScriptOperation

public OperationDefinitionImpl addRowScriptOperation(java.lang.String id,
                                                     java.lang.String name,
                                                     java.lang.String returnType,
                                                     java.util.LinkedHashMap<java.lang.String,java.lang.String> params,
                                                     java.lang.String body)

Deprecated.

For internal framework use only.

removeRowOperation

public void removeRowOperation(OperationDefinitionImpl opDef)

Deprecated.

For internal framework use only.

Skip navigation links