oracle.jbo.server

Class RowFinder

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.server.DefObject

oracle.jbo.server.RowFinder

All Implemented Interfaces:

DiffMergeable, DiffSkippable, DefPersistable, PersistentDefinition, PropertyManager, VariableManagerOwner, VariableManagerOwnerBase

Direct Known Subclasses:

ViewFilterDefImpl.LOVRowFinder

public class RowFinder
extends DefObject

RowFinder is designed as a generic way to help RowSet to find matching rows by Primary Key, AltKey or ViewCriteria. There are three different kinds RowFinder, AttrValueRowFinder, ExpressionRowFinder and KeyRowFinder. KeyRowFinder will find matching rows by Key or AltKey. It is created during the time when user calls lookupRowFinder() on ViewObject and passes a Key name. The name of KeyRowFinder will be the same as the Key name, except for RowFinder using Primary Key, in which case Key name is null while RowFinder name is PRIMARY_KEY. All the KeyRowFinders are created and managed by framework. There is no xml schema for KeyRowFinder. And it is not allowed to customize or personalize KeyRowFinder. Both AttValueRowFinder and ExpressionRowFinder use ViewCriteria to find matching rows. AttrValueRowFinder assume bind variables are mapped to attribute names in the context of matching rows. While ExpressionRowFinder has the flexibility to map vairables to any transient expressions (or leave it unmapped). User can customize or personalize these two types RowFinders. Also user could have their own RowFinder with different behaviors by overridding this class. In most use cases, user needs to ask for a RowFinder by calling lookupRowFinder() on ViewObject and pass finder name. After getting a RowFinder, they need call execute() on it with correct parameters to get a RowIterator on all matching rows. For KeyRowFinder, user can pass a key as a parameter. For AttrValueRowFinder, user needs to construct an AttributeList (better be a NameValuePairs) which contains map from attribute names to values. For ExpressionRowFinder, user typically specify a Row or a NameValuePairs as the parameter.

Since:

JDeveloper 12.0

Nested Class Summary

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

PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	mIsVarMappedToAttr
protected RowFinderParameters	mRowFinderParameters
static java.lang.String	PRIMARY_KEY

Fields inherited from class oracle.jbo.mom.PersistableDefObject

JIT_PACKAGE_NAME, mDebugToSkipEmptyDocForBug24949961, mEditedProperties, mEditedPropertyExprs

Fields inherited from class oracle.jbo.mom.DefinitionObject

DEF_MDS_CLIENT_KEY, DEF_SCOPE_ALL, DEF_SCOPE_PERS, DEF_SCOPE_SESSION, DEF_SCOPE_SHARED, DEF_SCOPE_SITE, DEF_SCOPE_USER, mBaseDefObject, mExtendedDefObjects, mObjectResolved, PERSDEF_MDS_CLIENT_KEY, PROPERTY_EXPRMAP

Fields inherited from class oracle.jbo.common.NamedObjectImpl

mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIX

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

FLAG_DIRTY, FLAG_EDITABLE, FLAG_FROM_TIP, FLAG_LOAD_BASE, FLAG_LOAD_HL_DEFS, FLAG_MAJOR_VERSION_CHANGED, FLAG_MINOR_VERSION_CHANGED, FLAG_NEW, FLAG_NEW_RECURSE, FLAG_SKIP_WRITE, XML_STATEMENT

Constructor Summary

Constructors

Modifier	Constructor and Description
	RowFinder()
protected	RowFinder(NamedObjectImpl parent)
	RowFinder(NamedObjectImpl parent, java.lang.String name, boolean useKey)
protected	RowFinder(java.lang.String name, NamedObjectImpl parent, int fetchLimit, boolean errorOnLimit, java.lang.String vcName, boolean mapVarsToAttrs, java.util.LinkedHashMap<java.lang.String,java.lang.String> varItemMap) Deprecated.
protected	RowFinder(java.lang.String name, NamedObjectImpl parent, int fetchLimit, boolean errorOnLimit, java.lang.String vcName, boolean mapVarsToAttrs, RowFinderParameters params, boolean payloadHintHide) This constructor is intended to be used by either customization of existing View Object definitions or while creating new View Object definitions during runtime.

Method Summary

