oracle.forms.jdapi

Class JdapiModule

java.lang.Object

oracle.forms.jdapi.BaseFormsObject

oracle.forms.jdapi.JdapiModule

All Implemented Interfaces:

JdapiObject

Direct Known Subclasses:

FormModule, MenuModule, ObjectLibrary, PlsqlModule

public abstract class JdapiModule
extends BaseFormsObject

This is the base object from which all Jdapi module objects are derived. JdapiModule is an abstract class and indirectly implements JdapiObject. This class provides methods for loading, managing, and referring generically to different module types.

The class is the supertype for all of the concrete module classes. The classes that define the different module types, FormModule, MenuModule, PlsqlModule, ObjectLibrary all extend JdapiModule.

The methods in JdapiModule let you work with modules generically. For example, you can write code to open modules in a list and refer to them as JdapiModule types. You do not have to worry about the specific type of module you are working with. For example:

     ...
     // get the module list from the session... 
         JdapiIterator mods = Jdapi.getModules(); 
         // ... and iterate round them 
         while(mods.hasNext()) 
         { 
           JdapiModule mod = (JdapiModule)mods.next(); 
           // getStringProperty(JdapiTypes.NAME_PTID) is equivalent to getName()
           String moduleName = mod.getName(); 
           System.out.println("Module Name: " + moduleName);
           ...
 

Field Summary

Fields inherited from class oracle.forms.jdapi.BaseFormsObject

m_clientInfo, m_pd2fob

Fields inherited from interface oracle.forms.jdapi.JdapiObject

PROPERTY_DEFAULT_VALUE, PROPERTY_INHERITED_VALUE, PROPERTY_OVERRIDDEN_DEFAULT_VALUE, PROPERTY_OVERRIDDEN_INHERITED_VALUE, PROPERTY_STATE_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JdapiModule(long pd2fob) Constructor used by derived classes.

Method Summary

Modifier and Type	Method and Description
void	compile_all() Compiles all the pl/sql in the module.
abstract void	compile() Compiles the module instance to the file system.
void	destroy() Destroys the object - this removes the object from its context.
java.lang.String	getAbsolutePath() Returns the most recent location of this module on the file system.
static long	getModulesProductVersion(java.lang.String fileName) Returns the product version used to create the specified module.
static JdapiModule	openModule(java.io.File f) Loads a module from the file system.
static JdapiModule	openModule(java.io.File f, java.lang.String formsPath) Loads a module from the file system.
static JdapiModule	openModule(java.lang.String fileName) Loads a module from the file system.
static JdapiModule	openModule(java.lang.String fileName, java.lang.String formsPath) Loads a module from the filesystem.
abstract void	save(java.lang.String fileName) Saves the module instance to the file system.
protected void	setAbsolutePath(java.lang.String path) Sets the most recent location of this module on the file system.

Methods inherited from class oracle.forms.jdapi.BaseFormsObject

changeOwner, clearObjectPointer, clone, createSubclassedChild, equals, getBooleanProperty, getChildObjectProperty, getClassName, getClientInfo, getIntegerProperty, getIntegerPropertyString, getJdapiMetaObject, getMetaProperties, getModule, getName, getObjectPointer, getObjectProperty, getObjProp, getOwnedObjects, getOwner, getPersistentClientInfoBlob, getPersistentClientInfoObject, getPropertyState, getPropertyValueName, getQualifiedName, getStringIDProperty, getStringProperty, getSubclassParent, getTypeId, hasDefaultedProperty, hasInheritedProperty, hasOverriddenProperty, hasProperty, inheritProperty, isSubclassed, isValidFormsObject, move, queryType, reattach, setBooleanProperty, setClientInfo, setIntegerProperty, setObjectProperty, setObjProp, setPersistentClientInfo, setPersistentClientInfo, setStringProperty, setSubclassParent, toString, unsetSubclassParent

Methods inherited from class java.lang.Object

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

Constructor Detail

JdapiModule

protected JdapiModule(long pd2fob)

Constructor used by derived classes. If the object pointer is not null, the newly created object will register itself with the context to which it belongs.

Parameters:

pd2fob - C pointer to the Forms module object.

Method Detail

getAbsolutePath

public java.lang.String getAbsolutePath()

Returns the most recent location of this module on the file system. Modules are loaded from a specific path. Storing the absolute path is one technique that the system uses to ensure uniqueness between modules eventhough they might have the same file name. The path is updated every time the module is opened and saved. If you save the module somewhere else, the absolute path is updated.

The method returns null if it is called on a newly created module. This is because the path is not set until the module is saved.

Returns:

the absolute path to the module; null for newly created modules.

setAbsolutePath

protected void setAbsolutePath(java.lang.String path)

Sets the most recent location of this module on the file system.

Parameters:

path - String representing the location the file was opened from (or saved to) on the file system.

getModulesProductVersion

public static long getModulesProductVersion(java.lang.String fileName)

Returns the product version used to create the specified module.

Parameters:

fileName - the file name of the module.

Returns:

version of the product used to create the module.

openModule

public static JdapiModule openModule(java.lang.String fileName)

Loads a module from the file system. The module is returned cast as a JdapiModule object so that you can work with it generically.

A runtime exception is thrown if a module the file has subclassed from cannot be found on the Forms path. This behaviour can be suppressed with the setFailSubclassLoad method.

Parameters:

fileName - file name of a module to load.

Returns:

a Forms module (FormModule, ObjectLibrary, MenuModule or PlsqlModule) cast as a JdapiModule.

openModule

public static JdapiModule openModule(java.io.File f)

Loads a module from the file system. The module is returned cast as a JdapiModule object so that you can work with it generically.

A runtime exception is thrown if a module the file has subclassed from cannot be found on the Forms path. This behaviour can be suppressed with the setFailSubclassLoad method.

Parameters:

f - File object of module to load.

Returns:

a Forms module (FormModule, ObjectLibrary, MenuModule or PlsqlModule) cast as a JdapiModule.

openModule

public static JdapiModule openModule(java.lang.String fileName,
                                     java.lang.String formsPath)

Loads a module from the filesystem. The module is returned cast as a JdapiModule object so that you can work with it generically.

A runtime exception is thrown if a module the file has subclassed from cannot be found on the Forms path. This behaviour can be suppressed with the setFailSubclassLoad method.

Parameters:

fileName - the file name of a module to load.

formsPath - Path to use to look for modules that have been subclassed from. Pass null to this parameter to use the default FORMS90_PATH.

Returns:

a Forms module (FormModule, ObjectLibrary, MenuModule or PlsqlModule) cast as a JdapiModule.

openModule

public static JdapiModule openModule(java.io.File f,
                                     java.lang.String formsPath)

Loads a module from the file system. The module is returned cast as a JdapiModule object so that you can work with it generically.

A runtime exception is thrown if a module the file has subclassed from cannot be found on the Forms path. This behaviour can be suppressed with the setFailSubclassLoad() method.

Parameters:

f - the file object of the module to load.

formsPath - path to use to look for modules that have been subclassed from. Pass null to this parameter to use the default FORMS90_PATH.

Returns:

a Forms module (FormModule, ObjectLibrary, MenuModule or PlsqlModule) cast as a JdapiModule.

save

public abstract void save(java.lang.String fileName)

Saves the module instance to the file system. If you simply provide a file name such as module1 or module.fmb, then the file is saved to the current directory. If you enter a path and the pathname is an invalid String for that system, then a error will be returned.

Beecause this is a String, there might be an issue with directory separators. On Windows systems you will have to use a double backslash (\\); the first backslash acts as the "escape" character. There should not be a problem with the forward slash.

Parameters:

fileName - the file path or name that you want to use to save the module.

compile

public abstract void compile()

Compiles the module instance to the file system. This is a placeholder so that it can be overidden in the module classes that subclass JdapiModule.

compile_all

public void compile_all()

Compiles all the pl/sql in the module. This is equivalent to choosing compile_all in the Forms Builder. This is only supported for Forms and Menus, not Libraries.

destroy

public void destroy()

Destroys the object - this removes the object from its context. The JNI level is responsible for removing this object from the context cache, so we don't need to do that in here.

Specified by:

destroy in interface JdapiObject

Overrides:

destroy in class BaseFormsObject