oracle.jbo.common

Class ExpressionDef

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.common.ExpressionDef

All Implemented Interfaces:

java.io.Serializable, ExprDef, DiffMergeable, DefPersistable, PersistentDefinition, DebugExprDef

@Concealed
public class ExpressionDef
extends PersistableDefObject
implements java.io.Serializable, DiffMergeable, ExprDef, DebugExprDef

See Also:

Serialized Form

For internal use only. Application developers should not use this

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 int	RESERVED_EXPR_PREAMBLE_LINES 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
ExpressionDef(NamedObjectImpl parent, ExpressionDef def) Create an expression def using a prototype expression def.
ExpressionDef(NamedObjectImpl parent, ExpressionDef def, java.lang.String expr)
ExpressionDef(NamedObjectImpl parent, java.lang.String expr) Deprecated. use #(NamedObjectImpl, ExpressionDef) instead
ExpressionDef(NamedObjectImpl parent, java.lang.String expr, OwnerType ownerType) Deprecated. use #(NamedObjectImpl, ExpressionDef) instead
ExpressionDef(NamedObjectImpl parent, java.lang.String expr, java.lang.String name) Deprecated. use #(NamedObjectImpl, ExpressionDef) instead
ExpressionDef(NamedObjectImpl parent, java.lang.String expr, java.lang.String name, java.lang.String priv) Deprecated. use #(NamedObjectImpl, ExpressionDef) instead
ExpressionDef(NamedObjectImpl parent, java.lang.String expr, java.lang.String name, java.lang.String priv, java.lang.Boolean hasReturn) Deprecated. since 11.1.4.0 Applications should not be using this class.
ExpressionDef(NamedObjectImpl parent, java.lang.String expr, java.lang.String name, java.lang.String priv, java.lang.Boolean hasReturn, OwnerType ownerType) Deprecated. use #(NamedObjectImpl, ExpressionDef) instead
ExpressionDef(java.lang.String name, java.lang.String expr) Deprecated. use #(NamedObjectImpl, ExpressionDef) instead

Method Summary

Modifier and Type	Method and Description
protected java.util.HashMap	adjustPropertyMapForWrite()
void	applyDiffContents(DifferDetails dif, DiffResolver resolver) When diff/merge operation is requested, we have the following three def objects:
void	copyFrom(ExpressionDef def) Copies expression properties from an existing expression.
static ExpressionDef	createAttributeDefaultExpression(java.lang.String expr)
static ExpressionDef	createAttributeRecalcExpression(java.lang.String expr)
static ExpressionDef	createAttributeTransientExpression(java.lang.String expr)
static ExpressionDef	createBoundParameterExpression(java.lang.String expr)
static ExpressionDef	createMessageParameterExpression(java.lang.String expr, java.lang.String name)
static ExpressionDef	createPropertyExpression(java.lang.String expr, java.lang.String propName)
static ExpressionDef	createTriggerExpression(java.lang.String expr, java.lang.String triggerType)
static ExpressionDef	createValidationExpression(java.lang.String expr)
static ExpressionDef	createVariableExpression(java.lang.String expr)
DifferDetails	diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of scalar values.
static ExprCodeSource	ensureCodeSource(java.lang.Object obj, ExprDef exprDef)
DifferDetails	ensureDifferDetails(DifferDetails difDetails) Ensures that we have a valid DifferDetails.
java.util.LinkedHashMap	getAttributesMap()
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.
static ComponentOperationsManager	getComponentOperationsManager(java.lang.Object obj)
java.lang.String	getContentType() Return the MIME content type of the expression's script text.
java.lang.String	getDebugAttrName() Return the attribute name of the expression owner.
java.lang.String	getDebugComponentName() Return the component name of the expression owner.
java.lang.String	getDebugExpressionSource() Return the version of the source that should be displayed in the debugger.
int	getDebugOffset() Return the offset of the start of the debug source in the containing ExprDef::ExpressionSource.
java.lang.String	getDebugTriggerName() Return the name of the trigger or validation rule of the expression.
java.lang.String	getDefXMLElementTag()
java.lang.String	getDefXMLNameSpace()
java.lang.String	getDisplayName()
java.lang.String	getEvalId()
ExprEval	getEvaluator()
java.lang.String	getExpression() Deprecated. since 12.2.1. Using this may result in a performance issue. If necessary, use the CodeSource to access the expression source text.
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	getFullName() Gets this object's fully-qualified name.
java.lang.String	getFunctionName() Return the name of the script function that should be invoked when evalauting the expression definition.
java.util.List<java.lang.String>	getImplicitVariableNames() Return a list of implicit variable names.
java.lang.String	getInternalExpression()
java.lang.String	getName() Get the name of this object.
ExprDef.OverrideMode	getOverrideMode() The override mode for the expression.
java.lang.String	getOwnerName()
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.
ExprEval.Privilege	getPrivilege()
java.lang.String	getPrivilegeString()
java.lang.Object	getProperty(java.lang.String name) Retrieves the specified property, if it exists.
java.lang.String	getScriptClassName(java.lang.String exprStr) Returns the name used for the expression class.
java.io.Reader	getScriptReader()
java.lang.String	getScriptText()
java.lang.String	getTriggerType() Return the trigger type.
ExprEval.TrustMode	getTrustMode() The trust mode for the expression.
java.lang.String	getTrustModeString()
ExprEval.TypeCheckedMode	getTypeCheckedMode() Returns whether the expresion should be type checked when type checking is enabled for the groovy compiler.
ExprDef.Visibility	getVisibility() The visibility of the expression.
boolean	hasReturn() If the expression has a return value.
boolean	isOperationsExpression() If the expression defines operations.
boolean	isResolved()
static java.util.HashMap	loadCDataElementAndAttrsMap(DefElement rootElem, java.lang.String elemName, boolean attrs)
static ExpressionDef	loadExpressionDef(NamedObjectImpl parent, DefElement rootElem, java.lang.String elemName)
static ExpressionDef	loadExpressionDef(NamedObjectImpl parent, DefElement rootElem, java.lang.String elemName, OwnerType ownerType)
static ExpressionDef	loadExpressionDef(NamedObjectImpl parent, java.util.Map map, OwnerType ownerType)
void	removeFromCodeSource()
void	resolveCodeSource()
void	setCodeSourceName(java.lang.String value)
void	setContentType(java.lang.String contentType)
void	setExpression(java.lang.String expr)
void	setFunctionName(java.lang.String functionName)
void	setHasReturn(boolean ret)
void	setName(java.lang.String name) Name this object.
void	setOwnerType(OwnerType type) Deprecated. the expression def identity depends upon the owner type. To change owner type you must construct a new expression def.
void	setPrivilege(ExprEval.Privilege priv)
void	setSupportsAnnotation(boolean supportsAnnotation)
void	setTrustMode(ExprEval.TrustMode trusted)
void	setTypeCheckedMode(ExprEval.TypeCheckedMode typeCheckedMode)
boolean	supportsAnnotation() Indicates whether ADF can use an expression annotation to select the expression method for invocation.
java.lang.String	toString()
void	useEvaluator(ExprEval eval)
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
void	writeExpressionDef(DefWriter jos, java.lang.String elemName) Deprecated. use DefWriter.writeObject(oracle.jbo.mom.xml.DefPersistable) instead.

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addDefImport, addExtendedDefObject, addSavedDocName, allocatePropertyMap, allocatePropertyMapForEdits, applyDiffChildren, beginDiffObjects, checkEditable, checkStructWithOld, close, createFromXML, deregisterDefObject, deregisterSessionObject, diffChildren, diffObjects, findDefImport, finishedLoading, 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, getXMLElementTag, guaranteePath, hasExtendedDefObjects, includeCustomizationLayerInfo, isCustomizationEnabled, isCustomizationEnabled, isDirty, isEditable, 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, writeHeaderForNew, writeObject, writeVersion, writeXMLContents

Methods inherited from class oracle.jbo.mom.DefinitionObject

addPropertySetName, enableUpdateCheck, getAllExtendedDefObjects, getBaseDefObject, getContainerDef, getContainerName, getDefinitionState, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, getRootBaseDefObject, isBaseDefFor, isComponentDefinition, isDeprecated, isDynamicDefinitionObject, isObjectResolved, isSubtypeOf, isSuppressUpdateCheck, loadCustomProperties, loadProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, resolveReferences, setBaseDefObject, setBaseDefObject, setDefScope, setMdsKey, setMdsReference, setObjectResolved, setParent, setPropertySetName, staticLoadCustomProperties, staticLoadSchemaProperties, suppressUpdateCheck

Methods inherited from class oracle.jbo.common.NamedObjectImpl

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jbo.mom.DiffMergeable

applyDiffChildren, beginDiffObjects, diffChildren, diffObjects, getDefTypeName, getMergeableFullName, getMergeableName

Field Detail

RESERVED_EXPR_PREAMBLE_LINES

@Concealed
public static final int RESERVED_EXPR_PREAMBLE_LINES

For internal framework use only

See Also:

Constant Field Values

For internal use only. Application developers should not use this

Constructor Detail

ExpressionDef

@Concealed
public ExpressionDef(NamedObjectImpl parent,
                                java.lang.String expr,
                                java.lang.String name,
                                java.lang.String priv,
                                java.lang.Boolean hasReturn,
                                OwnerType ownerType)

Deprecated. use #(NamedObjectImpl, ExpressionDef) instead

For internal use only. Application developers should not use this

ExpressionDef

@Concealed
public ExpressionDef(NamedObjectImpl parent,
                                java.lang.String expr,
                                java.lang.String name,
                                java.lang.String priv,
                                java.lang.Boolean hasReturn)

Deprecated. since 11.1.4.0 Applications should not be using this class.

For internal use only. Application developers should not use this

ExpressionDef

@Concealed
public ExpressionDef(NamedObjectImpl parent,
                                java.lang.String expr,
                                java.lang.String name,
                                java.lang.String priv)

Deprecated. use #(NamedObjectImpl, ExpressionDef) instead

For internal use only. Application developers should not use this

ExpressionDef

@Concealed
public ExpressionDef(NamedObjectImpl parent,
                                java.lang.String expr,
                                java.lang.String name)

Deprecated. use #(NamedObjectImpl, ExpressionDef) instead

For internal use only. Application developers should not use this

ExpressionDef

@Concealed
public ExpressionDef(NamedObjectImpl parent,
                                java.lang.String expr)

Deprecated. use #(NamedObjectImpl, ExpressionDef) instead

For internal use only. Application developers should not use this

ExpressionDef

@Concealed
public ExpressionDef(NamedObjectImpl parent,
                                java.lang.String expr,
                                OwnerType ownerType)

Deprecated. use #(NamedObjectImpl, ExpressionDef) instead

For internal use only. Application developers should not use this

ExpressionDef

@Concealed
public ExpressionDef(java.lang.String name,
                                java.lang.String expr)

Deprecated. use #(NamedObjectImpl, ExpressionDef) instead

For internal use only. Application developers should not use this

ExpressionDef

public ExpressionDef(NamedObjectImpl parent,
                     ExpressionDef def)

Create an expression def using a prototype expression def. This will create a copy of the prototype ExpressionDef that will be properly resolved and should not be mutated. Mutations to the new ExpressionDef may result in warnings/exceptions. The new ExpressionDef may be used to evaluate expressions.

It is expected that applications use one of the static ExpressionBuilders (e.g. createAttributeTransientExpression(String) to create/edit the prototype ExpressionDef instance before using that instance to create an evaluatable instance using this constructor.

ExpressionDef

public ExpressionDef(NamedObjectImpl parent,
                     ExpressionDef def,
                     java.lang.String expr)

Method Detail

createAttributeTransientExpression

public static ExpressionDef createAttributeTransientExpression(java.lang.String expr)

createAttributeDefaultExpression

public static ExpressionDef createAttributeDefaultExpression(java.lang.String expr)

createAttributeRecalcExpression

public static ExpressionDef createAttributeRecalcExpression(java.lang.String expr)

createBoundParameterExpression

public static ExpressionDef createBoundParameterExpression(java.lang.String expr)

createVariableExpression

public static ExpressionDef createVariableExpression(java.lang.String expr)

createTriggerExpression

public static ExpressionDef createTriggerExpression(java.lang.String expr,
                                                    java.lang.String triggerType)

createValidationExpression

public static ExpressionDef createValidationExpression(java.lang.String expr)

createPropertyExpression

public static ExpressionDef createPropertyExpression(java.lang.String expr,
                                                     java.lang.String propName)

createMessageParameterExpression

public static ExpressionDef createMessageParameterExpression(java.lang.String expr,
                                                             java.lang.String name)

getProperty

public java.lang.Object getProperty(java.lang.String name)

Description copied from class: NamedObjectImpl

Retrieves the specified property, if it exists.

Specified by:

getProperty in interface ExprDef

Overrides:

getProperty in class NamedObjectImpl

Parameters:

name - a string to be used as a hash table key.

Returns:

the value associated with hintName, if any, otherwise null.

copyFrom

public void copyFrom(ExpressionDef def)

Copies expression properties from an existing expression. This does not copy the expression string itself as this is intended to initialize an expression def for a new expression string from an existing expression def.

Throws:

JboException - if the expression def is resolved and this will mutate the expression def.

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

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.

getScriptReader

public java.io.Reader getScriptReader()

getScriptText

public java.lang.String getScriptText()

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

isOperationsExpression

public boolean isOperationsExpression()

Description copied from interface: ExprDef

If the expression defines operations.

Specified by:

isOperationsExpression in interface ExprDef

getEvaluator

@Concealed
public ExprEval getEvaluator()

For internal use only. Application developers should not use this

useEvaluator

@Concealed
public void useEvaluator(ExprEval eval)

For internal use only. Application developers should not use this

getExpression

@Concealed
public java.lang.String getExpression()

Deprecated. since 12.2.1. Using this may result in a performance issue. If necessary, use the CodeSource to access the expression source text.

For internal use only. Application developers should not use this

setExpression

@Concealed
public void setExpression(java.lang.String expr)

For internal use only. Application developers should not use this

getInternalExpression

@Concealed
public java.lang.String getInternalExpression()

For internal use only. Application developers should not use this

Internal framework use only.

getEvalId

@Concealed
public java.lang.String getEvalId()

For internal use only. Application developers should not use this

Internal framework use only.

getName

@Concealed
public java.lang.String getName()

Description copied from class: NamedObjectImpl

Get the name of this object.

Overrides:

getName in class NamedObjectImpl

Returns:

the name given to this object.

For internal use only. Application developers should not use this

setName

@Concealed
public void setName(java.lang.String name)

Description copied from class: DefinitionObject

Name this object.

Overrides:

setName in class DefinitionObject

Parameters:

name - the name to be given to this object.

For internal use only. Application developers should not use this

setHasReturn

@Concealed
public void setHasReturn(boolean ret)

For internal use only. Application developers should not use this

hasReturn

@Concealed
public boolean hasReturn()

Description copied from interface: ExprDef

If the expression has a return value.

Specified by:

hasReturn in interface ExprDef

For internal use only. Application developers should not use this

getFullName

public java.lang.String getFullName()

Description copied from class: NamedObjectImpl

Gets this object's fully-qualified name.

Specified by:

getFullName in interface DefPersistable

Overrides:

getFullName in class NamedObjectImpl

Returns:

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

setPrivilege

@Concealed
public void setPrivilege(ExprEval.Privilege priv)

For internal use only. Application developers should not use this

getPrivilege

@Concealed
public ExprEval.Privilege getPrivilege()

For internal use only. Application developers should not use this

getPrivilegeString

@Concealed
public java.lang.String getPrivilegeString()

For internal use only. Application developers should not use this

setTrustMode

@Concealed
public void setTrustMode(ExprEval.TrustMode trusted)

For internal use only. Application developers should not use this

getTrustMode

@Concealed
public ExprEval.TrustMode getTrustMode()

Description copied from interface: ExprDef

The trust mode for the expression.

Specified by:

getTrustMode in interface ExprDef

For internal use only. Application developers should not use this

getOverrideMode

@Concealed
public ExprDef.OverrideMode getOverrideMode()

Description copied from interface: ExprDef

The override mode for the expression.

For internal use only. Application developers should not use this

getVisibility

@Concealed
public ExprDef.Visibility getVisibility()

Description copied from interface: ExprDef

The visibility of the expression.

For internal use only. Application developers should not use this

getTrustModeString

@Concealed
public java.lang.String getTrustModeString()

For internal use only. Application developers should not use this

getOwnerType

@Concealed
public OwnerType getOwnerType()

Description copied from interface: ExprDef

Returns the type of object that owners the expression class.

Specified by:

getOwnerType in interface ExprDef

For internal use only. Application developers should not use this

getOwnerName

@Concealed
public java.lang.String getOwnerName()

For internal use only. Application developers should not use this

getDisplayName

@Concealed
public java.lang.String getDisplayName()

For internal use only. Application developers should not use this

setOwnerType

@Concealed
public void setOwnerType(OwnerType type)

Deprecated. the expression def identity depends upon the owner type. To change owner type you must construct a new expression def.

For internal framework use only.

For internal use only. Application developers should not use this

getAttributesMap

@Concealed
public java.util.LinkedHashMap getAttributesMap()

For internal use only. Application developers should not use this

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeExpressionDef

public void writeExpressionDef(DefWriter jos,
                               java.lang.String elemName)

Deprecated. use DefWriter.writeObject(oracle.jbo.mom.xml.DefPersistable) instead.

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 PersistableDefObject

Parameters:

jos - the Output storage for persistence

adjustPropertyMapForWrite

protected java.util.HashMap adjustPropertyMapForWrite()

Overrides:

adjustPropertyMapForWrite in class PersistableDefObject

loadExpressionDef

@Concealed
public static ExpressionDef loadExpressionDef(NamedObjectImpl parent,
                                                         DefElement rootElem,
                                                         java.lang.String elemName)

For internal use only. Application developers should not use this

loadExpressionDef

public static ExpressionDef loadExpressionDef(NamedObjectImpl parent,
                                              DefElement rootElem,
                                              java.lang.String elemName,
                                              OwnerType ownerType)

loadExpressionDef

@Concealed
public static ExpressionDef loadExpressionDef(NamedObjectImpl parent,
                                                         java.util.Map map,
                                                         OwnerType ownerType)

For internal use only. Application developers should not use this

loadCDataElementAndAttrsMap

public static java.util.HashMap loadCDataElementAndAttrsMap(DefElement rootElem,
                                                            java.lang.String elemName,
                                                            boolean attrs)

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace in class PersistableDefObject

getDefXMLElementTag

public java.lang.String getDefXMLElementTag()

Specified by:

getDefXMLElementTag in interface PersistentDefinition

Overrides:

getDefXMLElementTag in class PersistableDefObject

ensureDifferDetails

public DifferDetails ensureDifferDetails(DifferDetails difDetails)

Description copied from interface: DiffMergeable

Ensures that we have a valid DifferDetails.

This method is to create a DifferDetails object to be used for diffing if necessary. The difDetails may come in as null. By calling this method, we can ensure that a non-null difDetails is there. So, instead of writing:

    if (difDetails == null)
    {
       difDetails = new DifferDetails(..);
    }
    difDetails.addDiffDetail(..);
 

we can write

    (difDetails = diffMergeable.ensureDifferDetails(difDetails)).addDiffDetail(..);
 

Specified by:

ensureDifferDetails in interface DiffMergeable

Overrides:

ensureDifferDetails in class PersistableDefObject

Parameters:

difDetails - the incoming DifferDetails. It may be null.

Returns:

the same difDetails if it wasn't null coming in, or a new DifferDetails if the incoming difDetails was null

diffContents

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

Description copied from interface: DiffMergeable

Performs diff of scalar values. Typically, scalar attr values are grouped into String, int, and boolean arrays -- one set coming from 'this' definition and the other set coming from orgDef. Then, help methods on DifferBase can be used to diff the attr values and accumulate the details of diff in difDetails.

Here is example code snippet:

    private static final String DIFF_STRING_ELEMS[] =
    {
       "MyStringVal1",
       "MyStringVal2"
    };

    private static final String DIFF_INT_ELEMS[] =
    {
       "MyIntVal",
    }

    public DifferDetails diffContents(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails)
    {
        orgDefImpl = () orgDef;

       final String editStringValues[] =
       {
          this.getMyStringVal1(),
          this.getMyStringVal2()
       };

       String orgStringValues[] = null;

       if (orgDef != null)
       {
          String orgV[] =
          {
             orgDefImpl.getMyStringVal1(),
             orgDefImpl.getMyStringVal2()
          };

          orgStringValues = orgV;
       }

       final int editIntValues[] =
       {
          this.getMyIntVal(),
       };

       int orgIntValues[] = null;

       if (orgDef != null)
       {
          int orgV[] =
          {
             orgDefImpl.getMyIntVal()
          };

          orgIntValues = orgV;
       }

       difDetails = DifferBase.diffStringArray(this, DIFF_STRING_ELEMS, editStringValues, orgStringValues, difDetails);
       difDetails = DifferBase.diffIntArray(this, DIFF_INT_ELEMS, editIntValues, orgIntValues, difDetails);

       return difDetails;
   }
 

Specified by:

diffContents in interface DiffMergeable

Overrides:

diffContents in class PersistableDefObject

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

applyDiffContents

public void applyDiffContents(DifferDetails dif,
                              DiffResolver resolver)

Description copied from interface: DiffMergeable

When diff/merge operation is requested, we have the following three def objects:

orgDef - original def object (from the branch point) editDef - def object into which changes are to be merge toMergeDef - def object to be merged (source of changes) For sandbox refresh operation, orgDef comes from the branch point, editDef from the sandbox, toMergeDef from the mainline of the repos. With these three defs, we first diff editDef against orgDef, producing editDifDetails.

Similarly, toMergeDef is diffed against orgDef, producing toMergeDifDetails. The diff engine then walks through these two sets of diffs and identifies conflicts. After the conflicts are all resolved, we apply appropriate changes to editDef.

applyDiffContents is called to apply changes to scalar values. dif contains the changed values to be applied to 'this' object. Use sample code like the following:

    public void applyDiffContents(DifferDetails dif, DiffResolver resolver)
    {
       DifferChangeMap detailMap = dif.getDetailMap();
       Object[] updValues;

       // DIFF_STRING_ELEMS from the above example code
       for (int j = 0; j < DIFF_STRING_ELEMS.length; j++)
       {
          if ((updValues = (Object[]) detailMap.getValue(DIFF_STRING_ELEMS[j])) != null)
          {
             switch(j)
             {
             case 0:
                setMyStringVal1((String) updValues[0]);
                break;
             case 1:
                 setMyStringVal2((String) updValues[0]);
                break;
             }
          }
       }

       for (int j = 0; j < DIFF_INT_ELEMS.length; j++)
       {
          if ((updValues = (Object[]) detailMap.getValue(DIFF_INT_ELEMS[j])) != null)
          {
             switch(j)
             {
             case 0:
                setMyIntVal((Integer) updValues[0]);
                break;
             }
          }
       }
    }
 

Notice that the index specified in the case statement is the array index of the attr in the String, int, or boolean array.

Specified by:

applyDiffContents in interface DiffMergeable

Overrides:

applyDiffContents in class PersistableDefObject

Parameters:

dif - changes to be applied to 'this' def

resolver - the diff resolver used in diff/merge operation

getImplicitVariableNames

public java.util.List<java.lang.String> getImplicitVariableNames()

Description copied from interface: DebugExprDef

Return a list of implicit variable names. The implicit variable names will appear in the debugger as variables of the expression's operation.

Specified by:

getImplicitVariableNames in interface DebugExprDef

getDebugComponentName

public java.lang.String getDebugComponentName()

Description copied from interface: DebugExprDef

Return the component name of the expression owner. The component name is typically a ViewObject or Entity name.

Specified by:

getDebugComponentName in interface DebugExprDef

getDebugAttrName

public java.lang.String getDebugAttrName()

Description copied from interface: DebugExprDef

Return the attribute name of the expression owner. If this is not an attribute expression return null. Operations always return null.

Specified by:

getDebugAttrName in interface DebugExprDef

getDebugTriggerName

public java.lang.String getDebugTriggerName()

Description copied from interface: DebugExprDef

Return the name of the trigger or validation rule of the expression. Operations always return null.

Specified by:

getDebugTriggerName in interface DebugExprDef

getDebugExpressionSource

public java.lang.String getDebugExpressionSource()

Description copied from interface: DebugExprDef

Return the version of the source that should be displayed in the debugger. The debugger source should only contain the expression body. The details of how operations are organized are hidden from the debugger user.

Specified by:

getDebugExpressionSource in interface DebugExprDef

getDebugOffset

public int getDebugOffset()

Description copied from interface: DebugExprDef

Return the offset of the start of the debug source in the containing ExprDef::ExpressionSource.

Specified by:

getDebugOffset in interface DebugExprDef

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

setTypeCheckedMode

@Concealed
public void setTypeCheckedMode(ExprEval.TypeCheckedMode typeCheckedMode)

For internal use only. Application developers should not use this

resolveCodeSource

@Concealed
public void resolveCodeSource()

For internal use only. Application developers should not use this

isResolved

public boolean isResolved()

removeFromCodeSource

@Concealed
public void removeFromCodeSource()

For internal use only. Application developers should not use this

getCodeSource

@Concealed
public ExprCodeSource getCodeSource()

Description copied from interface: ExprDef

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

For internal use only. Application developers should not use this

ensureCodeSource

@Concealed
public static ExprCodeSource ensureCodeSource(java.lang.Object obj,
                                                         ExprDef exprDef)

For internal use only. Application developers should not use this

getCodeSourceName

@Concealed
public java.lang.String getCodeSourceName()

Description copied from interface: ExprDef

Returns the CodeSourceName for this expression.

For internal use only. Application developers should not use this

setCodeSourceName

@Concealed
public void setCodeSourceName(java.lang.String value)

For internal use only. Application developers should not use this

getComponentOperationsManager

@Concealed
public static ComponentOperationsManager getComponentOperationsManager(java.lang.Object obj)

For internal use only. Application developers should not use this

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.

setContentType

@Concealed
public void setContentType(java.lang.String contentType)

For internal use only. Application developers should not use this

setSupportsAnnotation

@Concealed
public void setSupportsAnnotation(boolean supportsAnnotation)

For internal use only. Application developers should not use this

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.

setFunctionName

@Concealed
public void setFunctionName(java.lang.String functionName)

For internal use only. Application developers should not use this