|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1) E10653-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.jbo.common.NamedObjectImpl oracle.jbo.mom.DefinitionObject oracle.jbo.mom.PersistableDefObject oracle.jbo.server.MetaObject oracle.jbo.server.ApplicationModuleDefImpl
public class ApplicationModuleDefImpl
The base class for all generated ApplicationModule classes.
An Application Module is a container for View Objects, View Links and other Application Modules. This class stores the runtime metadata for Application Modules. Like other Def objects, ApplicationModuleDef objects are stored, by name, in the XML file. This class is needed to load an Application Module and the components it contains from XML metadata. Calling loadXML() on an object instantiated from this class causes its components to be installed.
Nested Class Summary | |
---|---|
class |
ApplicationModuleDefImpl.ServiceInterfaceMethod
|
class |
ApplicationModuleDefImpl.TypeInfo
|
Field Summary | |
---|---|
protected boolean |
mClearCacheOnCommit
Value determines whether cache should be cleared on a database commit operation. |
protected boolean |
mClearCacheOnRollback
Value determines whether cache should be cleared on a database rollback operation. |
protected java.util.ArrayList |
mCompUsageList
List of ComponentObject names |
protected java.util.HashMap |
mCompUsages
Hash table to keep a list of name value pairs for ComponentUsages |
protected java.util.HashMap |
mRemoteServers
Hash table to keep name value pairs for Platform, RemoteServer pairs. |
protected boolean |
mRequeryOnCommit
Value determines whether the database should be requeried after a commit operation. |
protected java.util.HashMap |
mValidatorTypes
|
protected java.util.ArrayList |
mViewLinkUsageList
List of ViewLinkUsages. |
protected java.util.HashMap |
mViewLinkUsages
Hash table to keep a list of name value pairs for ViewLinkUsages. |
protected java.util.ArrayList |
mViewUsageList
List of View Object names. |
protected java.util.HashMap |
mViewUsages
Hash table to keep a list of name value pairs for ViewUsages. |
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 |
Fields inherited from class oracle.jbo.common.NamedObjectImpl |
---|
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX |
Fields inherited from interface oracle.jbo.mom.xml.DefPersistable |
---|
XML_STATEMENT |
Constructor Summary | |
---|---|
ApplicationModuleDefImpl()
Default Constructor. |
|
ApplicationModuleDefImpl(int defScope,
java.lang.String name)
|
|
ApplicationModuleDefImpl(java.lang.String name)
|
Method Summary | |
---|---|
void |
addViewImport(java.lang.String viewDefName)
|
void |
createApplicationModule(java.lang.String amName,
java.lang.String defName,
int sharedScope)
|
static ApplicationModuleDefImpl |
createApplicationModuleDef(int defScope,
java.lang.String defClassName)
|
void |
createViewLink(java.lang.String vlName,
java.lang.String defName,
java.lang.String srcVOName,
java.lang.String destVOName)
|
void |
createViewLinkBetweenViewObjects(java.lang.String vlName,
java.lang.String accessorName,
java.lang.String srcVOName,
java.lang.String[] srcAttrNames,
java.lang.String destVOName,
java.lang.String[] destAttrNames,
java.lang.String assocClause)
|
void |
createViewLinkFromEntityAssocName(java.lang.String vlName,
java.lang.String entityAssocName,
java.lang.String srcVOName,
java.lang.String destVOName)
|
AMViewUsage |
createViewObject(java.lang.String voName,
java.lang.String defName)
|
AMViewUsage |
createViewObjectFromQueryClauses(java.lang.String voName,
java.lang.String eoName,
java.lang.String selectClause,
java.lang.String fromClause,
java.lang.String whereClause,
java.lang.String orderByClause)
|
AMViewUsage |
createViewObjectFromQueryStmt(java.lang.String voName,
java.lang.String queryStatement)
|
AMViewUsage |
createViewObjectFromQueryStmt(java.lang.String voName,
java.lang.String queryStatement,
java.lang.String voImplClassName)
|
VariableValueManager |
ensureVariableManager()
Returns this object's Variable Value Manager. |
static ApplicationModuleDefImpl |
findDefObject(java.lang.String name)
Finds an ApplicationModuleDefImpl instance, by name, from the statically maintained list of metaobjects. |
static ApplicationModuleDefImpl |
findDefObjectNoSub(java.lang.String name)
Finds the named Application Module definition. |
AMViewUsage |
findViewObject(java.lang.String name)
|
protected void |
finishedLoading()
|
static java.lang.String[] |
getAllDefNames()
|
java.util.HashMap |
getAllProperties(java.util.HashMap map,
LocaleContext locale)
|
AppModuleUsage[] |
getAMAppModuleUsages()
|
ViewLinkUsage[] |
getAMViewLinkUsages()
|
AMViewUsage[] |
getAMViewUsages()
|
java.lang.String[] |
getApplicationModuleNames()
|
java.lang.Class |
getBaseComponentClass()
Internal: Applications should not use this method. |
DefinitionObject |
getBaseDefObject()
|
java.lang.String |
getClientProxyClassName()
|
java.lang.String |
getClientProxyClassName(java.lang.String platform)
Deprecated. Platform specific proxies are deprecated. Use getClientProxyClassName() instead. |
java.lang.Class |
getComponentClass()
|
java.lang.String |
getComponentInterfaceName()
|
java.lang.String[] |
getComponentObjectNames()
|
int |
getDefTypeId()
|
java.lang.String |
getDefXMLElementTag()
|
java.lang.String |
getDefXMLNameSpace()
|
protected java.lang.String |
getEffectiveClientProxyClassName()
|
protected java.lang.String |
getEffectiveComponentInterfaceName()
|
OperationDefinitions |
getOperationDefinitions()
|
protected PackageDefImpl[] |
getPackageDefs()
|
java.lang.String |
getParameterTypeForServiceMethod(java.lang.String methodName,
java.lang.Class[] paramTypes,
int paramIndex)
|
java.lang.String |
getReturnTypeForServiceMethod(java.lang.String methodName,
java.lang.Class[] paramTypes)
Returns return type for custom service method or null if method does not exist |
java.lang.String |
getServerClassName(java.lang.String platform)
Internal: Applications should not use this method. |
ApplicationModuleDefImpl.ServiceInterfaceMethod |
getServiceMethod(java.lang.String methodName,
java.lang.Class[] paramTypes)
Returns custom service method or null if method does not exist. |
boolean |
getSvuCanCreate(java.lang.String svuName)
|
boolean |
getSvuCanDelete(java.lang.String svuName)
|
boolean |
getSvuCanMerge(java.lang.String svuName)
|
boolean |
getSvuCanUpdate(java.lang.String svuName)
|
java.lang.String[] |
getSvuNames()
|
VariableValueManager |
getVariableManager()
Returns this object's current Variable Value Manager. |
protected VariableValueManager[] |
getVarMgrParents()
|
java.util.ArrayList |
getViewImports()
|
java.lang.String[] |
getViewLinkNames()
|
java.lang.String[] |
getViewObjectNames()
|
protected boolean |
hasApplicationModule(java.lang.String amName)
|
protected boolean |
hasComponentObject(java.lang.String compName)
|
boolean |
hasVariables()
Returns a flag indicating whether this object has Variables or not. |
protected boolean |
hasViewLink(java.lang.String vlName)
|
protected boolean |
hasViewObject(java.lang.String voName)
|
boolean |
isClearCacheOnCommit()
Returns the flag indicating whether all Entity Object caches will be cleared after the transaction is committed. |
boolean |
isClearCacheOnRollback()
Returns the flag indicating whether all Entity Object caches will be cleared after the transaction is rolled back. |
boolean |
isLoadComponentsLazily()
|
boolean |
isRequeryOnCommit()
Indicates whether View Objects associated with this Application Module should be marked as needing to be executed after a database commit. |
protected ApplicationModule |
loadApplicationModule(ApplicationModule am,
java.lang.String amName)
|
protected ComponentObject |
loadComponentObject(ApplicationModule am,
java.lang.String compName)
|
protected void |
loadComponents(ApplicationModuleImpl am)
This function loops through the list of ViewObjects, ViewLinks, and child ApplicationModules found in the ApplicationModule definition and create them in the ApplicationModule instance, identified by am. |
void |
loadContainees()
Internal: Applications should not use this method. |
protected static ApplicationModuleDefImpl |
loadFromXML(DefElement xmlElement)
Deprecated. |
protected static void |
loadFromXML(DefElement xmlElement,
oracle.jbo.server.RemotableCompDef defObj)
|
protected static ApplicationModuleDefImpl |
loadFromXML(DefElement xmlElement,
java.lang.String fullName,
ApplicationModuleDefImpl aInfo)
Internal: Applications should not use this method. |
protected void |
loadOperationDefinitions(DefElement xmlElement)
|
protected void |
loadOperationDefinitions(DefElement xmlElement,
java.lang.String tag)
|
protected void |
loadProperties(DefElement xmlElement)
|
protected void |
loadVariables(DefElement xmlElement)
|
protected ViewLink |
loadViewLink(ApplicationModule am,
java.lang.String vluName)
|
protected ViewObject |
loadViewObject(ApplicationModule am,
java.lang.String voName)
|
void |
loadXMLContents(DefElement xmlElement,
java.lang.String fullName)
|
void |
removeViewImport(java.lang.String viewDefName)
|
void |
resolveDefObject()
|
protected java.lang.Object |
resolvePropertyRaw(java.lang.String property,
LocaleContext locale)
|
protected void |
resolveReferences()
|
void |
setBaseDefObject(DefinitionObject baseDefObject)
|
void |
setBaseDefObject(DefinitionObject baseDefObject,
boolean addToBaseDef)
|
void |
setClearCacheOnCommit(boolean b)
|
void |
setClearCacheOnRollback(boolean b)
|
void |
setClientProxyClassName(java.lang.String name)
|
void |
setComponentClass(java.lang.Class refClass)
|
void |
setComponentInterfaceName(java.lang.String interfaceName)
|
protected void |
setDefForComponent(ComponentObjectImpl comp)
|
void |
setLoadComponentsLazily(boolean isLoadComponentsLazily)
|
void |
setName(java.lang.String name)
Name this object. |
protected void |
setParent(NamedObjectImpl parent)
Sets this object's parent. |
void |
setRequeryOnCommit(boolean b)
|
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, isDynamic, loadResourceBundle, registerDefObject, registerSessionDefObject, setMessageBundleClass, setResourceBundleDef |
Methods inherited from class oracle.jbo.common.NamedObjectImpl |
---|
getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getResourcesFromBundle, refreshProperty, removeProperty, requiresNamePrefixedResId, 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.VariableManagerOwner |
---|
getName |
Methods inherited from interface oracle.jbo.mom.xml.DefPersistable |
---|
getFullName |
Field Detail |
---|
protected boolean mClearCacheOnCommit
protected boolean mClearCacheOnRollback
protected boolean mRequeryOnCommit
protected java.util.HashMap mValidatorTypes
protected java.util.HashMap mViewUsages
protected java.util.ArrayList mViewUsageList
protected java.util.HashMap mViewLinkUsages
protected java.util.ArrayList mViewLinkUsageList
protected java.util.HashMap mRemoteServers
protected java.util.HashMap mCompUsages
protected java.util.ArrayList mCompUsageList
Constructor Detail |
---|
public ApplicationModuleDefImpl()
public ApplicationModuleDefImpl(int defScope, java.lang.String name)
public ApplicationModuleDefImpl(java.lang.String name)
Method Detail |
---|
public static java.lang.String[] getAllDefNames()
public static ApplicationModuleDefImpl findDefObjectNoSub(java.lang.String name)
findDefObject
, except that it
does not observe meta-object substitution.
name
- The fully qualified name of the ApplicationModuleDefImpl.
MetaObjectManager
public static ApplicationModuleDefImpl findDefObject(java.lang.String name)
name
- The fully qualified name of the ApplicationModuleDefImpl.
MetaObjectManager
public java.lang.Class getBaseComponentClass()
Gets this instance's class.
public java.lang.String getServerClassName(java.lang.String platform)
Returns the server class name of the remote server.
platform
- the platform to which the Application Module was deployed.
public java.lang.String getClientProxyClassName(java.lang.String platform)
Returns the class name of the client side proxy object for the
platform
.
platform
- the platform to which the Application Module was deployed.
platform
.
null
if platform is null
.public boolean isClearCacheOnCommit()
After the transaction is committed, the value of this flag is
used to determine whether the Entity Object caches are cleared or
not. If this flag value is false
, the cache contents
are kept. In this case, the cache may contain data that is stale
in that it does not match the newest data (changes made by another
user and committed).
If this flag is true
, the caches are cleared after
the transaction is committed. When the user brings in data
by traversing row collection, the latest data from the database
will be brought into Entity caches.
RowSet.executeQuery()
,
Transaction.isClearCacheOnCommit()
,
Transaction.setClearCacheOnCommit(boolean)
public void setClearCacheOnCommit(boolean b)
public boolean isClearCacheOnRollback()
After the transaction is rolled back, the value of this flag is
used to determine whether the Entity Object caches are cleared or
not. If this flag value is false
, the cache contents
are kept. In this case, the cache may contain data that is not in
sync with database in that uncommitted changes made this by user
(before the transaction was rolled back) will be kept.
If this flag is true
, the caches are cleared after
the transaction is rolled back. When the user brings in data
by traversing row collection, the latest data from the database
will be brought into Entity caches.
RowSet.executeQuery()
,
Transaction.setClearCacheOnRollback(boolean)
,
Transaction.isClearCacheOnRollback()
public void setClearCacheOnRollback(boolean b)
public boolean isRequeryOnCommit()
If this method returns true, then after a database commit, all View Objects contained by this Application Module will be marked as needing to be executed. Any attempt to retrieve rows from these View Objects or their row sets/row set iterators will cause the query to be re-executed.
public void setRequeryOnCommit(boolean b)
public boolean isLoadComponentsLazily()
public void setLoadComponentsLazily(boolean isLoadComponentsLazily)
public AMViewUsage[] getAMViewUsages()
public ViewLinkUsage[] getAMViewLinkUsages()
public AppModuleUsage[] getAMAppModuleUsages()
public AMViewUsage findViewObject(java.lang.String name)
public java.lang.String[] getViewObjectNames()
public java.lang.String[] getViewLinkNames()
public java.lang.String[] getApplicationModuleNames()
public java.lang.String[] getComponentObjectNames()
protected boolean hasViewObject(java.lang.String voName)
protected boolean hasViewLink(java.lang.String vlName)
protected boolean hasApplicationModule(java.lang.String amName)
protected boolean hasComponentObject(java.lang.String compName)
protected ViewObject loadViewObject(ApplicationModule am, java.lang.String voName)
protected ViewLink loadViewLink(ApplicationModule am, java.lang.String vluName)
protected ApplicationModule loadApplicationModule(ApplicationModule am, java.lang.String amName)
protected ComponentObject loadComponentObject(ApplicationModule am, java.lang.String compName)
protected void loadComponents(ApplicationModuleImpl am)
For ViewObjects that are remotable, remote proxy class names are set in here as well.
am
- the ApplicationModule in which these components
are created.public void resolveDefObject()
resolveDefObject
in class MetaObject
public static ApplicationModuleDefImpl createApplicationModuleDef(int defScope, java.lang.String defClassName)
@Deprecated protected static ApplicationModuleDefImpl loadFromXML(DefElement xmlElement)
Loads the XML for the top-level Application Module and creates an instance of ApplicatioModuleDef for it. This function then recursively traverses all of the containee objects in the top-level Applicaton Module and creates Def objects for them.
This function is almost pivotal from runtime's functional point of view.
xmlElement
- the XMLStream for Business Components for Java Framework.
protected static ApplicationModuleDefImpl loadFromXML(DefElement xmlElement, java.lang.String fullName, ApplicationModuleDefImpl aInfo)
Loads the data from the XML stream. The method calls the MetaObjectManager to create an instance of the specific type of object and adds it to the hashtables that cache all the containees of the Application Module. The containees can be View Objects, View Links and Application Modules. The XMLStream is thus traversed to get the corresponding information about each of the possible children for an ApplicationModule, create these objects and add them to the cache.
xmlElement
- represents XMLStream that providesthe JboElement.aInfo
- instance of the ApplicationModuleDef.
public void loadXMLContents(DefElement xmlElement, java.lang.String fullName)
public void loadContainees()
Loads all components (View Objects, View Links, and Application Modules) into this Application Module.
The function loops through the list of View Object, View Link and Application Module names and loads the corresponding objects from a static list of metaobjects maintained by the MetaObjectManager. Since these objects are already created and stored for use in the cache, the retrieval is fast and efficient.
public java.util.ArrayList getViewImports()
public void addViewImport(java.lang.String viewDefName)
public void removeViewImport(java.lang.String viewDefName)
public java.lang.String getDefXMLElementTag()
getDefXMLElementTag
in interface PersistentDefinition
getDefXMLElementTag
in class PersistableDefObject
public void writeContents(DefWriter jos)
PersistentDefinition
writeContents
in interface PersistentDefinition
jos
- the Output storage for persistencepublic void writeChildren(DefWriter jos)
PersistentDefinition
writeChildren
in interface PersistentDefinition
writeChildren
in class MetaObject
jos
- the Output storage for persistencepublic int getDefTypeId()
protected void setDefForComponent(ComponentObjectImpl comp)
protected void unsetDefForComponent(ComponentObjectImpl comp)
protected PackageDefImpl[] getPackageDefs()
public void createApplicationModule(java.lang.String amName, java.lang.String defName, int sharedScope)
public AMViewUsage createViewObject(java.lang.String voName, java.lang.String defName)
public AMViewUsage createViewObjectFromQueryClauses(java.lang.String voName, java.lang.String eoName, java.lang.String selectClause, java.lang.String fromClause, java.lang.String whereClause, java.lang.String orderByClause)
public AMViewUsage createViewObjectFromQueryStmt(java.lang.String voName, java.lang.String queryStatement)
public AMViewUsage createViewObjectFromQueryStmt(java.lang.String voName, java.lang.String queryStatement, java.lang.String voImplClassName)
public void createViewLink(java.lang.String vlName, java.lang.String defName, java.lang.String srcVOName, java.lang.String destVOName)
public void createViewLinkFromEntityAssocName(java.lang.String vlName, java.lang.String entityAssocName, java.lang.String srcVOName, java.lang.String destVOName)
public void createViewLinkBetweenViewObjects(java.lang.String vlName, java.lang.String accessorName, java.lang.String srcVOName, java.lang.String[] srcAttrNames, java.lang.String destVOName, java.lang.String[] destAttrNames, java.lang.String assocClause)
public ApplicationModuleDefImpl.ServiceInterfaceMethod getServiceMethod(java.lang.String methodName, java.lang.Class[] paramTypes)
methodName
- method nameparamTypes
- array of parameter types
public java.lang.String getReturnTypeForServiceMethod(java.lang.String methodName, java.lang.Class[] paramTypes)
methodName
- - method nameparamTypes
- - array of parameter types
public java.lang.String getParameterTypeForServiceMethod(java.lang.String methodName, java.lang.Class[] paramTypes, int paramIndex)
public java.lang.String[] getSvuNames()
public boolean getSvuCanCreate(java.lang.String svuName)
public boolean getSvuCanUpdate(java.lang.String svuName)
public boolean getSvuCanDelete(java.lang.String svuName)
public boolean getSvuCanMerge(java.lang.String svuName)
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 OperationDefinitions getOperationDefinitions()
getOperationDefinitions
in interface OperationDefinitionContainer
protected void loadOperationDefinitions(DefElement xmlElement)
protected final void loadOperationDefinitions(DefElement xmlElement, java.lang.String tag)
public void setName(java.lang.String name)
setName
in class DefinitionObject
name
- the name to be given to this object.public DefinitionObject getBaseDefObject()
getBaseDefObject
in class DefinitionObject
public void setBaseDefObject(DefinitionObject baseDefObject)
setBaseDefObject
in class DefinitionObject
public void setBaseDefObject(DefinitionObject baseDefObject, boolean addToBaseDef)
setBaseDefObject
in class DefinitionObject
protected void resolveReferences()
resolveReferences
in class DefinitionObject
protected void finishedLoading()
finishedLoading
in class PersistableDefObject
protected void setParent(NamedObjectImpl parent)
setParent
in class DefinitionObject
parent
- the named object that is to be the parent of this object.protected void loadProperties(DefElement xmlElement)
loadProperties
in class DefinitionObject
xmlElement
- The XML element to load from.protected void loadVariables(DefElement xmlElement)
public VariableValueManager getVariableManager()
VariableManagerOwnerBase
null
if Variable Value Manager has
been initialized.
When a framework object is first created, its Variable Value Manager may be null. This method does not initialize (create) the Variable Value Manager.
in contrast, ensures
that the Variable Value Manager is initialized (created).
VariableManagerOwnerBase.ensureVariableManager()
getVariableManager
in interface VariableManagerOwnerBase
null
if one was not yet initialized.protected VariableValueManager[] getVarMgrParents()
public boolean hasVariables()
VariableManagerOwnerBase
hasVariables
in interface VariableManagerOwnerBase
public VariableValueManager ensureVariableManager()
VariableManagerOwnerBase
ensureVariableManager
in interface VariableManagerOwnerBase
public java.lang.String getDefXMLNameSpace()
getDefXMLNameSpace
in interface PersistentDefinition
getDefXMLNameSpace
in class PersistableDefObject
protected java.lang.Object resolvePropertyRaw(java.lang.String property, LocaleContext locale)
resolvePropertyRaw
in class NamedObjectImpl
public java.util.HashMap getAllProperties(java.util.HashMap map, LocaleContext locale)
getAllProperties
in class NamedObjectImpl
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1) E10653-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |