Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.0.0)

E17483-01

oracle.adf.model.adapter.bean
Class BeanDefinition

java.lang.Object
  extended by oracle.adf.model.adapter.AbstractDefinition
      extended by oracle.adfinternal.model.adapter.bean.AbstractBeanDefinition
          extended by oracle.adf.model.adapter.bean.BeanDefinition
All Implemented Interfaces:
DataControlDefinition, Definition, NamedDefinition
Direct Known Subclasses:
BeanDCDefinition, BeanDefinition

public class BeanDefinition
extends AbstractBeanDefinition

Since:
11.1.1.0

Field Summary
protected  oracle.adf.share.logging.ADFLogger _logger
           
static java.lang.String BEAN_CLASS
          Java bean specifics
static java.lang.String BEAN_DEFINITION
           
static java.lang.String BEAN_DEFINITION_URI
           
static java.lang.String BEAN_PROVIDER
          bean DataControlStructureProvider identifier
static java.lang.String BEAN_XMLNS
           
static java.lang.String JPQLDataControlHandlerName
          JPA Data handler class
static java.lang.String LOGGER
           
 
Fields inherited from class oracle.adfinternal.model.adapter.bean.AbstractBeanDefinition
DATA_CONTROL_HANDLER, metaData, parameters
 
Fields inherited from class oracle.adf.model.adapter.AbstractDefinition
CACHE_TO_SOURCEPATH, DONT_CACHE, mFullName
 
Fields inherited from interface oracle.binding.meta.Definition
TYPE_ACCESSOR, TYPE_ATTRIBUTE, TYPE_CRITERIA, TYPE_CRITERIA_ITEM, TYPE_CRITERIA_OPERATOR, TYPE_CRITERIA_ROW, TYPE_DATACONTROL, TYPE_DEFINITION, TYPE_DEFINITIONCONTEXT, TYPE_NAMED, TYPE_OPERATION, TYPE_OPERATIONRETURN, TYPE_PARAMETER, TYPE_STRUCTURE, TYPE_VARIABLE
 
Constructor Summary
BeanDefinition()
          Zero arg constructor required by the framework.
BeanDefinition(DataControlStructure definition)
          Constructor used by the BeanAbstractAdapter.
 
Method Summary
 boolean assignDefaultPackage()
          Data controls which do not already have their own package structure need to use a default package.
 DataControl createDataControl()
          Creates data control at runtime.
 java.lang.String getAdapterType()
          Returns the name of the corresponding adapter type, if any.
 int getCachingMode()
           
 java.lang.String getFullName()
          Returns the full name of this Definition, which includes the name of any parent objects.
protected  java.lang.String getProviderType()
          Returns the dc structure provider type for this BeanAbstractDefinition.
protected  void initDefinition()
          Implementor to provide the definition
 boolean isSupported(java.lang.String operation)
          Indicates if the adapter support updates, sort, transaction or criteria
 boolean shouldCompileProjectOnCreate()
          Indicates if the project needs to be compiled when a data control is created from this definition.
 boolean usePersistedStructure()
          Indicates whether the definition delegates to the framework the task of deserializing its StructureDefinition (for example, from bean .xml files on disk).
 
Methods inherited from class oracle.adfinternal.model.adapter.bean.AbstractBeanDefinition
getDCName, getMetadata, getRuntimeMetaData, getRuntimeParameters, getStructure, isStructureDirty, loadFromMetadata
 
Methods inherited from class oracle.adf.model.adapter.AbstractDefinition
createDuplicateDetailIterator, getAdapterContext, getConfigurationFullName, getDefClassName, getDefinitionParent, getDefinitionType, getFactoryClassName, getName, getParameters, getProperties, getProperty, setAdapterContext, setCachingMode, setCompileProjectOnCreate, setConfigurationFullName, setFullName, setName, setProperty, useDefinitionProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

BEAN_DEFINITION

public static final java.lang.String BEAN_DEFINITION
See Also:
Constant Field Values

BEAN_XMLNS

public static final java.lang.String BEAN_XMLNS
See Also:
Constant Field Values

BEAN_DEFINITION_URI

public static final java.lang.String BEAN_DEFINITION_URI
See Also:
Constant Field Values

BEAN_CLASS

public static final java.lang.String BEAN_CLASS
Java bean specifics

See Also:
Constant Field Values

BEAN_PROVIDER

public static final java.lang.String BEAN_PROVIDER
bean DataControlStructureProvider identifier

See Also:
Constant Field Values

JPQLDataControlHandlerName

public static final java.lang.String JPQLDataControlHandlerName
JPA Data handler class


LOGGER

public static final java.lang.String LOGGER
See Also:
Constant Field Values

_logger

protected oracle.adf.share.logging.ADFLogger _logger
Constructor Detail

BeanDefinition

public BeanDefinition()
Zero arg constructor required by the framework.


BeanDefinition

public BeanDefinition(DataControlStructure definition)
Constructor used by the BeanAbstractAdapter.

Method Detail

createDataControl

public DataControl createDataControl()
Creates data control at runtime.

Specified by:
createDataControl in class AbstractDefinition
Returns:
the data control instance.

getProviderType

protected java.lang.String getProviderType()
Returns the dc structure provider type for this BeanAbstractDefinition.

Specified by:
getProviderType in class AbstractBeanDefinition

getFullName

public java.lang.String getFullName()
Description copied from interface: NamedDefinition
Returns the full name of this Definition, which includes the name of any parent objects. The full name should reflect the runtime nesting level.

Specified by:
getFullName in interface NamedDefinition
Overrides:
getFullName in class AbstractDefinition
Returns:
Full name of this Definition.

getAdapterType

public java.lang.String getAdapterType()
Description copied from class: AbstractDefinition
Returns the name of the corresponding adapter type, if any. The framework calls this method to find out a corresponding adapter for this definition.

Overrides:
getAdapterType in class AbstractDefinition
Returns:
name of the corresponding adapter that matches this definition. If there is no adapter defined for this type, the method returns null. The default implementation returns null.
See Also:
AdapterDefinition

assignDefaultPackage

public boolean assignDefaultPackage()
Description copied from class: AbstractDefinition
Data controls which do not already have their own package structure need to use a default package. Bean-based data controls, or others whose names embed their package structure, should override this to return false.

Overrides:
assignDefaultPackage in class AbstractDefinition
Returns:
false to indicate that EJB data controls maintain their own package info in the structure defs they create.

getCachingMode

public int getCachingMode()
Overrides:
getCachingMode in class AbstractDefinition

usePersistedStructure

public boolean usePersistedStructure()
Description copied from class: AbstractBeanDefinition
Indicates whether the definition delegates to the framework the task of deserializing its StructureDefinition (for example, from bean .xml files on disk). Overrides base method on AbstractDefinition.

Overrides:
usePersistedStructure in class AbstractBeanDefinition
Returns:
by default true.

shouldCompileProjectOnCreate

public boolean shouldCompileProjectOnCreate()
Description copied from class: AbstractDefinition
Indicates if the project needs to be compiled when a data control is created from this definition.

Note: If the data control create is invoked from within a UI operation (e.g. you are invoking creation of data control while responding to a property change action of the data control metadata), this method must return false. A data control can be created by calling the method createDataControl on class MetaDef.

Overrides:
shouldCompileProjectOnCreate in class AbstractDefinition
Returns:
by default it returns false.

isSupported

public boolean isSupported(java.lang.String operation)
Indicates if the adapter support updates, sort, transaction or criteria

Overrides:
isSupported in class AbstractBeanDefinition
Parameters:
operation - one of the values defined in DataControlDefinition.
Returns:
boolean

initDefinition

protected void initDefinition()
Description copied from class: AbstractBeanDefinition
Implementor to provide the definition

Overrides:
initDefinition in class AbstractBeanDefinition

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.0.0)

E17483-01

Copyright © 1997, 2011, Oracle. All rights reserved.