oracle.jbo.server

Class OperationDefinitionsImpl

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.server.DefObject

oracle.jbo.server.OperationDefinitionsImpl

All Implemented Interfaces:

java.io.Serializable, ExprDef, DiffMergeable, DefPersistable, PersistentDefinition, OperationDefinitions, VariableManagerOwner, VariableManagerOwnerBase

public final class OperationDefinitionsImpl
extends DefObject
implements OperationDefinitions, ExprDef

This class represents the metadata for a collection of operation definitions. If a component object has operations, and its definition object has metadata for those operations, then it can be accessed using the method findOperationDefinitions(ComponentObject)

Since:

release specific (what release of product did this appear in)

See Also:

Serialized Form

Nested Class Summary

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

PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType

Nested classes/interfaces inherited from interface oracle.jbo.script.ExprDef

ExprDef.META, ExprDef.OverrideMode, ExprDef.SourceHintProperty, ExprDef.Visibility

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESERVED_DISPLAYNAME For internal framework use only.
static java.lang.String	RESERVED_FLATNAME For internal framework use only.
static java.lang.String	RESERVED_OFFSETS For internal framework use only.

Fields inherited from class oracle.jbo.mom.PersistableDefObject

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.script.ExprDef

BINDING, GROOVY_MIME_TYPE, JI_MIME_TYPE, mLogger, NASHORN_MIME_TYPE, OVERRIDEMODE_PROPERTY, VISIBILITY_PROPERTY

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

XML_STATEMENT

Constructor Summary

Constructors

Constructor and Description
OperationDefinitionsImpl(java.lang.String operType) For internal framework use only.
OperationDefinitionsImpl(java.lang.String operType, java.lang.String fullName) For internal framework use only.

Method Summary

Modifier and Type	Method and Description
OperationDefinitionImpl	addGroovyOperation(java.lang.String id, java.lang.String name, java.lang.String returnType, java.util.LinkedHashMap<java.lang.String,java.lang.String> params, java.lang.String body) For internal framework use only.
OperationDefinitionImpl	addOperation(OperationDefinitionImpl opDef) For internal framework use only.
void	addOperations(OperationDefinitionsImpl newOpDefs) For internal framework use only.
void	applyDiffChildren(DifferDetails dif, DiffResolver resolver) Applies changes to children defs.
OperationDefinitionsImpl	clone() For internal framework use only.
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
static OperationDefinitions	findOperationDefinitions(ComponentObject componentObject) For internal framework use only.
static OperationDefinitions	findOperationDefinitions(Row componentObject) For internal framework use only.
java.lang.String[]	findParameterNames(java.lang.reflect.Method method) For internal framework use only.
java.lang.String[]	findParameterNames(java.lang.String signature) For internal framework use only.
java.lang.Object	getCacheKey(java.lang.String exprStr) The key to be used for caching compiled expression instances.
ExprCodeSource	getCodeSource() Returns the code source that contains the code for this expression.
java.lang.String	getCodeSourceName() Returns the CodeSourceName for this expression.
java.lang.String	getContentType() Return the MIME content type of the expression's script text.
int	getDefTypeId()
java.lang.String	getDefXMLElementTag() For internal framework use only.
java.lang.String	getDefXMLNameSpace() For internal framework use only.
java.lang.String	getExpressionClassName() Returns the name used for the expression class.
java.lang.String	getExprIdentifier() A unique identfier for the expression.
java.lang.String	getFunctionName() Return the name of the script function that should be invoked when evalauting the expression definition.
ExprEval	getGroovyExpr() For internal framework use only.
java.lang.Class	getMessageBundleClass()
java.util.HashMap<java.lang.String,OperationDefinitionImpl>	getOperations() For internal framework use only.
OperationDefinitions	getOperDefValues()
ExprDef.OverrideMode	getOverrideMode() The override mode for the expression.
java.lang.String	getOwnerName() For internal framework use only.
OwnerType	getOwnerType() Returns the type of object that owners the expression class.
java.lang.String	getPath() A dot separated path that may be used to lookup the ExprDef within the ExprDef's owning compnent.
ResourceBundleDef	getResourceBundleDef()
javax.script.CompiledScript	getScript() For internal framework use only.
java.lang.String	getScriptClassName(java.lang.String exprStr) Returns the name used for the expression class.
java.io.Reader	getScriptReader()
java.lang.String	getScriptText()
static java.lang.String	getSignature(java.lang.reflect.Method method)
java.util.List<OperationDefinitionImpl>	getSortedOperations()
java.lang.String	getTriggerType() Return the trigger type.
ExprEval.TrustMode	getTrustMode() The trust mode for the expression.
ExprEval.TypeCheckedMode	getTypeCheckedMode() Returns whether the expresion should be type checked when type checking is enabled for the groovy compiler.
java.lang.String	getUniqueID(java.lang.String prefix) For internal framework use only.
ExprDef.Visibility	getVisibility() The visibility of the expression.
java.lang.String	getXMLElementTag() For internal framework use only.
protected boolean	hasGroovy() For internal framework use only.
boolean	hasReturn() If the expression has a return value.
boolean	isGlobal() For internal framework use only.
boolean	isOperationsExpression() If the expression defines operations.
boolean	isResolved()
static OperationDefinitions	loadOperationDefinitions(DefElement xmlElement, java.lang.String name) For internal framework use only.
void	loadXMLContents(DefElement xmlElement, java.lang.String fullNameFromParent) For internal framework use only.
OperationDefinitionImpl	removeOperation(java.lang.String id) For internal framework use only.
protected void	setDefForComponent(ComponentObjectImpl comp) For internal framework use only.
void	setFullName(java.lang.String fullName) For internal framework use only.
void	setGlobal(boolean global) For internal framework use only.
boolean	supportsAnnotation() Indicates whether ADF can use an expression annotation to select the expression method for invocation.
protected void	unsetDefForComponent(ComponentObjectImpl comp) For internal framework use only.
void	writeChildren(DefWriter jos) For internal framework use only.
void	writeObject(DefWriter jos) For internal framework use only.

Methods inherited from class oracle.jbo.server.DefObject

ensureVariableManager, finishedLoading, getAdfmConfigStartupProperty, getAllProperties, getBaseDefObject, getBooleanAdfmConfigProperty, getVariableManager, getVarMgrParents, hasVariables, isDeprecated, isFromCustomization, loadProperties, loadVariables, resolvePropertyRaw, resolveReferences, setBaseDefObject, setBaseDefObject, setName, setParent

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addDefImport, addExtendedDefObject, addSavedDocName, adjustPropertyMapForWrite, allocatePropertyMap, allocatePropertyMapForEdits, applyDiffContents, beginDiffObjects, checkEditable, checkStructWithOld, close, createFromXML, deregisterDefObject, deregisterSessionObject, diffContents, diffObjects, ensureDifferDetails, findDefImport, getBaseDir, getBasePackage, getDefImports, getDefManager, getDefTypeName, getDefWriter, getEditedPropertiesMap, getEditedPropertyExpressionsMap, getEditedPropertyMap, getEditObject, getEditVersionsAsString, getExtendedDefObjectsInternal, getFileName, getFullDirName, getFullFileName, getMajorVersion, getMergeableFullName, getMergeableName, getMinorVersion, getOrigObject, getPropertyMap, getSavedDocNames, getSessionSyncLock, getSubstitutedNames, getSyncLock, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isCustomizationEnabled, isCustomizationEnabled, isDirty, isEditable, isFromTip, isLoadBase, isMajorVersionChanged, isMinorVersionChanged, isNew, isPersonalizationEnabled, isPersonalizationEnabled, isPropertyExpression, loadDefImports, loadDefObject, loadXMLContentsNoResolve, lockDefinitionContext, mergeChanges, mergePropertyMap, objectRemoved, reapplyChanges, registerClass, registerDefObject, registerSessionDefObject, registerSiteDefObject, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setEditable, setEditableFlag, setEditableObject, setFullNameInternal, setLoadBase, setMajorVersionChanged, setNew, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, setupDefWriterFromMO, staticUpdateChildrenList, unlockDefinitionContext, updateChildrenList, updateMdsKeyFromTip, verifyVersion, verifyVersionNullCheck, writeContents, writeHeaderForNew, writeVersion, writeXMLContents

Methods inherited from class oracle.jbo.mom.DefinitionObject

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

Methods inherited from class oracle.jbo.common.NamedObjectImpl

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.jbo.ExprDef

getProperty

Methods inherited from interface oracle.jbo.VariableManagerOwner

getName

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

getFullName

Field Detail

RESERVED_OFFSETS

@Concealed
public static final java.lang.String RESERVED_OFFSETS

For internal framework use only.

See Also:

Constant Field Values

For internal use only. Application developers should not use this

RESERVED_FLATNAME

@Concealed
public static final java.lang.String RESERVED_FLATNAME

For internal framework use only.

See Also:

Constant Field Values

For internal use only. Application developers should not use this

RESERVED_DISPLAYNAME

@Concealed
public static final java.lang.String RESERVED_DISPLAYNAME

For internal framework use only.

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Constructor Detail

OperationDefinitionsImpl

@Concealed
public OperationDefinitionsImpl(java.lang.String operType)

For internal framework use only.

For internal use only. Application developers should not use this

OperationDefinitionsImpl

@Concealed
public OperationDefinitionsImpl(java.lang.String operType,
                                           java.lang.String fullName)

For internal framework use only.

For internal use only. Application developers should not use this

Method Detail

getSignature

public static java.lang.String getSignature(java.lang.reflect.Method method)

findOperationDefinitions

@Concealed
public static OperationDefinitions findOperationDefinitions(ComponentObject componentObject)

For internal framework use only.

For internal use only. Application developers should not use this

findOperationDefinitions

@Concealed
public static OperationDefinitions findOperationDefinitions(Row componentObject)

For internal framework use only.

For internal use only. Application developers should not use this

loadOperationDefinitions

@Concealed
public static OperationDefinitions loadOperationDefinitions(DefElement xmlElement,
                                                                       java.lang.String name)

For internal framework use only.

For internal use only. Application developers should not use this

getPath

public java.lang.String getPath()

Description copied from interface: ExprDef

A dot separated path that may be used to lookup the ExprDef within the ExprDef's owning compnent. See ComponentOperationsManager#findExprDef.

Specified by:

getPath in interface ExprDef

getOverrideMode

public ExprDef.OverrideMode getOverrideMode()

Description copied from interface: ExprDef

The override mode for the expression.

getVisibility

public ExprDef.Visibility getVisibility()

Description copied from interface: ExprDef

The visibility of the expression.

getScriptReader

public java.io.Reader getScriptReader()

getScriptText

public java.lang.String getScriptText()

getFunctionName

public java.lang.String getFunctionName()

Description copied from interface: ExprDef

Return the name of the script function that should be invoked when evalauting the expression definition.

Returns:

return null if the expression script should be evalauted.

isResolved

public boolean isResolved()

getTrustMode

public ExprEval.TrustMode getTrustMode()

Description copied from interface: ExprDef

The trust mode for the expression.

Specified by:

getTrustMode in interface ExprDef

hasReturn

public boolean hasReturn()

Description copied from interface: ExprDef

If the expression has a return value.

Specified by:

hasReturn in interface ExprDef

getExprIdentifier

public java.lang.String getExprIdentifier()

Description copied from interface: ExprDef

A unique identfier for the expression.

Specified by:

getExprIdentifier in interface ExprDef

getCacheKey

public java.lang.Object getCacheKey(java.lang.String exprStr)

Description copied from interface: ExprDef

The key to be used for caching compiled expression instances.

Specified by:

getCacheKey in interface ExprDef

Returns:

a cacheKey. If null then the compiled expression will not be cached.

getScriptClassName

public java.lang.String getScriptClassName(java.lang.String exprStr)

Description copied from interface: ExprDef

Returns the name used for the expression class.

Specified by:

getScriptClassName in interface ExprDef

getExpressionClassName

public java.lang.String getExpressionClassName()

Description copied from interface: ExprDef

Returns the name used for the expression class.

Specified by:

getExpressionClassName in interface ExprDef

getTypeCheckedMode

public ExprEval.TypeCheckedMode getTypeCheckedMode()

Description copied from interface: ExprDef

Returns whether the expresion should be type checked when type checking is enabled for the groovy compiler.

Specified by:

getTypeCheckedMode in interface ExprDef

Returns:

ExprEval.TypeCheckedMode.always if the expr should always be type checked ExprEval.TypeCheckedMode.never if the expr should never be typ checked ExprEval.TypeCheckedMode.defer if type checking is dependent upon the application configuration

isOperationsExpression

public boolean isOperationsExpression()

Description copied from interface: ExprDef

If the expression defines operations.

Specified by:

isOperationsExpression in interface ExprDef

getOwnerType

public OwnerType getOwnerType()

Description copied from interface: ExprDef

Returns the type of object that owners the expression class.

Specified by:

getOwnerType in interface ExprDef

getCodeSource

public ExprCodeSource getCodeSource()

Description copied from interface: ExprDef

Returns the code source that contains the code for this expression.

getCodeSourceName

public java.lang.String getCodeSourceName()

Description copied from interface: ExprDef

Returns the CodeSourceName for this expression.

getTriggerType

public java.lang.String getTriggerType()

Description copied from interface: ExprDef

Return the trigger type.

Specified by:

getTriggerType in interface ExprDef

Returns:

null if this is not a trigger expression.

supportsAnnotation

public boolean supportsAnnotation()

Description copied from interface: ExprDef

Indicates whether ADF can use an expression annotation to select the expression method for invocation. This is required for some internal expression usages that are not uniquely identified by the annotation. In those cases the framework will use the more unique expression identifier to select the method invocation target.

Specified by:

supportsAnnotation in interface ExprDef

getContentType

public java.lang.String getContentType()

Description copied from interface: ExprDef

Return the MIME content type of the expression's script text. This may be used to select a script engine to evalaute/invoke the expression.

findParameterNames

@Concealed
public java.lang.String[] findParameterNames(java.lang.reflect.Method method)

For internal framework use only.

Specified by:

findParameterNames in interface OperationDefinitions

Returns:

null if the method is not implemented, or if no metadata is available

For internal use only. Application developers should not use this

findParameterNames

@Concealed
public java.lang.String[] findParameterNames(java.lang.String signature)

For internal framework use only.

For internal use only. Application developers should not use this

getOperDefValues

public OperationDefinitions getOperDefValues()

getOperations

@Concealed
public java.util.HashMap<java.lang.String,OperationDefinitionImpl> getOperations()

For internal framework use only.

For internal use only. Application developers should not use this

getSortedOperations

public java.util.List<OperationDefinitionImpl> getSortedOperations()

hasGroovy

protected boolean hasGroovy()

For internal framework use only.

getGroovyExpr

@Concealed
public ExprEval getGroovyExpr()

For internal framework use only.

For internal use only. Application developers should not use this

getScript

@Concealed
public javax.script.CompiledScript getScript()

For internal framework use only.

For internal use only. Application developers should not use this

clone

@Concealed
public OperationDefinitionsImpl clone()

For internal framework use only.

Overrides:

clone in class java.lang.Object

For internal use only. Application developers should not use this

addOperations

@Concealed
public void addOperations(OperationDefinitionsImpl newOpDefs)

For internal framework use only.

For internal use only. Application developers should not use this

addOperation

@Concealed
public OperationDefinitionImpl addOperation(OperationDefinitionImpl opDef)

For internal framework use only.

For internal use only. Application developers should not use this

addGroovyOperation

@Concealed
public OperationDefinitionImpl addGroovyOperation(java.lang.String id,
                                                             java.lang.String name,
                                                             java.lang.String returnType,
                                                             java.util.LinkedHashMap<java.lang.String,java.lang.String> params,
                                                             java.lang.String body)

For internal framework use only.

For internal use only. Application developers should not use this

removeOperation

@Concealed
public OperationDefinitionImpl removeOperation(java.lang.String id)

For internal framework use only.

For internal use only. Application developers should not use this

getDefXMLElementTag

@Concealed
public java.lang.String getDefXMLElementTag()

For internal framework use only.

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class PersistableDefObject

For internal use only. Application developers should not use this

getXMLElementTag

@Concealed
public java.lang.String getXMLElementTag()

For internal framework use only.

Specified by:

getXMLElementTag in interface PersistentDefinition

Overrides:

getXMLElementTag in class PersistableDefObject

Returns:

returns the Statement required to store in Persitent Storage. Incase of XML, it just returns the String. In the case of SQL a JDBC PreparedStatement is returned.

For internal use only. Application developers should not use this

getDefXMLNameSpace

@Concealed
public java.lang.String getDefXMLNameSpace()

For internal framework use only.

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace in class DefObject

For internal use only. Application developers should not use this

setFullName

@Concealed
public void setFullName(java.lang.String fullName)

For internal framework use only.

Overrides:

setFullName in class PersistableDefObject

Parameters:

fullName - this object's fully-qualified name; the package name concatenated with the class name.

For internal use only. Application developers should not use this

getOwnerName

@Concealed
public java.lang.String getOwnerName()

For internal framework use only.

For internal use only. Application developers should not use this

setGlobal

@Concealed
public void setGlobal(boolean global)

For internal framework use only.

For internal use only. Application developers should not use this

isGlobal

@Concealed
public boolean isGlobal()

For internal framework use only.

For internal use only. Application developers should not use this

writeObject

@Concealed
public void writeObject(DefWriter jos)

For internal framework use only.

Specified by:

writeObject in interface PersistentDefinition

Overrides:

writeObject in class PersistableDefObject

Parameters:

jos - the Output storage for persistence

For internal use only. Application developers should not use this

getDefTypeId

public int getDefTypeId()

Specified by:

getDefTypeId in class DefObject

setDefForComponent

protected void setDefForComponent(ComponentObjectImpl comp)

For internal framework use only.

Specified by:

setDefForComponent in class DefObject

unsetDefForComponent

protected void unsetDefForComponent(ComponentObjectImpl comp)

For internal framework use only.

Specified by:

unsetDefForComponent in class DefObject

getResourceBundleDef

public ResourceBundleDef getResourceBundleDef()

Specified by:

getResourceBundleDef in interface VariableManagerOwnerBase

getMessageBundleClass

public java.lang.Class getMessageBundleClass()

Specified by:

getMessageBundleClass in interface VariableManagerOwnerBase

writeChildren

@Concealed
public void writeChildren(DefWriter jos)

For internal framework use only.

Specified by:

writeChildren in interface PersistentDefinition

Overrides:

writeChildren in class DefObject

Parameters:

jos - the Output storage for persistence

For internal use only. Application developers should not use this

loadXMLContents

@Concealed
public void loadXMLContents(DefElement xmlElement,
                                       java.lang.String fullNameFromParent)

For internal framework use only.

Overrides:

loadXMLContents in class PersistableDefObject

For internal use only. Application developers should not use this

getUniqueID

@Concealed
public java.lang.String getUniqueID(java.lang.String prefix)

For internal framework use only.

For internal use only. Application developers should not use this

diffChildren

public DifferDetails diffChildren(DiffMergeable docDef,
                                  DiffMergeable orgDef,
                                  DifferDetails difDetails)

Description copied from interface: DiffMergeable

Performs diff of children defs. This def should enumerate through all its children and diff them and accumulate details of diff into difDetails and return it at the end.

For example, if this def has Child1 and Child2, its implementation should look something like:

    public DifferDetails diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);
       difDetails = diffChildrenChild1(docDef, orgDef, difDetails);

       return difDetails;
    }
 

where diffChildrenChild1() uses DifferChildren's helper method diffChildrenList to diff the child defs.

Specified by:

diffChildren in interface DiffMergeable

Overrides:

diffChildren in class DefObject

Parameters:

docDef - the document-level definition

orgDef - the original definition. It could be null if the definition did not exist originally

difDetails - the DifferDetails that accumulate the details of diff from the document-level (top-level) def

Returns:

the DifferDetails that has all the details of diff

applyDiffChildren

public void applyDiffChildren(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

Applies changes to children defs. dif contains the changes to be applied to the children. For each child def, this method should first retrieve the diff details for the child, which is of type DifferChildren. Then, it should call DifferChildren.applyDiffChanges(oracle.jbo.mom.DiffChildrenMerge, oracle.jbo.mom.DiffResolver) to perform the change operation.

applyChanges() requires a DiffChildrenMerge object, which has the insert, update, and remove methods. 'this' def object must provide implmementation of these operations.

Here is a sample:

    public void applyDiffChildren(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();

       if (detailMap != null)
       {
          DifferChildren difChild1 = (DifferChildren) detailMap.getValue();

          if (difVCs != null)
          {
             DiffChildrenMerge dm = new DiffChildrenMerge()
             {
                public void insertChild(Object id, Object value)
                {
                   .. perform insert op for Child1 ..
                }

                public void updateChild(Object id, Object value, Object oldValue)
                {
                   .. perform update op for Child1 ..
                }

                public void removeChild(Object id)
                {
                   .. perform remove op for Child1 ..
                }
             };

             difChild1.applyDiffChanges(dm, resolver);
          }

          // Similarly for Child2
       }
    }
 

Specified by:

applyDiffChildren in interface DiffMergeable

Overrides:

applyDiffChildren in class DefObject