Modifier and Type	Method and Description
boolean	areAllVariablesMappedToAttributes() For internal framework use only.
RowFinder	cloneRowFinder()
void	copyFrom(RowFinder other)
RowFinderParameters	ensureRowFinderParameters()
RowIterator	execute(AttributeList nameValuePairs, RowSet rs) This method execute a RowFinder on a RowSet with name value pairs provided by user.
java.util.Collection<java.lang.String>	getAttributeNames() Returns a Collection of attribute names expected by Key RowFinder or AttrValueRowFinder.
int	getDefTypeId()
java.lang.String	getDefXMLElementTag()
int	getFetchLimit()
java.lang.String	getFileName()
java.lang.String	getFinderType()
java.lang.Class	getMessageBundleClass()
java.util.Collection<AttributeDef>	getParameters(boolean substituteWithAttrDefsInMappedVariables) Deprecated.
int	getQueryMode()
ResourceBundleDef	getResourceBundleDef()
java.util.ArrayList<BoundParameter>	getRowFinderParameterList(boolean includeUnmappedVar) Get a list of parameters for this RowFinder.
RowFinderParameters	getRowFinderParameters()
java.lang.String	getVCUsageName()
boolean	isEditable()
boolean	isErrorOnExceedingLimit()
boolean	isPayloadHintHide()
boolean	isPayloadHintHide(LocaleContext locale)
protected void	loadRowFinderParameters(DefElement xmlElement, boolean attrFinder)
protected void	loadXMLContents(DefElement xmlElement)
protected java.lang.Object	resolvePropertyRaw(java.lang.String property, LocaleContext locale)
protected void	setDefForComponent(ComponentObjectImpl comp)
void	setErrorOnExceedingLimit(boolean flag)
void	setFetchLimit(int fetchLimit)
void	setFinderType(java.lang.String typ)
protected void	setParent(NamedObjectImpl parent) Sets this object's parent.
void	setQueryMode(int queryMode)
void	setVCUsageName(java.lang.String VCName)
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.DefObject

addChildren, applyDiffChildren, callFinishedLoading, diffChildren, ensureVariableManager, finishedLoading, getAdfmConfigStartupProperty, getAllProperties, getBaseDefObject, getBooleanAdfmConfigProperty, getDefXMLNameSpace, getVariableManager, getVarMgrParents, hasVariables, isDeprecated, isFromCustomization, loadProperties, loadVariables, resolveReferences, setBaseDefObject, setBaseDefObject, setName

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addDefImport, addExtendedDefObject, addSavedDocName, adjustPropertyMapForWrite, allocatePDef, allocatePropertyMap, allocatePropertyMapForEdits, applyDiffContents, baseIsWriteObject, beginDiffObjects, buildChildName, buildFileName, checkEditable, checkEditableWithDefWriter, checkStructWithOld, close, createEditPDef, createFromXML, deregisterDefObject, deregisterHLDef, deregisterSessionObject, diffChildrenHLDefs, diffChildrenProperties, diffContents, diffObjects, ensureDifferDetails, ensureDifferSkip, extractCustIntoPDef, findDefImport, forgetChanges, getBaseDir, getBasePackage, getChildren, getDefImports, getDefManager, getDefTypeName, getDefWriter, getDifferSkip, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getEditVersionsAsString, getExtendedDefObjectsInternal, getFullDirName, getFullFileName, getHLDefMap, getIdentificationAttributeName, getMajorVersion, getMergeableFullName, getMergeableName, getMinorVersion, getOrigObject, getPropertyMap, getPropertyNamesSet, getSavedDocNames, getSessionSyncLock, getSubstitutedNames, getSyncLock, getXMLElementTag, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isAutoMerged, isCreateEditPDef, isCustomizationEnabled, isCustomizationEnabled, isDirty, isFromTip, isInheritPolicyStrict, isLoadBase, isLoadHLDefs, isMajorVersionChanged, isMinorVersionChanged, isNew, isNewRecurse, isPersonalizationEnabled, isPersonalizationEnabled, isPropertyExpression, isSaveToJSON, isSkipWrite, isWriteObject, loadDefImports, loadDefObject, loadXMLContents, loadXMLContentsNoResolve, lockDefinitionContext, lookupHLDef, makeNew, mergeChanges, mergeEditedPropertiesForJSON, mergePropertyMap, objectRemoved, postSaveContents, readJSONObject, reapplyChanges, registerClass, registerDefObject, registerHLDef, registerSessionDefObject, registerSiteDefObject, reloadFromXMLContents, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveJSONContents, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setEditable, setEditableFlag, setEditableObject, setForRuntime, setFullName, setFullNameInternal, setLoadBase, setLoadHLDefs, setMajorVersionChanged, setNew, setNewRecurse, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, setSkipWrite, setupDefWriterFromMO, setWholeDefDirty, setWholeDefNew, staticUpdateChildrenList, transferDefChangesInto, unlockDefinitionContext, updateChildObject, updateChildrenList, updateMdsKeyFromTip, verifyVersion, verifyVersionNullCheck, writeHeaderForNew, writeJSONContents, writeObject, writeVersion, writeXMLContents

Methods inherited from class oracle.jbo.mom.DefinitionObject

addPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getContainerDef, getContainerName, getDefinitionState, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getMdsReferenceName, getPropertySetName, getPropertySetNames, getRootBaseDefObject, isBaseDefFor, isComponentDefinition, isDynamicDefinitionObject, isObjectResolved, isSubtypeOf, isSuppressUpdateCheck, loadCustomProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, objectFound, objectInserted, setDefScope, setMdsKey, setMdsReference, setObjectResolved, setPropertySetName, staticLoadCustomProperties, staticLoadSchemaProperties, suppressUpdateCheck

Methods inherited from class oracle.jbo.common.NamedObjectImpl

getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionDef, getPropertyExpressionsMap, getPropertyExprEval, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, hasProperty, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setPropertiesMap, setPropertiesMap2, setProperty, setPropertyExpressionMap, setRawPropertyValue

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

Methods inherited from interface oracle.jbo.PropertyManager

getProperty, removeProperty, setProperty

Field Detail

mIsVarMappedToAttr

protected java.lang.Boolean mIsVarMappedToAttr

mRowFinderParameters

protected RowFinderParameters mRowFinderParameters

PRIMARY_KEY

public static final java.lang.String PRIMARY_KEY

See Also:

Constant Field Values

Constructor Detail

RowFinder

public RowFinder()

RowFinder

protected RowFinder(NamedObjectImpl parent)

RowFinder

public RowFinder(NamedObjectImpl parent,
                 java.lang.String name,
                 boolean useKey)

RowFinder

protected RowFinder(java.lang.String name,
                    NamedObjectImpl parent,
                    int fetchLimit,
                    boolean errorOnLimit,
                    java.lang.String vcName,
                    boolean mapVarsToAttrs,
                    java.util.LinkedHashMap<java.lang.String,java.lang.String> varItemMap)

Deprecated.

This constructor is intended to be used by either customization of existing View Object definitions or while creating new View Object definitions during runtime. The changes need to be published to Meta Data repository to take effect. This constructor is only to create RowFinder using ViewCriteria to find mathcing rows. All Key RowFinders are created during runtime and do not allow to be customized.

Parameters:

name - the name of the RowFinder.

parent - the parent of the RowFinder, it could be ViewDefImpl, ViewObjectImpl or PDefViewObject.

fetchLimit - the maximum match rows the RowFinder will return.

errorOnLimit - if throw an error when more than fetchLimit rows found by the RowFinder.

vcName - the name of ViewCriteria used by this RowFinder.

mapVarsToAttrs - if all the bind variables mapped to attributes on ViewObject.

varItemMap - the name mapping between variables and attributes or expressions. Mapping from variables to attributes if mapVarsToAttrs is true, otherwise mapping from variables to transient expressions.

RowFinder

protected RowFinder(java.lang.String name,
                    NamedObjectImpl parent,
                    int fetchLimit,
                    boolean errorOnLimit,
                    java.lang.String vcName,
                    boolean mapVarsToAttrs,
                    RowFinderParameters params,
                    boolean payloadHintHide)

This constructor is intended to be used by either customization of existing View Object definitions or while creating new View Object definitions during runtime. The changes need to be published to Meta Data repository to take effect. This constructor is only to create RowFinder using ViewCriteria to find mathcing rows. All Key RowFinders are created during runtime and do not allow to be customized.

Parameters:

name - the name of the RowFinder.

parent - the parent of the RowFinder, it could be ViewDefImpl, ViewObjectImpl or PDefViewObject.

fetchLimit - the maximum match rows the RowFinder will return.

errorOnLimit - if throw an error when more than fetchLimit rows found by the RowFinder.

vcName - the name of ViewCriteria used by this RowFinder.

mapVarsToAttrs - if all the bind variables mapped to attributes on ViewObject.

params - the name mapping between variables and attributes or expressions. Mapping from variables to attributes if mapVarsToAttrs is true, otherwise mapping from variables to transient expressions. It aslo contains other information such as if variable is required and properties on it.

payloadHint - if this RowFinder is hide from the service payload.

See Also:

RowFinderParameters

Method Detail

copyFrom

public void copyFrom(RowFinder other)

cloneRowFinder

public RowFinder cloneRowFinder()

isEditable

public boolean isEditable()

Overrides:

isEditable in class PersistableDefObject

getFileName

public java.lang.String getFileName()

Overrides:

getFileName in class PersistableDefObject

setParent

protected void setParent(NamedObjectImpl parent)

Description copied from class: DefObject

Sets this object's parent.

Overrides:

setParent in class DefObject

Parameters:

parent - the named object that is to be the parent of this object.

getFinderType

public java.lang.String getFinderType()

setFinderType

public void setFinderType(java.lang.String typ)

isErrorOnExceedingLimit

public boolean isErrorOnExceedingLimit()

setErrorOnExceedingLimit

public void setErrorOnExceedingLimit(boolean flag)

getVCUsageName

public java.lang.String getVCUsageName()

setVCUsageName

public void setVCUsageName(java.lang.String VCName)

getQueryMode

public int getQueryMode()

setQueryMode

public void setQueryMode(int queryMode)

getFetchLimit

public int getFetchLimit()

setFetchLimit

public void setFetchLimit(int fetchLimit)

areAllVariablesMappedToAttributes

@Concealed
public boolean areAllVariablesMappedToAttributes()

For internal framework use only.

For internal use only. Application developers should not use this

getAttributeNames

@Restricted
public java.util.Collection<java.lang.String> getAttributeNames()

Returns a Collection of attribute names expected by Key RowFinder or AttrValueRowFinder. Returns null for ExpressionRowFinder. Application should not modify the returned collection. It should be read only.

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class PersistableDefObject

loadXMLContents

protected void loadXMLContents(DefElement xmlElement)

getRowFinderParameters

public RowFinderParameters getRowFinderParameters()

ensureRowFinderParameters

public RowFinderParameters ensureRowFinderParameters()

loadRowFinderParameters

protected void loadRowFinderParameters(DefElement xmlElement,
                                       boolean attrFinder)

execute

public RowIterator execute(AttributeList nameValuePairs,
                           RowSet rs)

This method execute a RowFinder on a RowSet with name value pairs provided by user. It returns a RowIterator on matching rows. If more than FetchLimit rows found and ErrorOnExceedingLimit is specified to be true, then an RowFinderLimitExceededException will be thrown.

Parameters:

nameValuePairs - The AttributeList contains name value pairs user provided for bind variables. Mostly it will be Key, Row, or NameValuePairs.

rs - the RowSet this RowFinder executes on, typcially it could be ViewObjectImpl or ViewRowSetImpl

Returns:

A RowIterator for matching rows.

getDefTypeId

public int getDefTypeId()

Specified by:

getDefTypeId in class DefObject

setDefForComponent

protected void setDefForComponent(ComponentObjectImpl comp)

Specified by:

setDefForComponent in class DefObject

unsetDefForComponent

protected void unsetDefForComponent(ComponentObjectImpl comp)

Specified by:

unsetDefForComponent in class DefObject

getMessageBundleClass

public java.lang.Class getMessageBundleClass()

getResourceBundleDef

public ResourceBundleDef getResourceBundleDef()

isPayloadHintHide

public boolean isPayloadHintHide()

isPayloadHintHide

public boolean isPayloadHintHide(LocaleContext locale)

getParameters

@Concealed
public java.util.Collection<AttributeDef> getParameters(boolean substituteWithAttrDefsInMappedVariables)

Deprecated.

Return the list of variables in the Finder. This API can only be invoked when the RowFinder is obtained from a view object instance.

Parameters:

substituteWithAttrDefsInMappedVariables - If this flag is true include the attribute definition instead of the variable.

Returns:

the list of parameters in the finder

For internal use only. Application developers should not use this

getRowFinderParameterList

public java.util.ArrayList<BoundParameter> getRowFinderParameterList(boolean includeUnmappedVar)

Get a list of parameters for this RowFinder. Caller should not modify the returned list. This API can only be invoked when the RowFinder is obtained from a view object instance.

Parameters:

includeUnmappedVar - if true, return list will contain all unmapped variable from underlying view criteria as well as variables in where clause.

resolvePropertyRaw

protected java.lang.Object resolvePropertyRaw(java.lang.String property,
                                              LocaleContext locale)

Overrides:

resolvePropertyRaw in class DefObject

writeContents

public void writeContents(DefWriter jos)

Description copied from interface: PersistentDefinition

Objects should write their persistence output in this method

Specified by:

writeContents in interface PersistentDefinition

Overrides:

writeContents in class PersistableDefObject

Parameters:

jos - the Output storage for persistence

writeChildren

public void writeChildren(DefWriter jos)

Description copied from interface: PersistentDefinition

Writes the Object's children to the Persistent storage

Specified by:

writeChildren in interface PersistentDefinition

Overrides:

writeChildren in class DefObject

Parameters:

jos - the Output storage for persistence