|
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.Object oracle.jbo.common.NamedObjectImpl oracle.jbo.server.NamedObjectImpl oracle.jbo.server.ComponentObjectImpl oracle.jbo.server.ViewObjectImpl oracle.adf.model.bean.DCDataVO
public class DCDataVO
Field Summary | |
---|---|
static java.lang.String |
PROP_VC
|
static java.lang.String |
PROP_VCIVAL_SUBST_ATTRDEF
|
static java.lang.String |
PROP_VO_KIND
|
static java.lang.String |
STR_DEF_NAME
|
static java.lang.String |
VCI_DEF_NAME
|
static java.lang.String |
VCIVAL_ATTR_HAS_TRIGGER
|
static java.lang.String |
VCIVAL_ATTR_ISBIND_NAME
|
static java.lang.String |
VCIVAL_ATTR_VALUE_NAME
|
static java.lang.String |
VCIVAL_DEF_NAME
|
static java.lang.String |
VCO_DEF_NAME
|
static java.lang.String |
VCPROPS_DEF_NAME
|
static int |
VD_KIND_BEAN
|
static int |
VD_KIND_CRITERIA
|
static int |
VD_KIND_CRITERIA_ITEM
|
static int |
VD_KIND_DOMAIN
|
static java.lang.String |
VIEWDEF_SUFFIX
|
Fields inherited from class oracle.jbo.common.NamedObjectImpl |
---|
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX |
Fields inherited from interface oracle.jbo.ViewObject |
---|
IMAGE_LOC, QUERY_MODE_SCAN_DATABASE_TABLES, QUERY_MODE_SCAN_ENTITY_ROWS, QUERY_MODE_SCAN_UNPOSTED_ENTITY_ROWS, QUERY_MODE_SCAN_VIEW_ROWS, QUERY_MODE_SKIP_WHERE, QUERY_TIMEOUT_WAIT_FOREVER, XML_ELEM_PASSIVATE_TRANSIENT |
Fields inherited from interface oracle.jbo.RowSet |
---|
COPY_OPT_ALL_ROWS, COPY_OPT_LIMIT_RANGE, FORWARD_ONLY, RANGE_PAGING, RANGE_PAGING_AUTO_POST, RANGE_PAGING_INCR, SCROLLABLE |
Fields inherited from interface oracle.jbo.RowIterator |
---|
ITER_MODE_LAST_PAGE_FULL, ITER_MODE_LAST_PAGE_PARTIAL, SLOT_BEFORE_FIRST, SLOT_BEYOND_LAST, SLOT_DELETED, SLOT_VALID |
Fields inherited from interface oracle.jbo.XMLInterface |
---|
XML_IGNORE_DEPTH_COUNT, XML_OPT_ALL_ROWS, XML_OPT_ASSOC_CONSISTENT, XML_OPT_CHANGES_ONLY, XML_OPT_LIMIT_RANGE, XML_PASSIVATION_USE |
Fields inherited from interface oracle.jbo.GenericHints |
---|
PROPERTY_LABEL, PROPERTY_LABEL_PLURAL, PROPERTY_TOOLTIP |
Fields inherited from interface oracle.jbo.ViewCriteriaManager |
---|
DFLT_VIEW_CRITERIA_NAME, IMPLICIT_VIEW_CRITERIA_NAME, QUICKSEARCH_VIEW_CRITERIA_NAME |
Constructor Summary | |
---|---|
DCDataVO()
|
Method Summary | |
---|---|
void |
applyViewCriteria(ViewCriteria vc)
Applies the view criteria to this view object. |
void |
clearCache()
Clears the View Object cache. |
void |
closeRowSet()
Closes the row set. |
protected void |
create()
Override from VO to manage keys. |
protected ViewObjectImpl |
createFinderVO(java.lang.String suffix)
|
ViewRowImpl |
createInstance(ViewRowSetImpl viewRowSet,
AttributeList attrValList)
Creates a view row instance. |
protected ViewRowImpl |
createNewRowForCollection(java.lang.Object qcObj)
|
protected ViewRowImpl |
createRowFromResultSet(java.lang.Object qc,
java.sql.ResultSet resultSet)
Override from VO to create row objects for the current entry in the source collection. |
protected ViewRowSetImpl |
createViewAccessorRS(ViewAccessorDef accessorDef,
Row masterRow,
java.lang.Object[] values,
boolean addRSToMasterRow)
|
protected ViewObjectImpl |
createViewLinkAccessorVO(AssociationDefImpl assocDef,
java.lang.String voName,
ViewDefImpl vDef,
ViewLinkDefImpl vlDef)
|
protected java.lang.Object |
doCreateData(DCDataRow row)
|
protected boolean |
doRemoveData(DCDataRow row)
|
protected void |
executeQueryForCollection(java.lang.Object qcObj,
java.lang.Object[] params,
int noUserParams)
Override from VO to execute the other side |
Row[] |
findByKey(Key key,
int maxNumOfRows)
Finds and returns View rows that match the specified key. |
protected ApplicationModule |
getApplicationModuleForLocalViewObject()
|
java.lang.String |
getBeanClassName()
|
long |
getCappedQueryHitCount(ViewRowSetImpl viewRowSet,
Row[] masterRows,
long oldCap,
long cap)
This method executes a count query and returns the number of rows that could end up in the rowset. |
protected DCDataControl |
getDataControl()
|
java.lang.Object |
getDataProvider()
|
java.lang.Object |
getDataProvider(RowSetIterator rsi)
|
protected DefinitionManager |
getDefinitionManager()
|
protected AttributeDef[] |
getFKAttrs()
|
java.util.List |
getForwardDependencyAttributes(java.lang.String attrName)
|
protected java.lang.String |
getFullNameForPersDef()
|
long |
getQueryHitCount(ViewRowSetImpl viewRowSet,
Row[] masterRows)
|
protected boolean |
hasNextForCollection(java.lang.Object qc)
Override from VO to find if the source collection has any more rows. |
void |
initFromMasterAccessor(DCDataControl dc,
RowSetIterator masterRSI,
Row masterRow,
java.lang.String accName,
boolean pin)
|
protected void |
initSource(java.lang.Object obj,
DCDataControl dc)
|
static boolean |
isCriteriaItemType(ViewObject vo)
|
static boolean |
isCriteriaRelatedType(ViewObject vo)
|
static boolean |
isCriteriaType(ViewObject vo)
|
boolean |
isReadOnly()
Tests whether this View Object is read-only. |
AttributeDef |
lookupAttributeDef(java.lang.String name)
Finds a named attribute definition. |
ListBindingDef |
lookupListBindingDef(java.lang.String lbName)
Return listbinding definition if defined in this ViewObject (or in the entity definitions for entities that this ViewObject constitutes of). |
protected void |
notifyRowUpdated(ViewRowSetImpl vrs,
Row[] viewRows,
int[] attrIndices)
|
protected Row[] |
retrieveByKey(ViewRowSetImpl rs,
Key key,
int maxNumOfRows,
boolean skipWhere)
|
void |
setMethodInfo(java.lang.Object iter,
java.lang.String name)
|
void |
setName(java.lang.String name)
Name this object. |
protected void |
substituteAttribute(ViewAttributeDefImpl existingDef,
ViewAttributeDefImpl replacement)
Strictly Internal: Applications should not use this method. |
protected void |
validateRangeSizeForRangePaging(ViewRowSetImpl vrs,
int rangeSize)
Advanced Internal method only. |
Methods inherited from class oracle.jbo.server.NamedObjectImpl |
---|
setParent, setPropertiesMap |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.jbo.StructureDef |
---|
getFullName, getName |
Methods inherited from interface oracle.jbo.RowSet |
---|
getName |
Methods inherited from interface oracle.jbo.VariableManagerOwnerBase |
---|
ensureVariableManager, getMessageBundleClass, getResourceBundleDef, getVariableManager, hasVariables |
Methods inherited from interface oracle.jbo.ComponentObject |
---|
getFullName, getName |
Methods inherited from interface oracle.jbo.GenericHints |
---|
getHintValue, getLabel, getLabelPlural, getTooltip |
Methods inherited from interface oracle.jbo.Properties |
---|
getProperties, getProperty, getProperty, refreshProperty |
Field Detail |
---|
public static final java.lang.String STR_DEF_NAME
public static final java.lang.String PROP_VO_KIND
public static final java.lang.String VCI_DEF_NAME
public static final java.lang.String VCPROPS_DEF_NAME
public static final java.lang.String VCO_DEF_NAME
public static final java.lang.String VCIVAL_DEF_NAME
public static final java.lang.String VCIVAL_ATTR_VALUE_NAME
public static final java.lang.String VCIVAL_ATTR_ISBIND_NAME
public static final java.lang.String VCIVAL_ATTR_HAS_TRIGGER
public static final java.lang.String PROP_VCIVAL_SUBST_ATTRDEF
public static final java.lang.String PROP_VC
public static final int VD_KIND_BEAN
public static final int VD_KIND_DOMAIN
public static final int VD_KIND_CRITERIA
public static final int VD_KIND_CRITERIA_ITEM
public static final java.lang.String VIEWDEF_SUFFIX
Constructor Detail |
---|
public DCDataVO()
Method Detail |
---|
protected void initSource(java.lang.Object obj, DCDataControl dc)
protected void create()
create
in class ComponentObjectImpl
protected java.lang.String getFullNameForPersDef()
getFullNameForPersDef
in class ComponentObjectImpl
public java.lang.String getBeanClassName()
protected ViewObjectImpl createFinderVO(java.lang.String suffix)
createFinderVO
in class ViewObjectImpl
protected ApplicationModule getApplicationModuleForLocalViewObject()
getApplicationModuleForLocalViewObject
in class ViewObjectImpl
protected ViewObjectImpl createViewLinkAccessorVO(AssociationDefImpl assocDef, java.lang.String voName, ViewDefImpl vDef, ViewLinkDefImpl vlDef)
createViewLinkAccessorVO
in class ViewObjectImpl
protected void executeQueryForCollection(java.lang.Object qcObj, java.lang.Object[] params, int noUserParams)
executeQueryForCollection
in class ViewObjectImpl
qcObj
- the query collection about to execute the query.params
- the bind parameters that will be applied to the query.noUserParams
- the number of user bind parameters supplied
through the setWhereClauseParam calls.public void closeRowSet()
RowSet
closeRowSet
removes
this row set from the master row set iterator.
closeRowSet
in interface RowSet
closeRowSet
in class ViewObjectImpl
protected void notifyRowUpdated(ViewRowSetImpl vrs, Row[] viewRows, int[] attrIndices)
notifyRowUpdated
in class ViewObjectImpl
public void applyViewCriteria(ViewCriteria vc)
ViewObject
applyViewCriteria
in interface ViewCriteriaManager
applyViewCriteria
in interface ViewObject
applyViewCriteria
in class ViewObjectImpl
vc
- view criteria to be appliedpublic boolean isReadOnly()
ViewObjectImpl
A View Object is read-only if it does not have a Primary Key, or if all its Entity Objects are read-only.
This method should not be overridden.
isReadOnly
in interface ViewObject
isReadOnly
in class ViewObjectImpl
true
if this View Object is
read-only; false if it is updateable.protected boolean hasNextForCollection(java.lang.Object qc)
hasNextForCollection
in class ViewObjectImpl
protected ViewRowImpl createRowFromResultSet(java.lang.Object qc, java.sql.ResultSet resultSet)
createRowFromResultSet
in class ViewObjectImpl
protected ViewRowImpl createNewRowForCollection(java.lang.Object qcObj)
createNewRowForCollection
in class ViewObjectImpl
public ViewRowImpl createInstance(ViewRowSetImpl viewRowSet, AttributeList attrValList)
ViewObjectImpl
This method is called by ViewObjectImpl.createRow()
.
The view row is created, and if it is a detail row for some View Link,
its foreign key value attributes are initialized.
createInstance
in class ViewObjectImpl
viewRowSet
- the row set requesting the new row instance.attrValList
- a list of attribute values to be used
for initializing the view row.
If it is a detail row for some View Link, this list will
contain foreign key values.
ViewObjectImpl.createRow()
protected Row[] retrieveByKey(ViewRowSetImpl rs, Key key, int maxNumOfRows, boolean skipWhere)
retrieveByKey
in class ViewObjectImpl
public Row[] findByKey(Key key, int maxNumOfRows)
ViewObjectImpl
See
for details.
RowIterator.findByKey(oracle.jbo.Key, int)
findByKey
in interface RowIterator
findByKey
in class ViewObjectImpl
key
- the key to match.maxNumOfRows
- the maximum size of the array to return,
or -1 to return all rows.
RowIterator.getRow(oracle.jbo.Key)
public AttributeDef lookupAttributeDef(java.lang.String name)
ViewObjectImpl
The following code snippet uses this method to find the attribute definitions needed to create a link between two View Objects.
ViewObject voDept = myAM.createViewObject("MyDept", "package1.DeptVO"); ViewObject voEmp = myAM.createViewObject("MyEmp", "package1.EmpVO"); // Build an attribute array, consisting of DeptVO.DeptNum. AttributeDef[] deptAttrs = new AttributeDef[1]; deptAttrs[0] = voDept.findAttributeDef("DeptNum"); // Build an attribute array, consisting of EmpVO.DeptNum. AttributeDef[] empAttrs = new Attributedef[1]; empAttrs[0] = voEmp.findAttributeDef("DeptNum"); ViewLink vl = myAM.createViewLinkBetweenViewObjects("MyLink3", "Employees", // accessor name voDept, // master deptAttrs, voEmp, // detail empAttrs, null); // assoc clauseThis method should not be overridden.
lookupAttributeDef
in interface AttributeDependencyManager
lookupAttributeDef
in interface StructureDef
lookupAttributeDef
in class ViewObjectImpl
name
- the name of the attribute.
name
or null if no
attribute was found.public java.lang.Object getDataProvider()
public java.lang.Object getDataProvider(RowSetIterator rsi)
protected java.lang.Object doCreateData(DCDataRow row)
protected boolean doRemoveData(DCDataRow row)
protected void validateRangeSizeForRangePaging(ViewRowSetImpl vrs, int rangeSize)
validateRangeSizeForRangePaging
in class ViewObjectImpl
protected ViewRowSetImpl createViewAccessorRS(ViewAccessorDef accessorDef, Row masterRow, java.lang.Object[] values, boolean addRSToMasterRow)
createViewAccessorRS
in class ViewObjectImpl
protected AttributeDef[] getFKAttrs()
protected DefinitionManager getDefinitionManager()
getDefinitionManager
in class ComponentObjectImpl
protected DCDataControl getDataControl()
public void setMethodInfo(java.lang.Object iter, java.lang.String name)
public long getCappedQueryHitCount(ViewRowSetImpl viewRowSet, Row[] masterRows, long oldCap, long cap)
cap
argument
so that subclasses may execute a query that aborts the count as soon
as the cap is met.
getCappedQueryHitCount
in class ViewObjectImpl
viewRowSet
- the rowset that will contain the rows when
fetched.masterRows
- the master rows are needed to get the parameters
in a master detail scenario to bind to the row count query.oldCap
- current not used.cap
- the limit on the count expected
public long getQueryHitCount(ViewRowSetImpl viewRowSet, Row[] masterRows)
getQueryHitCount
in class ViewObjectImpl
public void setName(java.lang.String name)
ComponentObjectImpl
setName
in class ComponentObjectImpl
name
- the name to be given to this object.public void initFromMasterAccessor(DCDataControl dc, RowSetIterator masterRSI, Row masterRow, java.lang.String accName, boolean pin)
public void clearCache()
ViewObjectImpl
clearCache
in interface ViewObject
clearCache
in class ViewObjectImpl
protected void substituteAttribute(ViewAttributeDefImpl existingDef, ViewAttributeDefImpl replacement)
ViewObjectImpl
Substitues a existing view attribute definition with a different one. The replacement must have same name and index.
substituteAttribute
in class ViewObjectImpl
public ListBindingDef lookupListBindingDef(java.lang.String lbName)
ViewObject
lookupListBindingDef
in interface ViewObject
lookupListBindingDef
in class ViewObjectImpl
public java.util.List getForwardDependencyAttributes(java.lang.String attrName)
getForwardDependencyAttributes
in interface AttributeDependencyManager
getForwardDependencyAttributes
in interface ViewObject
getForwardDependencyAttributes
in class ViewObjectImpl
public static boolean isCriteriaType(ViewObject vo)
public static boolean isCriteriaItemType(ViewObject vo)
public static boolean isCriteriaRelatedType(ViewObject vo)
|
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 |