|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.4.0) E10653-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.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
public class ViewDefImpl
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
and
regsiter it with MetaObjectManager through
resolveDefObject()
. For a View Def
created from an XML file, the client does not need to call
these methods, as the framework calls them itself.
RowDef.registerDefObject()
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 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. |
OperationDefinitionImpl |
addGroovyOperation(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 |
addGroovyRowOperation(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. |
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. |
AttributeDefImpl |
addRowSetViewAttribute(java.lang.String attrName,
java.lang.String expression,
java.lang.Class javaType)
|
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()
|
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)
Deprecated. |
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.MetaObject |
---|
deregisterSessionObject, getMessageBundleClass, getMsgBundleDef, getPackageDef, getPackageName, getPersDef, 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.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 |
---|
public static final int CLAUSE_GENERATE_RT
public static final int CLAUSE_ADDITIVE
public static final byte PASSIVATE_DEFAULT
public static final byte PASSIVATE_TRANISENTS_TOO
public static final byte PASSIVATE_DISABLED
public static final java.lang.String COMPOSITE_VIEW_OBJECT
Constructor Detail |
---|
public ViewDefImpl()
public ViewDefImpl(int defScope, java.lang.String name)
public ViewDefImpl(java.lang.String name)
name
- name by which this View Def will be registered in MetaObjectManager.public ViewDefImpl(int defScope, java.lang.String name, java.lang.String baseViewDefName)
Method Detail |
---|
public static byte getDefaultFetchMode()
public static java.lang.String[] getAllDefNames()
public static ViewDefImpl findDefObjectNoSub(java.lang.String viewDefName)
findDefObject
, except that it
does not observe meta-object substitution.
viewObjectName
- The fully qualified Name of the ViewDefImpl.
MetaObjectManager
public static ViewDefImpl findDefObject(java.lang.String viewDefName)
viewDefName
- The fully qualified Name of the ViewDefImpl.
MetaObjectManager
public static ViewDefImpl createCompositeViewDef(int defScope, java.lang.String name)
public static int getMaxAttrConst(java.lang.String viewDefName)
public boolean isComposite()
protected AttributeDefImpl[] getAttributeDefImpls()
getAttributeDefImpls
in class RowDef
public AttributeDef[] getAttributeDefs()
getAttributeDefs
in interface StructureDef
getAttributeDefs
in class RowDef
public AttributeDef[] getRawAttributeDefs(boolean procAccessors)
getRawAttributeDefs
in class RowDef
public AttributeDef findAttributeDef(java.lang.String attrName)
findAttributeDef
in interface StructureDef
findAttributeDef
in class RowDef
attrName
- name of the attribute.
NoDefException
- thrown if the named atribute
is not found.public AttributeDef findAttrDefByEntAttrDef(AttributeDef entAttrDef)
entAttrDef
- entity attribute def
null
if not found.public AttributeDef lookupAttributeDef(java.lang.String attrName)
lookupAttributeDef
in interface AttributeDependencyManager
lookupAttributeDef
in interface StructureDef
lookupAttributeDef
in class RowDef
attrName
- the name of an AttributeDef
.
null
if not found.public EntityReference[] getEntityUsages()
protected EntityReference[] getEntityReferences()
EntityReference
's
upon which this ViewObject is based. Each EntityReference
refers to EntityDef
that describes the Entity.
EntityReference
array.protected EntityReference[] getEntityReferences(AttributeDef[] attrDefs)
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
EntityReference
array.public EntityReference[] getEntityRefsParentOrder()
public boolean isManageRowsByKey()
public EntityReference getEntityUsage(java.lang.String name)
public EntityReference getEntityReference(java.lang.String name)
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
.
name
- the Entity usage name.
EntityReference
. null
if
no matching Entity usage is found.protected EntityReference getEntityReference(int index)
protected AttributeDefImpl[] getEntityDiscrColumns()
protected void setEntityDiscrColumns(AttributeDefImpl[] entityDiscrCols)
public java.lang.String getQuery()
public void setQuery(java.lang.String query)
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.
query
- The sql statement of the query.public void setQueryHint(java.lang.String queryHint)
public java.lang.String getQueryHint()
public void setRowMatch(java.lang.String rowMatch)
public java.lang.String getRowMatch()
public StructureDef findStructureDefByName(java.lang.String structDefFullName)
findStructureDefByName
in interface ViewCriteriaResolver
public boolean shouldPutJoinConstraintInWhereClause()
shouldPutJoinConstraintInWhereClause
in interface ViewCriteriaManagerOwner
public ViewCriteriaManager getViewCriteriaManager()
getViewCriteriaManager
in interface ViewCriteriaManagerOwner
public void criteriaChanged(ViewCriteria vc)
criteriaChanged
in interface ViewCriteriaManagerOwner
public ViewCriteria getDefaultViewCriteria()
public java.lang.String[] getAllViewCriteriaNames()
public ViewCriteria[] getAllViewCriterias()
public ViewCriteria getViewCriteria(java.lang.String name)
public void putViewCriteria(java.lang.String name, ViewCriteria criteria)
public void putPDefViewCriteria(java.lang.String name, PDefViewCriteria pdvcriteria)
public int getEntityIndex(EntityReference entityRef)
public int getCalculatedAttributeCount()
protected AttributeDefImpl[] getPrimaryKeys()
getPrimaryKeys
in class RowDef
public AttributeDefImpl[] getAltKeyAttrDefs(java.lang.String name)
getAltKeyAttrDefs
in class RowDef
public AttributeDefImpl[] getAltKeyAttrDefs(int keyIndex)
getAltKeyAttrDefs
in class RowDef
public int getAttributeCount()
RowDef
getAttributeCount
in interface StructureDef
getAttributeCount
in class RowDef
public AttributeDef getAttributeDef(int index)
RowDef
getAttributeDef
in interface StructureDef
getAttributeDef
in class RowDef
index
- the index of an AttributeDef
, where the leftmost
attribute has index zero.
public java.lang.String getColumnNameForQuery(int index)
getColumnNameForQuery
in interface StructureDef
public void setRowClass(java.lang.Class rowClass)
rowClass
- The Class of the instance.public java.lang.Class getRowClass()
getRowClass
in class RowDef
public java.lang.String getRowClientProxyClassName()
protected void setRowClientProxyClassName(java.lang.String name)
public java.lang.String getRowInterfaceName()
protected void setRowInterfaceName(java.lang.String name)
public java.lang.String getStoredProcedureName()
protected void setStoredProcedureName(java.lang.String name)
protected java.lang.String getEffectiveRowClientProxyClassName()
public java.lang.Class getBaseComponentClass()
public int getSelectClauseFlags()
public void setSelectClauseFlags(int flags)
public int getFromClauseFlags()
public void setFromClauseFlags(int flags)
public int getWhereClauseFlags()
public void setWhereClauseFlags(int flags)
public java.lang.String getSelectClause()
public void setSelectClause(java.lang.String selectClause)
selectClause
- The SELECT listpublic java.lang.String getFromClause()
setFromClauseFlags(int)
.
Use the
getFromClause(SQLBuilder)
API if a SQLBuilder
is available for the
Database platform that you are working against.
public java.lang.String getFromClause(SQLBuilder builder)
setFromClauseFlags(int)
.
builder
- The SQLBuilder
abstracts the
actual database specific syntax generation.
public ViewCriteria getReqdVC()
public void setReqdVC(ViewCriteria vc)
public void setFromClause(java.lang.String fromClause)
fromClause
- The FROM clausepublic java.lang.String getWhereClause()
public java.lang.String getWhereClause(SQLBuilder builder)
protected StmtWithBindVars getWhereClause(AttributeDef[] attrDefs, int noBindVars, SQLBuilder builder)
public void setWhereClause(java.lang.String whereClause)
whereClause
- The WHERE clausepublic java.lang.String getOrderByClause()
public void setOrderByClause(java.lang.String orderByClause)
setOrderByClause
in interface ViewDef
orderByClause
- The ORDER BY clausepublic java.lang.String buildDefaultFrom()
buildDefaultFrom(SQLBuilder)
API if a SQLBuilder
is available for the
Database platform that you are working against.
public java.lang.String buildDefaultFrom(SQLBuilder builder)
builder
- The SQLBuilder
abstracts the
actual database specific syntax generation.
public java.lang.String buildDefaultFrom(AttributeDef[] attrDefs, SQLBuilder builder, BaseViewCriteriaManagerImpl vcManager)
public java.lang.String buildDefaultFromAttrs(AttributeDef[] attrDefs, AttributeDef[] forcedAttrDefs, java.util.List addEntRefs, SQLBuilder builder, BaseViewCriteriaManagerImpl vcManager)
public byte getFetchMode()
public void setFetchMode(byte fetchMode)
fetchMode
- is FETCH_AS_NEEDED, FETCH_ALL or FETCH_DEFAULT.public short getFetchSize()
public void setFetchSize(short size)
size
- the size, in rows, of the chunk to fetch.public int getMaxFetchSize()
public void setMaxFetchSize(int size)
size
- the number of rows.public boolean isUseGlueCode()
public void setUseGlueCode(boolean b)
public void setMaxRowsPerNode(int maxRowsPerNode)
public int getMaxRowsPerNode()
public void setMaxActiveNodes(int maxActiveNodes)
public int getMaxActiveNodes()
public int getRangeSize()
public void setRangeSize(int r)
public byte getAccessMode()
public void setAccessMode(byte accessMode)
accessMode
- is RowSet.SCROLLABLE, RowSet.FORWARD_ONLY,
RowSet.RANGE_PAGING, RowSet.RANGE_PAGING_AUTO_POST, or
RowSet.RANGE_PAGING_INCR.public int getRangePagingCacheFactor()
public void setRangePagingCacheFactor(int factor)
factor
- range paging cache factor.protected boolean hasPrimaryEntity()
protected void finishedLoading()
finishedLoading
in class DefObject
public static ViewDefImpl createViewDef(int defScope, java.lang.String defClassName)
protected void resolveReferences()
resolveReferences
in class DefObject
public void loadXMLContents(DefElement xmlElement, java.lang.String fullName)
protected void setPassivationMode(byte passivationMode)
passivationMode
- - Value of this argument must be among
one of these 3 values
ViewDefImpl.PASSIVATE_DEFAULT
ViewDefImpl.PASSIVATE_TRANISENTS_TOO
ViewDefImpl.PASSIVATE_DISABLEDpublic void writeChildren(DefWriter jos)
PersistentDefinition
writeChildren
in interface PersistentDefinition
writeChildren
in class RowDef
jos
- the Output storage for persistencepublic void writeContents(DefWriter jos)
PersistentDefinition
writeContents
in interface PersistentDefinition
jos
- the Output storage for persistencepublic void resolveDefObject()
This method must be called after the View Def is set up
and before registerDefObject()
.
resolveDefObject
in interface ViewDef
resolveDefObject
in class MetaObject
protected KeyDef createAltKey(java.lang.String keyName, int keyIndex, java.lang.String[] components)
createAltKey
in class RowDef
public void addAllEntityAttributes(java.lang.String entityUsageName)
public ViewAttributeDefImpl addViewLinkAccessor(java.lang.String accName, java.lang.String viewLinkName, java.lang.Class javaType)
public ViewAttributeDefImpl addViewLinkAccessor(java.lang.String accName, java.lang.String viewLinkName, java.lang.Class javaType, boolean isReversed)
public AttributeDefImpl addEntityAttribute(java.lang.String attrName, java.lang.String entityUsageName, java.lang.String entityAttrName, boolean isPersistent)
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.
NoDefException
- if the entity attribute is not found.public AttributeDefImpl addRowSetViewAttribute(java.lang.String attrName, java.lang.String expression, java.lang.Class javaType)
public AttributeDefImpl addViewAttribute(java.lang.String attrName, java.lang.String expression, java.lang.Class javaType)
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)
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)
addEntityUsage
in interface ViewDef
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)
usageName
- The name of the Entity Usage to uniquely identify itentityDefName
- The Entity DefinitionreferenceOnly
- Flag to indicate if the changes in the primary key of the
base entity brings the rows of this entity with matching foreign
key valuesreadOnly
- Flag to indicate if the attribute values could be changeddeleteParticipant
- Flag to indicate if this Entity Usage instance is
deleted when the View Row is deletedassocName
- The name of the Association between the base entity and this
Entity UsageassocEndName
- The Association end that is used to form relationship between
the base entity and this Entity UsagesrcUsageName
- The name of the base entity usagejoinType
- An optional join type between this entity usage and base entity usagepublic void setJoinType(java.lang.String usageName, int joinType)
setJoinType
in interface ViewDef
public void addEntityUsage(java.lang.String usageName, java.lang.String entityDefName, boolean referenceOnly)
public void addEntityUsage(java.lang.String usageName, java.lang.String entityDefName, boolean referenceOnly, boolean readOnly)
addEntityUsage
in interface ViewDef
public void addViewUsage(java.lang.String usageName, java.lang.String viewDefName)
addViewUsage
in interface ViewDef
public void addViewUsage(java.lang.String usageName, java.lang.String viewDefName, java.lang.String viewLinkName, java.lang.String viewLinkEndName, java.lang.String srcUsageName)
addViewUsage
in interface ViewDef
public AttributeDef addRowAttribute(java.lang.String attrName, java.lang.String rowRefName, java.lang.String baseAttrName)
addRowAttribute
in interface ViewDef
public void addAllRowAttributes(java.lang.String rowRefName)
addAllRowAttributes
in interface ViewDef
public void addApplyViewCriteriaNames(java.lang.String rowRefName, java.lang.String[] applyVCNames)
public boolean isReadOnly()
public boolean isStatic()
public boolean isRuntimeSQLGeneration()
isRuntimeSQLGeneration
in interface ViewCriteriaManagerOwner
public void setSelectAllAttributes(boolean val)
public boolean isSelectAllAttributes()
public boolean isPLSQLView()
public ViewCriteria createViewCriteria()
protected static java.lang.String getStaticListCellId(java.lang.String voClassPath, int row, int col)
public boolean isFullSql()
public void setFullSql(boolean b)
public boolean isQueryThruEntity()
protected boolean isDynamic()
isDynamic
in class MetaObject
public int getDefTypeId()
getDefTypeId
in class DefObject
protected void setDefForComponent(ComponentObjectImpl comp)
setDefForComponent
in class DefObject
protected void unsetDefForComponent(ComponentObjectImpl comp)
unsetDefForComponent
in class DefObject
public ViewLinkDefImpl findViewLinkDefImpl(ViewAttributeDefImpl attr)
public final boolean isPassivationEnabled()
protected void loadCustomDef(DefElement xmlElement) throws PersistenceException
PersistenceException
public int getRows()
public void setRows(int i)
public int getColumns()
public void setColumns(int i)
public boolean hasQuery()
public java.lang.String getXMLRowElementTag()
public java.lang.String getXMLElementTag()
PersistentDefinition
getXMLElementTag
in interface PersistentDefinition
getXMLElementTag
in class PersistableDefObject
public java.lang.String getDefXMLElementTag()
getDefXMLElementTag
in interface PersistentDefinition
getDefXMLElementTag
in class PersistableDefObject
public int getIterMode()
public void setIterMode(int iterMode)
public boolean isViewLinkAccessorRetained()
public void setViewLinkAccessorRetained(boolean b)
public boolean isEffectiveDated()
RowDef
isEffectiveDated
in class RowDef
public void setEffectiveDated(boolean b)
public java.lang.String getEJBHomeJNDIName()
public java.lang.String getEJBAppProviderURL()
public boolean isFinderView()
public java.lang.Object getEJBHome()
public void setSdoGen(boolean value)
public boolean isSdoGen()
public void setSdoName(java.lang.String value)
public java.lang.String getSdoName()
public void setSdoNameSpace(java.lang.String value)
public java.lang.String getSdoNameSpace()
public void setServiceWarnings(boolean value)
public boolean isServiceWarningsEnabled()
public boolean isSDOGeneric()
public static java.lang.String buildDefaultSelect(AttributeDef[] attrDefs)
public static java.lang.String buildDefaultSelect(AttributeDef[] attrDefs, AttributeDef[] forcedSelectAttrs)
protected VariableValueManager[] getVarMgrParents()
getVarMgrParents
in class DefObject
public boolean hasVariables()
VariableManagerOwnerBase
hasVariables
in interface VariableManagerOwnerBase
hasVariables
in class DefObject
protected java.lang.String getEffectiveDateTransientAttrName()
public AttributeDefImpl getEffectiveDateTransientAttr()
RowDef
getEffectiveDateTransientAttr
in class RowDef
protected AttributeDefImpl getEffectiveDateTransientAttrInternal()
public boolean hasDataSecurity()
hasDataSecurity
in class RowDef
public ViewAccessorDef lookupViewAccessorDef(java.lang.String name)
lookupViewAccessorDef
in class RowDef
public ViewDefImpl getListBindingViewDef()
public void addListBindingDef(ListBindingDef cld)
addListBindingDef
in class RowDef
public void setupForLov(ViewObjectImpl vo)
vo
- The view object that owns the view criteriapublic java.lang.String getHintValue(LocaleContext locale, java.lang.String sHintName)
public java.lang.Object getProperty(java.lang.String hintName)
NamedObjectImpl
getProperty
in class NamedObjectImpl
hintName
- a string to be used as a hash table key.
hintName
, if any,
otherwise null
.public SortCriteria[] getDBSortCriteria()
public void setDBSortCriteria(SortCriteria[] sortCriteria)
public AttributeDefImpl[] getViewKeyAttrDefs(ViewKeyDef viewKeyDef)
public void setAutoRefresh(boolean flag)
public boolean isAutoRefreshEnabled()
public java.util.HashMap<java.lang.String,java.util.HashMap> getDfltCtrlHints(java.util.List<java.lang.String> attrNames, java.lang.String localeName)
public java.util.HashMap<java.lang.String,java.util.HashMap> getCtrlHints(java.util.List<java.lang.String> attrNames, java.lang.String localeName, ViewRowImpl viewRow)
public java.util.List<java.lang.String> getSIFContextKey()
protected ViewAttributeDefImpl createAttributeDef()
public java.lang.String getSDOPackageName()
public boolean isSdoDirty()
public void setSdoDirty(boolean b)
public java.lang.Class getComponentClass()
public void setComponentClass(java.lang.Class refClass)
public void setComponentInterfaceName(java.lang.String interfaceName)
public java.lang.String getComponentInterfaceName()
public java.lang.String getClientProxyClassName()
public void setClientProxyClassName(java.lang.String name)
protected java.lang.String getEffectiveClientProxyClassName()
protected java.lang.String getEffectiveComponentInterfaceName()
protected static void loadFromXML(DefElement xmlElement, oracle.jbo.server.RemotableCompDef defObj)
public OperationDefinitionsImpl getOperationDefinitions()
getOperationDefinitions
in interface OperationDefinitionContainer
public OperationDefinitionsImpl getRowOperationDefinitions()
public OperationDefinitionImpl lookupOperationDefinition(java.lang.String id)
public OperationDefinitionImpl findOperationDefinition(java.lang.String id)
public OperationDefinitionImpl lookupRowOperationDefinition(java.lang.String id)
public OperationDefinitionImpl findRowOperationDefinition(java.lang.String id)
public void addOperation(OperationDefinitionImpl opDef)
public void addRowOperation(OperationDefinitionImpl opDef)
public OperationDefinitionImpl addGroovyOperation(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)
public OperationDefinitionImpl addGroovyRowOperation(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)
public void removeOperation(OperationDefinitionImpl opDef)
public void removeRowOperation(OperationDefinitionImpl opDef)
protected final void loadOperationDefinitions(DefElement xmlElement)
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.4.0) E10653-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |