Skip navigation links

oracle.jbo.server
Class PDefViewObject

java.lang.Object
oracle.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

All Implemented Interfaces:

ResourceBundleOwner, PersonalizableDef, DefPersistable, PersistentDefinition, VariableManagerOwner, VariableManagerOwnerBase, ViewCriteriaManager

public class PDefViewObject

extends PDefRow

implements ViewCriteriaManager

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_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	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	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 oracle.jbo.server.PDefRow

addListBindingDef, addRowOperation, addScriptRowOperation, addViewAccessorDef, findAttributeDef, findListBindingDef, findRowOperationDefinition, findViewAccessorDef, getAttrDefsMap, getAttributeCount, getAttributeDef, getAttributeDefs, getAttributeDefs2, getAttributeIndexOf, getColumnNameForQuery, getHiddenAttributes, getHiddenAttributesList, getListBindingDefs, getPersonalizedAttributes, getRowOperationDefinitions, getViewAccessorDefs, hideAttribute, lookupAttributeDef, lookupListBindingDef, lookupPersonalizedAttribute, lookupRowOperationDefinition, lookupViewAccessorDef, personalizeAttribute, removeAttribute, removeHiddenAttribute, removeListBindingDef, removePersonalizedAttribute, removeRowOperation, removeViewAccessorDef

Methods inherited from class oracle.jbo.server.PDefComponentObjectBase

addOperation, addScriptOperation, findOperationDefinition, getMessageBundleClass, getOperationDefinitions, getPersonalizedVariables, getResourceBundleDef, getResourcePrefix, getVariableManager, hasPersonalizedComponentOperations, hasVariables, lookupOperationDefinition, lookupPersonalizedVariable, personalizeOperations, personalizeVariable, removeOperation, removePersonalizedVariable, setVariableManager

Methods inherited from class oracle.jbo.mom.PersDefBase

applyPropertiesPersonalization, deregisterDefObject, getBasePackage, getFileName, getStaticDef, getStaticDefWithCheck, getTrimmedFullName, mergePropertyMap, registerDefObject, registerSessionDefObject, removeProperty, resolveDefObject, saveXMLContents, setFullName, setProperty, setPropertyExpression, setPropertyMap

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addDefImport, addExtendedDefObject, allocatePropertyMap, checkEditable, close, createFromXML, deregisterSessionObject, findDefImport, finishedLoading, getBaseDir, getDefImports, getDefManager, getDefWriter, getDefXMLElementTag, getEditObject, getExtendedDefObjectsInternal, getFullDirName, getFullFileName, getOrigObject, getPropertyMap, getSubstitutedNames, getXMLElementTag, guaranteePath, hasExtendedDefObjects, isCustomizationEnabled, isCustomizationEnabled, isDirty, isEditable, isNew, isPersonalizationEnabled, isPersonalizationEnabled, loadDefImports, objectRemoved, registerClass, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setNew, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, updateChildrenList, verifyVersion, writeObject, writeVersion, writeXMLContents

Methods inherited from class oracle.jbo.mom.DefinitionObject

addPropertySetName, enableUpdateCheck, getBaseDefObject, getContainerDef, getContainerName, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, isBaseDefFor, isDynamicDefinitionObject, isObjectResolved, isSuppressUpdateCheck, loadCustomProperties, loadProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, resolveReferences, setBaseDefObject, setBaseDefObject, setDefScope, setMdsKey, setMdsReference, setName, setObjectResolved, setParent, setPropertySetName, suppressUpdateCheck

Methods inherited from class oracle.jbo.common.NamedObjectImpl

getAllProperties, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionsMap, getResourcesFromBundle, getStringFromMessageBundle, isPropertyExpression, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, resolvePropertyRaw, 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

Constructor Detail

PDefViewObject

public PDefViewObject()

PDefViewObject

public PDefViewObject(ViewDefImpl viewDef)

Method Detail

getAllDefNames

public static java.lang.String[] getAllDefNames()

findDefObjectNoSub

public static PDefViewObject findDefObjectNoSub(java.lang.String persDefName)

findDefObject

public static PDefViewObject findDefObject(java.lang.String persDefName)

setEditable

public void setEditable(boolean b)

Overrides:

setEditable in class PDefRow

setFullName

public void setFullName(java.lang.String fullName,
                        boolean setStaticDef)

Overrides:

setFullName in class PersDefBase

setStaticDef

protected void setStaticDef(DefinitionObject staticDefObj)

Overrides:

setStaticDef in class PersDefBase

findStaticDefinitionObject

public DefinitionObject findStaticDefinitionObject(java.lang.String fullName)

Specified by:

findStaticDefinitionObject in interface PersonalizableDef

Specified by:

findStaticDefinitionObject in class PersDefBase

getUserDefinedQuery

public java.lang.String getUserDefinedQuery()

setUserDefinedQuery

public void setUserDefinedQuery(java.lang.String userDefinedQuery)

getSelectClauseFlags

public int getSelectClauseFlags()

setSelectClauseFlags

public void setSelectClauseFlags(int flags)

getFromClauseFlags

public int getFromClauseFlags()

setFromClauseFlags

public void setFromClauseFlags(int flags)

getWhereClauseFlags

public int getWhereClauseFlags()

setWhereClauseFlags

public void setWhereClauseFlags(int flags)

getSelectClause

public java.lang.String getSelectClause()

setSelectClause

public void setSelectClause(java.lang.String selectClause)

getWhereClause

public java.lang.String getWhereClause()

setWhereClause

public void setWhereClause(java.lang.String whereClause)

getOrderByClause

public java.lang.String getOrderByClause()

setOrderByClause

public void setOrderByClause(java.lang.String orderByClause)

getRowMatch

public java.lang.String getRowMatch()

setRowMatch

public void setRowMatch(java.lang.String rowMatch)

getSortBy

public java.lang.String getSortBy()

setSortBy

public void setSortBy(java.lang.String sortBy)

getQueryHint

public java.lang.String getQueryHint()

setQueryHint

public void setQueryHint(java.lang.String queryHint)

getMaxFetchSize

public int getMaxFetchSize()

setMaxFetchSize

public void setMaxFetchSize(int maxFetchSize)

getFetchSize

public short getFetchSize()

setFetchSize

public void setFetchSize(short fetchSize)

getFetchMode

public byte getFetchMode()

setFetchMode

public void setFetchMode(byte fetchMode)

getRangeSize

public int getRangeSize()

setRangeSize

public void setRangeSize(int rangeSize)

getAccessMode

public byte getAccessMode()

setAccessMode

public void setAccessMode(byte accessMode)

getRangePagingCacheFactor

public int getRangePagingCacheFactor()

setRangePagingCacheFactor

public void setRangePagingCacheFactor(int rangePagingCacheFactor)

getQueryMode

public int getQueryMode()

setQueryMode

public void setQueryMode(int queryMode)

getNestedSelectForFullSqlValue

public int getNestedSelectForFullSqlValue()

isNestedSelectForFullSql

public boolean isNestedSelectForFullSql()

setNestedSelectForFullSql

public void setNestedSelectForFullSql(boolean b)

getViewLinkAccessorRetainedValue

public int getViewLinkAccessorRetainedValue()

isViewLinkAccessorRetained

public boolean isViewLinkAccessorRetained()

setViewLinkAccessorRetained

public void setViewLinkAccessorRetained(boolean b)

addViewLinkAccessor

public ViewAttributeDefImpl addViewLinkAccessor(java.lang.String accName,
                                                java.lang.String vlName,
                                                java.lang.Class javaType)

getViewLinkDefs

public java.util.List<ViewLinkDefImpl> getViewLinkDefs()

lookupViewLinkDef

public ViewLinkDefImpl lookupViewLinkDef(java.lang.String name)

findViewLinkDef

public ViewLinkDefImpl findViewLinkDef(java.lang.String name)

getViewLinkPackage

public java.lang.String getViewLinkPackage()

addViewLinkDef

public void addViewLinkDef(ViewLinkDefImpl vlDef)

removeViewLinkDef

public void removeViewLinkDef(java.lang.String name)

addViewAttribute

public ViewAttributeDefImpl addViewAttribute(java.lang.String attrName,
                                             java.lang.String expression,
                                             java.lang.Class javaType)

addEntityAttribute

public ViewAttributeDefImpl addEntityAttribute(java.lang.String attrName,
                                               java.lang.String entityUsageName,
                                               java.lang.String entityAttrName,
                                               boolean isPersistent)

Adds the named attribute to the view definition. This attribute is mapped to an attribute in the entity reference, i.e., the attribute must exist in the underlying entity definition.

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.

Returns:

The View definition object corresponding to the specified name.

Throws:

NoDefException - if the entity attribute is not found.

findViewAttrDefByBaseAttr

public ViewAttributeDefImpl findViewAttrDefByBaseAttr(AttributeDefImpl attr)

ensureVariableManager

public VariableValueManager ensureVariableManager()

Description copied from interface: VariableManagerOwnerBase

Returns this object's Variable Value Manager. If this object current has no Variable Value Manager, it will initialize (create) one.

Specified by:

ensureVariableManager in interface VariableManagerOwnerBase

Overrides:

ensureVariableManager in class PDefComponentObjectBase

Returns:

this object's Variable Value Manager. Will create a Variable Value Manager if this object had no Variable Value Manager.

findViewLinkDefImpl

public ViewLinkDefImpl findViewLinkDefImpl(ViewAttributeDefImpl attrDef)

processAccessors

protected void processAccessors()

Specified by:

processAccessors in class PDefRow

applyPersonalization

public void applyPersonalization(java.lang.Object instance)

Specified by:

applyPersonalization in interface PersonalizableDef

Specified by:

applyPersonalization in class PersDefBase

applyPersonalization

public void applyPersonalization(java.lang.Object instance,
                                 boolean vcAppend)

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 PDefRow

Parameters:

jos - the Output storage for persistence

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 PersDefBase

Parameters:

jos - the Output storage for persistence

loadXMLContents

public void loadXMLContents(DefElement xmlElement,
                            java.lang.String fullName)

Overrides:

loadXMLContents in class PersDefBase

loadXMLAttrDefContents

public void loadXMLAttrDefContents(DefElement elem)

loadXMLViewLinkDefContents

public void loadXMLViewLinkDefContents(DefElement elem)

loadXMLAccessorDefContents

public void loadXMLAccessorDefContents(DefElement elem)

createViewCriteria

public ViewCriteria createViewCriteria()

getViewCriteriaManager

public ViewCriteriaManager getViewCriteriaManager()

getViewCriteria

public ViewCriteria getViewCriteria(java.lang.String name)

Description copied from interface: ViewCriteriaManager

Returns a reference to the view criteria with a specific name if it is found.

Specified by:

getViewCriteria in interface ViewCriteriaManager

Parameters:

name - view criteria name

Returns:

a view criteria reference or null

getAllViewCriterias

public ViewCriteria[] getAllViewCriterias()

Description copied from interface: ViewCriteriaManager

Returns a list of both applied and unapplied view criterias managed by this object.

Specified by:

getAllViewCriterias in interface ViewCriteriaManager

Returns:

an array of view criteria

getAllViewCriteriaNames

public java.lang.String[] getAllViewCriteriaNames()

Description copied from interface: ViewCriteriaManager

Returns a list of both applied and unapplied view criterias managed by this object.

Specified by:

getAllViewCriteriaNames in interface ViewCriteriaManager

Returns:

an array of view criteria names

getAvailableViewCriteriaNames

public java.lang.String[] getAvailableViewCriteriaNames()

Description copied from interface: ViewCriteriaManager

Returns a list of view criteria names that are unapplied and managed by this object

Specified by:

getAvailableViewCriteriaNames in interface ViewCriteriaManager

Returns:

the names of the criteria that can still be applied

putViewCriteria

public void putViewCriteria(java.lang.String name,
                            ViewCriteria criteria)

Description copied from interface: ViewCriteriaManager

Add a view criteria to be managed by this object

Specified by:

putViewCriteria in interface ViewCriteriaManager

Parameters:

name - Name of the view criteria

criteria - view criteria reference

clearViewCriterias

public void clearViewCriterias()

Description copied from interface: ViewCriteriaManager

Clear all view criteria, both applied and unapplied help by this manager

Specified by:

clearViewCriterias in interface ViewCriteriaManager

removeViewCriteria

public ViewCriteria removeViewCriteria(java.lang.String name)

Description copied from interface: ViewCriteriaManager

Removes the view criteria from this manager. If it is applied it is first unapplied and then removed. If the intent is to simply unapply use removeApplyViewCriteriaName API.

Specified by:

removeViewCriteria in interface ViewCriteriaManager

Parameters:

name - The view criteria name that needs to be removed

Returns:

reference to the removed view criteria if found.

removeApplyViewCriteriaName

public boolean removeApplyViewCriteriaName(java.lang.String name)

Description copied from interface: ViewCriteriaManager

Unapplied the view criteria if it is applied. The view criteria will continue to be managed by this manager.

Specified by:

removeApplyViewCriteriaName in interface ViewCriteriaManager

Parameters:

name - The view criteria name that need to be unapplied.

Returns:

true if the view criteria was found to be applied, false otherwise.

setCurrentUnionViewCriteriaName

public void setCurrentUnionViewCriteriaName(java.lang.String vcName)

Specified by:

setCurrentUnionViewCriteriaName in interface ViewCriteriaManager

getViewCriteria

public ViewCriteria getViewCriteria()

Description copied from interface: ViewCriteriaManager

Returns the default view criteria of the manager. If a view criteria has the name as 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.

Specified by:

getViewCriteria in interface ViewCriteriaManager

Returns:

the default view criteria.

applyViewCriteria

public void applyViewCriteria(ViewCriteria criteria)

Description copied from interface: ViewCriteriaManager

Apply the view criteria passed as the argument. If the passed view criteria is not managed by this object it will be added to managed list. The applied criteria name list will first be cleared out and then the view criteria passed as argument is applied. If null is passed as the argument there will be no applied view criteria.

Specified by:

applyViewCriteria in interface ViewCriteriaManager

Parameters:

criteria - the criteria to be applied.

applyViewCriteria

public void applyViewCriteria(ViewCriteria criteria,
                              boolean bAppend)

Description copied from interface: ViewCriteriaManager

Apply the view crtieria passed as the argument. If the passed view criteria is not managed by this object it will be added to managed list. If 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)

Specified by:

applyViewCriteria in interface ViewCriteriaManager

Parameters:

criteria - the criteria to be applied

bAppend - pass true if the view criteria needs to be appended to the applied list otherwise the list is cleared out.

setApplyViewCriteriaName

public void setApplyViewCriteriaName(java.lang.String name)

Description copied from interface: ViewCriteriaManager

Apply the view criteria name passed as the argument. The applied criteria name list will first be cleared out and then the view criteria passed as argument is applied. If null is passed as the argument there will be no applied view criteria.

Specified by:

setApplyViewCriteriaName in interface ViewCriteriaManager

Parameters:

name - the criteria to be applied.

setApplyViewCriteriaName

public void setApplyViewCriteriaName(java.lang.String name,
                                     boolean bAppend)

Description copied from interface: ViewCriteriaManager

Apply the view crtieria name passed as the argument. If 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)

Specified by:

setApplyViewCriteriaName in interface ViewCriteriaManager

Parameters:

name - the criteria to be applied

bAppend - pass true if the view criteria needs to be appended to the applied list otherwise the list is cleared out.

setApplyViewCriteriaNames

public void setApplyViewCriteriaNames(java.lang.String[] names)

Description copied from interface: ViewCriteriaManager

Apply a set of view criteria names passed as the argument. The applied criteria name list will first be cleared out and then the view criterias passed as argument are applied.

Specified by:

setApplyViewCriteriaNames in interface ViewCriteriaManager

Parameters:

names - the criterias to be applied.

getApplyViewCriterias

public ViewCriteria[] getApplyViewCriterias(int criteriaMode)

Description copied from interface: ViewCriteriaManager

Return a list of applied view criteria that have the mode passed in the argument turned on. Refer to ViewCriteria.CRITERIA_MODE_CACHE and ViewCriteria.CRITERIA_MODE_QUERY for more information. View criterias that have both modes turned on are also qualified.

Specified by:

getApplyViewCriterias in interface ViewCriteriaManager

Parameters:

criteriaMode - the mode to match the criteria.

Returns:

An array of matching applied view criterias.

getApplyViewCriteriaNames

public java.lang.String[] getApplyViewCriteriaNames()

Specified by:

getApplyViewCriteriaNames in interface ViewCriteriaManager

Returns:

An array of view criteria names that are currently in the applied state.

getViewCriteriaClause

public java.lang.String getViewCriteriaClause(boolean forQuery)

Description copied from interface: ViewCriteriaManager

This method is used by the framework to generate a query clause for the applied view criterias. If the argument is true the clause will be generated for a database query, if false the clause will be generated for in-memory filtering using an expression evaluator.

Specified by:

getViewCriteriaClause in interface ViewCriteriaManager

Parameters:

forQuery - true if the clause is needed for a database query, false for in-memory filtering.

Returns:

a clause for performing row filtering

buildViewCriteriaClauses

public CriteriaClauses buildViewCriteriaClauses(ViewCriteria vc)

Description copied from interface: ViewCriteriaManager

This method is used by the framework to generate a query clause for a particular view criteria. Used by ViewCriteriaManager.getViewCriteriaClause(boolean)

Specified by:

buildViewCriteriaClauses in interface ViewCriteriaManager

Parameters:

vc - the view criteria whose criteria needs to be generated

Returns:

a reference to an object that store clauses for both database and in-memory filtering

criteriaChanged

public void criteriaChanged(ViewCriteria vc)

Description copied from interface: ViewCriteriaManager

The criteria manager can track changes to applied view criteria. If the structure of an applied view criteria changes or a view criteria item in an applied view criteria has a new value then this method is invoked by the framework so that the manager can initiate a fresh clause generation when required.

Specified by:

criteriaChanged in interface ViewCriteriaManager

Parameters:

vc - the view criteria that has changed

resetCriteria

public void resetCriteria(ViewCriteria vc)

Description copied from interface: ViewCriteriaManager

Resets a view criteria to the state as defined in the View Definition.

Specified by:

resetCriteria in interface ViewCriteriaManager

Parameters:

vc - View Criteria to be reset

setReqdVC

public void setReqdVC(ViewCriteria vc)

getReqdVC

public ViewCriteria getReqdVC()

isRemoveDBSortCriteria

public boolean isRemoveDBSortCriteria()

setRemoveDBSortCriteria

public void setRemoveDBSortCriteria(boolean bRemove)

getDBSortCriteria

public SortCriteria[] getDBSortCriteria()

setDBSortCriteria

public void setDBSortCriteria(SortCriteria[] sortCrit)

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace in class PersistableDefObject

Skip navigation links