public class RowFinder extends DefObject
PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PRIMARY_KEY |
mEditedProperties, mEditedPropertyExprs
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
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIX
XML_STATEMENT
Modifier | Constructor and Description |
---|---|
protected |
RowFinder() |
protected |
RowFinder(NamedObjectImpl parent) |
protected |
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.
|
Modifier and Type | Method and Description |
---|---|
boolean |
areAllVariablesMappedToAttributes()
For internal framework use only.
|
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 |
getFileName() |
java.lang.Class |
getMessageBundleClass() |
java.util.Collection<AttributeDef> |
getParameters(boolean substituteWithAttrDefsInMappedVariables)
Deprecated.
|
ResourceBundleDef |
getResourceBundleDef() |
java.util.ArrayList<BoundParameter> |
getRowFinderParameterList(boolean includeUnmappedVar)
Get a list of parameters for this RowFinder.
|
boolean |
isEditable() |
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) |
protected void |
setParent(NamedObjectImpl parent)
Sets this object's parent.
|
protected void |
unsetDefForComponent(ComponentObjectImpl comp) |
applyDiffChildren, diffChildren, ensureVariableManager, finishedLoading, getAdfmConfigStartupProperty, getAllProperties, getBaseDefObject, getBooleanAdfmConfigProperty, getDefXMLNameSpace, getVariableManager, getVarMgrParents, hasVariables, isDeprecated, isFromCustomization, loadProperties, loadVariables, resolveReferences, setBaseDefObject, setBaseDefObject, setName, writeChildren
addDefImport, addExtendedDefObject, addSavedDocName, adjustPropertyMapForWrite, allocatePropertyMap, allocatePropertyMapForEdits, applyDiffContents, beginDiffObjects, checkEditable, checkStructWithOld, close, createFromXML, deregisterDefObject, deregisterSessionObject, diffContents, diffObjects, ensureDifferDetails, findDefImport, getBaseDir, getBasePackage, getDefImports, getDefManager, getDefTypeName, getDefWriter, getDefXMLElementTag, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getEditVersionsAsString, getExtendedDefObjectsInternal, getFullDirName, getFullFileName, getMajorVersion, getMergeableFullName, getMergeableName, getMinorVersion, getOrigObject, getPropertyMap, getSavedDocNames, getSessionSyncLock, getSubstitutedNames, getSyncLock, getXMLElementTag, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isCustomizationEnabled, isCustomizationEnabled, isDirty, isFromTip, isLoadBase, isMajorVersionChanged, isMinorVersionChanged, isNew, isPersonalizationEnabled, isPersonalizationEnabled, isPropertyExpression, loadDefImports, loadDefObject, loadXMLContents, loadXMLContentsNoResolve, lockDefinitionContext, mergeChanges, mergePropertyMap, objectRemoved, reapplyChanges, registerClass, registerDefObject, registerSessionDefObject, registerSiteDefObject, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setEditable, setEditableFlag, setEditableObject, setFullName, setFullNameInternal, setLoadBase, setMajorVersionChanged, setNew, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, setupDefWriterFromMO, staticUpdateChildrenList, unlockDefinitionContext, updateChildrenList, updateMdsKeyFromTip, verifyVersion, verifyVersionNullCheck, writeContents, writeHeaderForNew, writeObject, writeVersion, writeXMLContents
addPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getContainerDef, getContainerName, getDefinitionState, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, getRootBaseDefObject, isBaseDefFor, isComponentDefinition, isDynamicDefinitionObject, isObjectResolved, isSubtypeOf, isSuppressUpdateCheck, loadCustomProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, setDefScope, setMdsKey, setMdsReference, setObjectResolved, setPropertySetName, staticLoadCustomProperties, staticLoadSchemaProperties, suppressUpdateCheck
getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionDef, getPropertyExpressionsMap, getPropertyNamesSet, getRawPropertyValue, getResourcesFromBundle, getStringFromMessageBundle, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, setPropertiesMap, setPropertiesMap2, setProperty
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getName
getFullName
public static final java.lang.String PRIMARY_KEY
protected RowFinder()
protected RowFinder(NamedObjectImpl parent)
protected 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)
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.protected RowFinder(java.lang.String name, NamedObjectImpl parent, int fetchLimit, boolean errorOnLimit, java.lang.String vcName, boolean mapVarsToAttrs, RowFinderParameters params, boolean payloadHintHide)
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.RowFinderParameters
public boolean isEditable()
isEditable
in class PersistableDefObject
public java.lang.String getFileName()
getFileName
in class PersistableDefObject
protected void setParent(NamedObjectImpl parent)
DefObject
@Concealed public boolean areAllVariablesMappedToAttributes()
@Concealed public java.util.Collection<java.lang.String> getAttributeNames()
protected void loadXMLContents(DefElement xmlElement)
protected void loadRowFinderParameters(DefElement xmlElement, boolean attrFinder)
public RowIterator execute(AttributeList nameValuePairs, RowSet rs)
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 ViewRowSetImplpublic 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 java.lang.Class getMessageBundleClass()
public ResourceBundleDef getResourceBundleDef()
public boolean isPayloadHintHide()
public boolean isPayloadHintHide(LocaleContext locale)
@Concealed public java.util.Collection<AttributeDef> getParameters(boolean substituteWithAttrDefsInMappedVariables)
substituteWithAttrDefsInMappedVariables
- If this flag is true
include the attribute definition instead of the variable.public java.util.ArrayList<BoundParameter> getRowFinderParameterList(boolean includeUnmappedVar)
includeUnmappedVar
- if true, return list will contain all unmapped variable from underlying view criteria
as well as variables in where clause.protected java.lang.Object resolvePropertyRaw(java.lang.String property, LocaleContext locale)
resolvePropertyRaw
in class DefObject