|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 2 (11.1.2.0.0) E17483-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.adf.model.adapter.AdapterDefinition
public class AdapterDefinition
Adapter definition contains the definitions of the adapters available for the system. Adapters are the drivers that can handle different data sources to connect and execute queries. Data controls use adapters to connect to data sources.
Adapter definition defines the class name that implements the adapter. It also defines the data source type that it can handle. The data source type information contains the class name that represent a data source in the JDeveloper connection navigator.
Every adapter implementation must have a definition file defined for it. The definition file must be named as adapter-definition.xml. The file should be in the application class path under the folder meta-inf.
Adapter definitions are loaded once per JVM. The
method call triggers the loading of the files, if it's not already loaded by
another thread. Once loaded the information is shared across different thread
running for the JVM.
initialize()
()
Field Summary | |
---|---|
static java.lang.String |
ATTR_JDEV_CTX_HOOK_CLASS
|
static java.lang.String |
ATTR_JDEV_NODE
Attribute name to get the JDev class name for the node that the adapter can handle. |
static java.lang.String |
ATTR_LOCATION
|
static java.lang.String |
ATTR_NS
|
static java.lang.String |
ATTR_PATH
|
static java.lang.String |
ATTR_PROP_NAME
|
static java.lang.String |
ATTR_PROP_VALUE
|
static java.lang.String |
ATTR_TYPE_CLASS
|
static java.lang.String |
ATTR_TYPE_NAME
|
static java.lang.String |
DEF_FILE
|
static java.lang.String |
TAG_ADAPTER
Tag name for adapter. |
static java.lang.String |
TAG_DEPENDENCIES
Tag "Dependencies". |
static java.lang.String |
TAG_JDEV_CTX_HOOK
Tag "JDevHook". |
static java.lang.String |
TAG_LIBRARY
|
static java.lang.String |
TAG_PROPERTIES
Tag "Properties" |
static java.lang.String |
TAG_PROPERTY
|
static java.lang.String |
TAG_SCHEMA
Tag "Schema". |
static java.lang.String |
TAG_SOURCE_TYPE
Tag "Source". |
static java.lang.String |
TAG_TYPE
|
Method Summary | |
---|---|
static void |
addListener(AdapterDefinitionListener grammarProvider)
|
boolean |
canHandle(java.lang.Object obj)
Checks if a specific data source type can be handled by this adapter. |
AbstractAdapter |
createAdapterInstance()
Creates an instance of the adapter by loading the adapter class. |
static java.util.Iterator<AdapterDefinition> |
enumAdapters()
Enumerates all adapters defined for the system. |
java.util.Iterator |
enumSchemaLocations()
Enumerates all namespace locations defined for the adapter. |
java.util.Iterator |
enumSchemaNS()
Enumerates all namespace names defined for the adapter. |
java.lang.Class |
getAdapterClass()
|
java.lang.String |
getClassName()
Gets the class name of the adapter. |
protected java.lang.ClassLoader |
getContextualClassloader()
|
static AdapterDefinition |
getDefinition(java.lang.String typeName)
Returns the definition object for a type name. |
java.lang.String |
getJDevCtxHookName()
|
java.util.Iterator |
getLibraries()
Gets the library paths that the adapter depends on. |
java.lang.String |
getName()
Gets the type name of the adapter. |
java.lang.String |
getPropertyValue(java.lang.String name)
Gets the value of a property defined for the adapter. |
java.lang.String |
getSchemaLocation(java.lang.String ns)
Gets the schema location. |
java.util.Iterator |
getSupportedSourceClasses()
Gets the source type classes that this adapter can handle. |
java.util.Iterator |
getSupportedSourceNames()
Gets the source type names that this adapter can handle. |
java.util.Iterator |
getSupportedSourceTypes()
Gets the source types that this adapter can handle. |
static void |
initialize()
Initializes the definition system by loading the definitions. |
static void |
registerAdapterDefinitions(java.lang.ClassLoader contextualloader)
|
static void |
removeListener(AdapterDefinitionListener grammarProvider)
|
static void |
setClassLoader(java.lang.ClassLoader cl)
Sets the class loader that loads the adapter definition files from the class path. |
protected void |
setContextualClassloader(java.lang.ClassLoader mContextualClassloader)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEF_FILE
public static final java.lang.String TAG_ADAPTER
public static final java.lang.String ATTR_TYPE_NAME
public static final java.lang.String ATTR_TYPE_CLASS
public static final java.lang.String TAG_SOURCE_TYPE
public static final java.lang.String TAG_TYPE
public static final java.lang.String ATTR_JDEV_NODE
public static final java.lang.String TAG_SCHEMA
public static final java.lang.String ATTR_NS
public static final java.lang.String ATTR_LOCATION
public static final java.lang.String TAG_DEPENDENCIES
public static final java.lang.String TAG_LIBRARY
public static final java.lang.String ATTR_PATH
public static final java.lang.String TAG_JDEV_CTX_HOOK
public static final java.lang.String ATTR_JDEV_CTX_HOOK_CLASS
public static final java.lang.String TAG_PROPERTIES
public static final java.lang.String TAG_PROPERTY
public static final java.lang.String ATTR_PROP_NAME
public static final java.lang.String ATTR_PROP_VALUE
Method Detail |
---|
public static void initialize()
public static void setClassLoader(java.lang.ClassLoader cl)
Different IDE system can set the calss loader relavant for them. By default the calling thread's class loader will be used.
public static AdapterDefinition getDefinition(java.lang.String typeName)
typeName
- Name of the adapter type.
public static java.util.Iterator<AdapterDefinition> enumAdapters()
AdapterDefinition
objects.public java.lang.String getName()
public java.util.Iterator enumSchemaNS()
public java.util.Iterator enumSchemaLocations()
public java.lang.String getSchemaLocation(java.lang.String ns)
ns
- Namespace for the schema location.
public java.lang.String getJDevCtxHookName()
public java.lang.String getPropertyValue(java.lang.String name)
public java.lang.String getClassName()
public java.lang.Class getAdapterClass()
public java.util.Iterator getLibraries()
public AbstractAdapter createAdapterInstance()
public java.util.Iterator getSupportedSourceNames()
The source type names identify specific data source types for an application.
public java.util.Iterator getSupportedSourceTypes()
public java.util.Iterator getSupportedSourceClasses()
The source type classes identify specific data source types presented in the JDeveloper connection navigator window.
java.lang.Class
representing nodes in
the JDeveloper coinnection pane that this adapter can accept as
a data source connection.public boolean canHandle(java.lang.Object obj)
obj
- The object that can be used as a data source connection node.
It can either the name of the data source type or the node
object that represents the data source in the JDeveloper
connection navigator.public static void registerAdapterDefinitions(java.lang.ClassLoader contextualloader)
public static void addListener(AdapterDefinitionListener grammarProvider)
public static void removeListener(AdapterDefinitionListener grammarProvider)
protected void setContextualClassloader(java.lang.ClassLoader mContextualClassloader)
protected java.lang.ClassLoader getContextualClassloader()
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 2 (11.1.2.0.0) E17483-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |