oracle.jbo.server

Class CodeSourceImpl

java.lang.Object

oracle.jbo.common.NamedObjectImpl

oracle.jbo.mom.DefinitionObject

oracle.jbo.mom.PersistableDefObject

oracle.jbo.server.DefObject

oracle.jbo.server.MetaObject

oracle.jbo.server.CodeSourceImpl

All Implemented Interfaces:

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

public class CodeSourceImpl
extends MetaObject
implements ExprCodeSource

Since:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CodeSourceImpl.MethodSource

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

PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType

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

ExprCodeSource.Type

Field Summary

Fields inherited from class oracle.jbo.server.MetaObject

INHERIT_POLICY_DEFAULT, INHERIT_POLICY_LEGACY, INHERIT_POLICY_STRICT, mComponentClass, mDebug_checkDef_throw, PERSMERGED_BASE_PACKAGE, PUBLISH_TO_BUSINESS_EDITOR_DEFAULT, PUBLISH_TO_BUSINESS_EDITOR_FALSE, PUBLISH_TO_BUSINESS_EDITOR_TRUE, SI_CustIntoStaticDef, SI_InheritPersonalization, SI_InheritPolicy, SI_MessageBundleClass, SI_ResourceBundleDef, SMAX_MetaObject

Fields inherited from class oracle.jbo.mom.PersistableDefObject

JIT_PACKAGE_NAME, mDebugToSkipEmptyDocForBug24949961, mEditedProperties, mEditedPropertyExprs

Fields inherited from class oracle.jbo.mom.DefinitionObject

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

Fields inherited from class oracle.jbo.common.NamedObjectImpl

mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_SUFFIX

Fields inherited from interface oracle.jbo.script.ExprCodeSource

DEFAULT_CODE_SOURCE_NAME, DYNAMIC_CODE_SOURCE_NAME, DYNAMIC_CODESOURCE_DISABLE, DYNAMIC_CODESOURCE_ENABLE, ENTITY_SOURCE_PATH, GLOBAL_SOURCE_PATH, mLogger, MOM_PROTOCOL, PERSONALIZED_CODE_SOURCE_NAME, SCRIPT_CLASS_SOURCE_PATH, TMP_CODE_SOURCE_NAME, VIEW_SOURCE_PATH

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

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

Constructor Summary

Constructors

Constructor and Description
CodeSourceImpl()
CodeSourceImpl(CodeSourceImpl codeSource)
CodeSourceImpl(java.lang.String className, java.lang.String text, java.lang.String contentType)

Method Summary

Modifier and Type	Method and Description
void	addExpression(ExprDef exprDef)
void	applyDiffChildren(DifferDetails dif, DiffResolver resolver) Applies changes to children defs.
int	calculateOffset(ExprDef exprDef)
CodeSourceImpl.MethodSource	createMethodSource(java.lang.String name, java.util.List<java.lang.String> statements, int lineNumber, int lastLineNumber, int columnNumber, int lastColumnNumber)
ExprDef	createScriptClassExprDef()
DifferDetails	diffChildren(DiffMergeable docDef, DiffMergeable orgDef, DifferDetails difDetails) Performs diff of children defs.
static CodeSourceImpl	findDefObject(java.lang.String name)
static CodeSourceImpl	findDefObjectNoCache(java.lang.String name)
static java.util.Set<java.lang.String>	getAllClassNamesFromMDS(int scope) Returns a set of the script Class names in the MDS repository.
java.lang.Object	getCacheKey() The key that should be used to cache the byte code that is generated for the code source.
java.util.Map<java.lang.String,byte[]>	getClassData(java.lang.String name)
java.lang.String	getClassName() The name of the class that will be generated by the compiler for the code source.
java.lang.String	getContentType()
int	getDefTypeId()
java.lang.String	getDefXMLElementTag()
java.lang.String	getDefXMLNameSpace()
java.lang.String	getExpressionSource(ExprDef exprDef)
java.lang.String	getFullFileName()
java.io.Reader	getScriptReader()
java.lang.String	getScriptText()
java.lang.String	getSourceFileName() A name that a debugger source manager may be used to lookup the CodeSource or the script text associated with the CodeSource.
ExprCodeSource.Type	getType()
java.lang.String	getXMLElementTag() Returns a piece of static info for the type of object this is invoked upon.
boolean	hasExpression(ExprDef exprDef) Return true if the CodeSource defines an expression for the specified expresmion.
void	invalidateCache()
static CodeSourceImpl	loadFromXML(DefElement xmlElement)
void	loadXMLContents(DefElement xmlElement, java.lang.String fullName)
ExprDef	lookupExprDef(int linenum)
ExprDef	lookupExprDef(OwnerType type, java.lang.String path)
void	removeExpression(ExprDef exprDef)
void	resolveDefObject()
protected void	setDefForComponent(ComponentObjectImpl comp)
void	setParent(NamedObjectImpl parent) Sets this object's parent.
void	setScriptText(java.lang.String codeSource)
void	setScriptText(java.lang.String text, java.lang.String contentType)
void	storeClassData(java.lang.String name, byte[] classData)
protected void	unsetDefForComponent(ComponentObjectImpl comp)
void	writeChildren(DefWriter jos) Writes the Object's children to the Persistent storage
void	writeContents(DefWriter jos) Objects should write their persistence output in this method

Methods inherited from class oracle.jbo.server.MetaObject

adjustPropertyMapForWrite, checkEditable, createDefCustomizer, deregisterSessionObject, doneLoadingInternal, extractCustIntoPDef, getDefCustomizerFullFileName, getDefCustomizerFullName, getDefCustomizerName, getEditObject, getEditVersionsAsString, getInheritPersonalizationStrValue, getInheritPersonalizationValue, getInheritPolicyStrValue, getInheritPolicyValue, getMajorVersion, getMessageBundleClass, getMinorVersion, getMsgBundleDef, getPackageDef, getPackageName, getPersDef, getPersDefForEdit, getPersDefNoUpdateCheck, getPersMergedDef, getPublishToBusinessEditorValue, getResourceBundleDef, getResourcePrefix, getScalarDirtyCount, getStaticBaseDefObject, getStaticDef, isAutoMerged, isConvertPDef, isCreateEditPDef, isCustIntoStaticDef, isDefCustomizer, isDefNewBase, isDynamic, isEditable, isInheritPersonalization, isInheritPolicyLegacy, isInheritPolicyStrict, isPublishToBusinessEditor, isScalarDirty, loadDefVersions, loadResourceBundle, lookupDefCustomizer, lookupPublishedDefCustomizer, newComponentClassInstance, objectFound, objectRemoved, registerDefObject, registerSessionDefObject, resetDefResolved, saveXMLContents, setCustIntoStaticDef, setDefCustomizer, setDefScope, setDirty, setEditable, setFullName, setInheritPersonalization, setInheritPersonalizationStrValue, setInheritPolicyStrValue, setMessageBundleClass, setPublishToBusinessEditor, setPublishToBusinessEditorValue, setResourceBundleDef, setScalarDirty, setupDefWriterFromMO, writeXMLContents

Methods inherited from class oracle.jbo.server.DefObject

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

Methods inherited from class oracle.jbo.mom.PersistableDefObject

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

Methods inherited from class oracle.jbo.mom.DefinitionObject

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

Methods inherited from class oracle.jbo.common.NamedObjectImpl

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jbo.script.ExprCodeSource

getDefScope, getName

Methods inherited from interface oracle.jbo.VariableManagerOwner

getName

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

getFullName

Methods inherited from interface oracle.jbo.PropertyManager

getProperty, removeProperty, setProperty

Constructor Detail

CodeSourceImpl

public CodeSourceImpl()

For internal use only. Application developers should not use this

CodeSourceImpl

public CodeSourceImpl(java.lang.String className,
                      java.lang.String text,
                      java.lang.String contentType)

For internal use only. Application developers should not use this

CodeSourceImpl

@Concealed
public CodeSourceImpl(CodeSourceImpl codeSource)

For internal use only. Application developers should not use this

Method Detail

setScriptText

public void setScriptText(java.lang.String codeSource)

setParent

public void setParent(NamedObjectImpl parent)

Description copied from class: DefObject

Sets this object's parent.

Overrides:

setParent in class DefObject

Parameters:

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

getClassName

public java.lang.String getClassName()

Description copied from interface: ExprCodeSource

The name of the class that will be generated by the compiler for the code source.

Specified by:

getClassName in interface ExprCodeSource

getSourceFileName

public java.lang.String getSourceFileName()

Description copied from interface: ExprCodeSource

A name that a debugger source manager may be used to lookup the CodeSource or the script text associated with the CodeSource. For example, for CodeSources saved in a ViewDef component operations document this is defined as the viewDef fullname plus the CodeSource name (i.e. mom:view:mypackage.MyView.DynamicCodeSource).

Specified by:

getSourceFileName in interface ExprCodeSource

Returns:

null indicates that source file name information is not available

getCacheKey

public java.lang.Object getCacheKey()

Description copied from interface: ExprCodeSource

The key that should be used to cache the byte code that is generated for the code source. A null key indicates that a cache should not be used.

Specified by:

getCacheKey in interface ExprCodeSource

lookupExprDef

public ExprDef lookupExprDef(OwnerType type,
                             java.lang.String path)

Specified by:

lookupExprDef in interface ExprCodeSource

lookupExprDef

public ExprDef lookupExprDef(int linenum)

Specified by:

lookupExprDef in interface ExprCodeSource

createScriptClassExprDef

@Concealed
public ExprDef createScriptClassExprDef()

For internal use only. Application developers should not use this

getExpressionSource

public java.lang.String getExpressionSource(ExprDef exprDef)

Specified by:

getExpressionSource in interface ExprCodeSource

removeExpression

public void removeExpression(ExprDef exprDef)

Specified by:

removeExpression in interface ExprCodeSource

addExpression

public void addExpression(ExprDef exprDef)
                   throws IllegalImportException

Specified by:

addExpression in interface ExprCodeSource

Throws:

IllegalImportException

calculateOffset

public int calculateOffset(ExprDef exprDef)

Specified by:

calculateOffset in interface ExprCodeSource

getClassData

public java.util.Map<java.lang.String,byte[]> getClassData(java.lang.String name)

Specified by:

getClassData in interface ExprCodeSource

storeClassData

public void storeClassData(java.lang.String name,
                           byte[] classData)

Specified by:

storeClassData in interface ExprCodeSource

hasExpression

public boolean hasExpression(ExprDef exprDef)

Description copied from interface: ExprCodeSource

Return true if the CodeSource defines an expression for the specified expresmion.

Specified by:

hasExpression in interface ExprCodeSource

Parameters:

exprDef - an expression def. If null this will return true if the CodeSource defines any expression.

getScriptReader

public java.io.Reader getScriptReader()

Specified by:

getScriptReader in interface ExprCodeSource

getScriptText

public java.lang.String getScriptText()

Specified by:

getScriptText in interface ExprCodeSource

setScriptText

public void setScriptText(java.lang.String text,
                          java.lang.String contentType)

For internal use only. Application developers should not use this

getFullFileName

public java.lang.String getFullFileName()

Overrides:

getFullFileName in class PersistableDefObject

For internal use only. Application developers should not use this

getDefXMLElementTag

@Concealed
public java.lang.String getDefXMLElementTag()

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()

Description copied from interface: PersistentDefinition

Returns a piece of static info for the type of object this is invoked upon. Examples are PreparedStatements for insert, update, delete, and String containing a base the select statement for retrieving instances of this type through the SQLInputStream

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()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace in class DefObject

For internal use only. Application developers should not use this

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 MetaObject

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 MetaObject

Parameters:

jos - the Output storage for persistence

resolveDefObject

public void resolveDefObject()

Specified by:

resolveDefObject in class MetaObject

For internal use only. Application developers should not use this

getDefTypeId

public int getDefTypeId()

Specified by:

getDefTypeId in class DefObject

For internal use only. Application developers should not use this

setDefForComponent

protected void setDefForComponent(ComponentObjectImpl comp)

Specified by:

setDefForComponent in class DefObject

For internal use only. Application developers should not use this

unsetDefForComponent

protected void unsetDefForComponent(ComponentObjectImpl comp)

Specified by:

unsetDefForComponent in class DefObject

For internal use only. Application developers should not use this

findDefObjectNoCache

public static CodeSourceImpl findDefObjectNoCache(java.lang.String name)

For internal use only. Application developers should not use this

findDefObject

public static CodeSourceImpl findDefObject(java.lang.String name)

For internal use only. Application developers should not use this

loadXMLContents

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

Overrides:

loadXMLContents in class MetaObject

loadFromXML

@Concealed
public static CodeSourceImpl loadFromXML(DefElement xmlElement)

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(<XML-tag-for-Child1>);

          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

getType

public ExprCodeSource.Type getType()

Specified by:

getType in interface ExprCodeSource

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface ExprCodeSource

getAllClassNamesFromMDS

public static java.util.Set<java.lang.String> getAllClassNamesFromMDS(int scope)

Returns a set of the script Class names in the MDS repository. The API will return the canonical class name for each bcs.xml in the MDS repository. The bcx.sml document package/name must match the Class name -- it does not open/parse the classes defined in the bcs.xml CodeSource.

Returns:

a Set of Class names. An empty set if no Class names are found.

createMethodSource

@Concealed
public CodeSourceImpl.MethodSource createMethodSource(java.lang.String name,
                                                                 java.util.List<java.lang.String> statements,
                                                                 int lineNumber,
                                                                 int lastLineNumber,
                                                                 int columnNumber,
                                                                 int lastColumnNumber)

For internal use only. Application developers should not use this

invalidateCache

public void invalidateCache()

Specified by:

invalidateCache in interface ExprCodeSource