|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.7.0) E10653-08 |
||||||||
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.mom.PersDefBase
oracle.jbo.server.PDefComponentObjectBase
oracle.jbo.server.PDefRow
oracle.jbo.server.PDefViewObject
public class PDefViewObject
Nested Class Summary |
---|
Nested classes/interfaces inherited from class oracle.jbo.mom.PersistableDefObject |
---|
PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType |
Field Summary |
---|
Fields inherited from class oracle.jbo.mom.DefinitionObject |
---|
DEF_MDS_CLIENT_KEY, DEF_SCOPE_ALL, 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.ViewCriteriaManager |
---|
DFLT_VIEW_CRITERIA_NAME, IMPLICIT_VIEW_CRITERIA_NAME, QUICKSEARCH_VIEW_CRITERIA_NAME |
Fields inherited from interface oracle.jbo.mom.xml.DefPersistable |
---|
XML_STATEMENT |
Constructor Summary | |
---|---|
PDefViewObject()
|
|
PDefViewObject(ViewDefImpl viewDef)
|
Method Summary | |
---|---|
ViewAttributeDefImpl |
addEntityAttribute(java.lang.String attrName,
java.lang.String entityUsageName,
java.lang.String entityAttrName,
boolean isPersistent)
Adds the named attribute to the view definition. |
ViewAttributeDefImpl |
addViewAttribute(java.lang.String attrName,
java.lang.String expression,
java.lang.Class javaType)
|
ViewAttributeDefImpl |
addViewLinkAccessor(java.lang.String accName,
java.lang.String vlName,
java.lang.Class javaType)
|
void |
addViewLinkDef(ViewLinkDefImpl vlDef)
|
void |
applyPersonalization(java.lang.Object instance)
|
void |
applyPersonalization(java.lang.Object instance,
boolean vcAppend)
|
void |
applyViewCriteria(ViewCriteria criteria)
Apply the view criteria passed as the argument. |
void |
applyViewCriteria(ViewCriteria criteria,
boolean bAppend)
Apply the view crtieria passed as the argument. |
CriteriaClauses |
buildViewCriteriaClauses(ViewCriteria vc)
This method is used by the framework to generate a query clause for a particular view criteria. |
void |
clearViewCriterias()
Clear all view criteria, both applied and unapplied help by this manager |
ViewCriteria |
createViewCriteria()
|
void |
criteriaChanged(ViewCriteria vc)
The criteria manager can track changes to applied view criteria. |
VariableValueManager |
ensureVariableManager()
Returns this object's Variable Value Manager. |
static PDefViewObject |
findDefObject(java.lang.String persDefName)
|
static PDefViewObject |
findDefObjectNoSub(java.lang.String persDefName)
|
DefinitionObject |
findStaticDefinitionObject(java.lang.String fullName)
|
ViewAttributeDefImpl |
findViewAttrDefByBaseAttr(AttributeDefImpl attr)
|
ViewLinkDefImpl |
findViewLinkDef(java.lang.String name)
|
ViewLinkDefImpl |
findViewLinkDefImpl(ViewAttributeDefImpl attrDef)
|
byte |
getAccessMode()
|
static java.lang.String[] |
getAllDefNames()
|
java.lang.String[] |
getAllViewCriteriaNames()
Returns a list of both applied and unapplied view criterias managed by this object. |
ViewCriteria[] |
getAllViewCriterias()
Returns a list of both applied and unapplied view criterias managed by this object. |
java.lang.String[] |
getApplyViewCriteriaNames()
|
ViewCriteria[] |
getApplyViewCriterias(int criteriaMode)
Return a list of applied view criteria that have the mode passed in the argument turned on. |
java.lang.String[] |
getAvailableViewCriteriaNames()
Returns a list of view criteria names that are unapplied and managed by this object |
SortCriteria[] |
getDBSortCriteria()
|
java.lang.String |
getDefXMLNameSpace()
|
byte |
getFetchMode()
|
short |
getFetchSize()
|
int |
getFromClauseFlags()
|
int |
getMaxFetchSize()
|
int |
getNestedSelectForFullSqlValue()
|
java.lang.String |
getOrderByClause()
|
java.lang.String |
getQueryHint()
|
int |
getQueryMode()
|
int |
getRangePagingCacheFactor()
|
int |
getRangeSize()
|
ViewCriteria |
getReqdVC()
|
java.lang.String |
getRowMatch()
|
java.lang.String |
getSelectClause()
|
int |
getSelectClauseFlags()
|
java.lang.String |
getSortBy()
|
java.lang.String |
getUserDefinedQuery()
|
ViewCriteria |
getViewCriteria()
Returns the default view criteria of the manager. |
ViewCriteria |
getViewCriteria(java.lang.String name)
Returns a reference to the view criteria with a specific name if it is found. |
java.lang.String |
getViewCriteriaClause(boolean forQuery)
This method is used by the framework to generate a query clause for the applied view criterias. |
ViewCriteriaManager |
getViewCriteriaManager()
|
int |
getViewLinkAccessorRetainedValue()
|
java.util.List<ViewLinkDefImpl> |
getViewLinkDefs()
|
java.lang.String |
getViewLinkPackage()
|
java.lang.String |
getWhereClause()
|
int |
getWhereClauseFlags()
|
boolean |
isNamedViewLinkAccessorRetained(java.lang.String accName)
Deprecated. since 11.1.1.6.0 For framework internal use only. This api name may change in future builds, so if any consuming layer uses this method, it will require a code-change and recompile. Used to return retained flag for a specific viewlink accessor in this ViewDef. If the accessor is not overridden, this method returns false. |
boolean |
isNestedSelectForFullSql()
|
boolean |
isRemoveDBSortCriteria()
|
boolean |
isViewLinkAccessorRetained()
|
void |
loadXMLAccessorDefContents(DefElement elem)
|
void |
loadXMLAttrDefContents(DefElement elem)
|
void |
loadXMLContents(DefElement xmlElement,
java.lang.String fullName)
|
void |
loadXMLViewLinkDefContents(DefElement elem)
|
ViewLinkDefImpl |
lookupViewLinkDef(java.lang.String name)
|
protected void |
processAccessors()
|
void |
putViewCriteria(java.lang.String name,
ViewCriteria criteria)
Add a view criteria to be managed by this object |
boolean |
removeApplyViewCriteriaName(java.lang.String name)
Unapplied the view criteria if it is applied. |
ViewCriteria |
removeViewCriteria(java.lang.String name)
Removes the view criteria from this manager. |
void |
removeViewLinkDef(java.lang.String name)
|
void |
resetCriteria(ViewCriteria vc)
Resets a view criteria to the state as defined in the View Definition. |
void |
setAccessMode(byte accessMode)
|
void |
setApplyViewCriteriaName(java.lang.String name)
Apply the view criteria name passed as the argument. |
void |
setApplyViewCriteriaName(java.lang.String name,
boolean bAppend)
Apply the view crtieria name passed as the argument. |
void |
setApplyViewCriteriaNames(java.lang.String[] names)
Apply a set of view criteria names passed as the argument. |
void |
setCurrentUnionViewCriteriaName(java.lang.String vcName)
|
void |
setDBSortCriteria(SortCriteria[] sortCrit)
|
void |
setEditable(boolean b)
|
void |
setFetchMode(byte fetchMode)
|
void |
setFetchSize(short fetchSize)
|
void |
setFromClauseFlags(int flags)
|
void |
setFullName(java.lang.String fullName,
boolean setStaticDef)
|
void |
setMaxFetchSize(int maxFetchSize)
|
void |
setNamedViewLinkAccessorRetained(java.lang.String accName,
boolean b)
Deprecated. since 11.1.1.6.0 For framework internal use only. This api name may change in future builds, so if any consuming layer uses this method, it will require a code-change and recompile. Used to set retained flag for a specific viewlink accessor in this ViewDef. If the accessor is not overridden, this method does nothing. |
void |
setNestedSelectForFullSql(boolean b)
|
void |
setOrderByClause(java.lang.String orderByClause)
|
void |
setQueryHint(java.lang.String queryHint)
|
void |
setQueryMode(int queryMode)
|
void |
setRangePagingCacheFactor(int rangePagingCacheFactor)
|
void |
setRangeSize(int rangeSize)
|
void |
setRemoveDBSortCriteria(boolean bRemove)
|
void |
setReqdVC(ViewCriteria vc)
|
void |
setRowMatch(java.lang.String rowMatch)
|
void |
setSelectClause(java.lang.String selectClause)
|
void |
setSelectClauseFlags(int flags)
|
void |
setSortBy(java.lang.String sortBy)
|
protected void |
setStaticDef(DefinitionObject staticDefObj)
|
void |
setUserDefinedQuery(java.lang.String userDefinedQuery)
|
void |
setViewLinkAccessorRetained(boolean b)
|
void |
setWhereClause(java.lang.String whereClause)
|
void |
setWhereClauseFlags(int flags)
|
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 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 |
Constructor Detail |
---|
public PDefViewObject()
public PDefViewObject(ViewDefImpl viewDef)
Method Detail |
---|
public static java.lang.String[] getAllDefNames()
public static PDefViewObject findDefObjectNoSub(java.lang.String persDefName)
public static PDefViewObject findDefObject(java.lang.String persDefName)
public void setEditable(boolean b)
setEditable
in class PDefRow
public void setFullName(java.lang.String fullName, boolean setStaticDef)
setFullName
in class PersDefBase
protected void setStaticDef(DefinitionObject staticDefObj)
setStaticDef
in class PersDefBase
public DefinitionObject findStaticDefinitionObject(java.lang.String fullName)
findStaticDefinitionObject
in interface PersonalizableDef
findStaticDefinitionObject
in class PersDefBase
public java.lang.String getUserDefinedQuery()
public void setUserDefinedQuery(java.lang.String userDefinedQuery)
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)
public java.lang.String getWhereClause()
public void setWhereClause(java.lang.String whereClause)
public java.lang.String getOrderByClause()
public void setOrderByClause(java.lang.String orderByClause)
public java.lang.String getRowMatch()
public void setRowMatch(java.lang.String rowMatch)
public java.lang.String getSortBy()
public void setSortBy(java.lang.String sortBy)
public java.lang.String getQueryHint()
public void setQueryHint(java.lang.String queryHint)
public int getMaxFetchSize()
public void setMaxFetchSize(int maxFetchSize)
public short getFetchSize()
public void setFetchSize(short fetchSize)
public byte getFetchMode()
public void setFetchMode(byte fetchMode)
public int getRangeSize()
public void setRangeSize(int rangeSize)
public byte getAccessMode()
public void setAccessMode(byte accessMode)
public int getRangePagingCacheFactor()
public void setRangePagingCacheFactor(int rangePagingCacheFactor)
public int getQueryMode()
public void setQueryMode(int queryMode)
public int getNestedSelectForFullSqlValue()
public boolean isNestedSelectForFullSql()
public void setNestedSelectForFullSql(boolean b)
public int getViewLinkAccessorRetainedValue()
public boolean isViewLinkAccessorRetained()
public void setViewLinkAccessorRetained(boolean b)
public boolean isNamedViewLinkAccessorRetained(java.lang.String accName)
This api name may change in future builds, so if any consuming layer uses this method, it will require a code-change and recompile.
Used to return retained flag for a specific viewlink accessor in this ViewDef. If the accessor is not overridden, this method returns false.
public void setNamedViewLinkAccessorRetained(java.lang.String accName, boolean b)
This api name may change in future builds, so if any consuming layer uses this method, it will require a code-change and recompile.
Used to set retained flag for a specific viewlink accessor in this ViewDef. If the accessor is not overridden, this method does nothing.
public ViewAttributeDefImpl addViewLinkAccessor(java.lang.String accName, java.lang.String vlName, java.lang.Class javaType)
public java.util.List<ViewLinkDefImpl> getViewLinkDefs()
public ViewLinkDefImpl lookupViewLinkDef(java.lang.String name)
public ViewLinkDefImpl findViewLinkDef(java.lang.String name)
public java.lang.String getViewLinkPackage()
public void addViewLinkDef(ViewLinkDefImpl vlDef)
public void removeViewLinkDef(java.lang.String name)
public ViewAttributeDefImpl addViewAttribute(java.lang.String attrName, java.lang.String expression, java.lang.Class javaType)
public ViewAttributeDefImpl 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 ViewAttributeDefImpl findViewAttrDefByBaseAttr(AttributeDefImpl attr)
public VariableValueManager ensureVariableManager()
VariableManagerOwnerBase
ensureVariableManager
in interface VariableManagerOwnerBase
ensureVariableManager
in class PDefComponentObjectBase
public ViewLinkDefImpl findViewLinkDefImpl(ViewAttributeDefImpl attrDef)
protected void processAccessors()
processAccessors
in class PDefRow
public void applyPersonalization(java.lang.Object instance)
applyPersonalization
in interface PersonalizableDef
applyPersonalization
in class PersDefBase
public void applyPersonalization(java.lang.Object instance, boolean vcAppend)
public void writeChildren(DefWriter jos)
PersistentDefinition
writeChildren
in interface PersistentDefinition
writeChildren
in class PDefRow
jos
- the Output storage for persistencepublic void writeContents(DefWriter jos)
PersistentDefinition
writeContents
in interface PersistentDefinition
writeContents
in class PersDefBase
jos
- the Output storage for persistencepublic void loadXMLContents(DefElement xmlElement, java.lang.String fullName)
loadXMLContents
in class PersDefBase
public void loadXMLAttrDefContents(DefElement elem)
public void loadXMLViewLinkDefContents(DefElement elem)
public void loadXMLAccessorDefContents(DefElement elem)
public ViewCriteria createViewCriteria()
public ViewCriteriaManager getViewCriteriaManager()
public ViewCriteria getViewCriteria(java.lang.String name)
ViewCriteriaManager
getViewCriteria
in interface ViewCriteriaManager
name
- view criteria name
public ViewCriteria[] getAllViewCriterias()
ViewCriteriaManager
getAllViewCriterias
in interface ViewCriteriaManager
public java.lang.String[] getAllViewCriteriaNames()
ViewCriteriaManager
getAllViewCriteriaNames
in interface ViewCriteriaManager
public java.lang.String[] getAvailableViewCriteriaNames()
ViewCriteriaManager
getAvailableViewCriteriaNames
in interface ViewCriteriaManager
public void putViewCriteria(java.lang.String name, ViewCriteria criteria)
ViewCriteriaManager
putViewCriteria
in interface ViewCriteriaManager
name
- Name of the view criteriacriteria
- view criteria referencepublic void clearViewCriterias()
ViewCriteriaManager
clearViewCriterias
in interface ViewCriteriaManager
public ViewCriteria removeViewCriteria(java.lang.String name)
ViewCriteriaManager
removeApplyViewCriteriaName
API.
removeViewCriteria
in interface ViewCriteriaManager
name
- The view criteria name that needs to be removed
public boolean removeApplyViewCriteriaName(java.lang.String name)
ViewCriteriaManager
removeApplyViewCriteriaName
in interface ViewCriteriaManager
name
- The view criteria name that need to be unapplied.
true
if the view criteria was found to be applied,
false
otherwise.public void setCurrentUnionViewCriteriaName(java.lang.String vcName)
setCurrentUnionViewCriteriaName
in interface ViewCriteriaManager
public ViewCriteria getViewCriteria()
ViewCriteriaManager
ViewCriteriaManager.DFLT_VIEW_CRITERIA_NAME
then it is considered to
be the default. The default name is also assigned when a view criteria with
a null name is applied.
getViewCriteria
in interface ViewCriteriaManager
public void applyViewCriteria(ViewCriteria criteria)
ViewCriteriaManager
applyViewCriteria
in interface ViewCriteriaManager
criteria
- the criteria to be applied.public void applyViewCriteria(ViewCriteria criteria, boolean bAppend)
ViewCriteriaManager
bAppend
is true the passed view criteria will be applied in addition
to the existing ones. If bAppend
is false this method is
identical to ViewCriteriaManager.applyViewCriteria(ViewCriteria)
applyViewCriteria
in interface ViewCriteriaManager
criteria
- the criteria to be appliedbAppend
- pass true
if the view criteria needs to be appended to
the applied list otherwise the list is cleared out.public void setApplyViewCriteriaName(java.lang.String name)
ViewCriteriaManager
setApplyViewCriteriaName
in interface ViewCriteriaManager
name
- the criteria to be applied.public void setApplyViewCriteriaName(java.lang.String name, boolean bAppend)
ViewCriteriaManager
bAppend
is true the passed view criteria will be applied in addition
to the existing ones. If bAppend
is false this method is
identical to ViewCriteriaManager.setApplyViewCriteriaName(String)
setApplyViewCriteriaName
in interface ViewCriteriaManager
name
- the criteria to be appliedbAppend
- pass true
if the view criteria needs to be appended to
the applied list otherwise the list is cleared out.public void setApplyViewCriteriaNames(java.lang.String[] names)
ViewCriteriaManager
setApplyViewCriteriaNames
in interface ViewCriteriaManager
names
- the criterias to be applied.public ViewCriteria[] getApplyViewCriterias(int criteriaMode)
ViewCriteriaManager
ViewCriteria.CRITERIA_MODE_CACHE
and
ViewCriteria.CRITERIA_MODE_QUERY
for more information. View criterias
that have both modes turned on are also qualified.
getApplyViewCriterias
in interface ViewCriteriaManager
criteriaMode
- the mode to match the criteria.
public java.lang.String[] getApplyViewCriteriaNames()
getApplyViewCriteriaNames
in interface ViewCriteriaManager
public java.lang.String getViewCriteriaClause(boolean forQuery)
ViewCriteriaManager
getViewCriteriaClause
in interface ViewCriteriaManager
forQuery
- true
if the clause is needed for a database
query, false
for in-memory filtering.
public CriteriaClauses buildViewCriteriaClauses(ViewCriteria vc)
ViewCriteriaManager
ViewCriteriaManager.getViewCriteriaClause(boolean)
buildViewCriteriaClauses
in interface ViewCriteriaManager
vc
- the view criteria whose criteria needs to be generated
public void criteriaChanged(ViewCriteria vc)
ViewCriteriaManager
criteriaChanged
in interface ViewCriteriaManager
vc
- the view criteria that has changedpublic void resetCriteria(ViewCriteria vc)
ViewCriteriaManager
resetCriteria
in interface ViewCriteriaManager
vc
- View Criteria to be resetpublic void setReqdVC(ViewCriteria vc)
public ViewCriteria getReqdVC()
public boolean isRemoveDBSortCriteria()
public void setRemoveDBSortCriteria(boolean bRemove)
public SortCriteria[] getDBSortCriteria()
public void setDBSortCriteria(SortCriteria[] sortCrit)
public java.lang.String getDefXMLNameSpace()
getDefXMLNameSpace
in interface PersistentDefinition
getDefXMLNameSpace
in class PersistableDefObject
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.7.0) E10653-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |