oracle.adfinternal.model.adapter.url

Class URLDCDefinition

java.lang.Object

oracle.adf.model.adapter.AbstractDefinition

oracle.adfinternal.model.adapter.url.URLDCDefinition

All Implemented Interfaces:

DataControlDefinition, Definition, NamedDefinition

public class URLDCDefinition
extends AbstractDefinition

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFINITIONS Definition tag as the root.
static java.lang.String	ID ID for the individual Definition.
static java.lang.String	IMPL_DEF Implementation class for the individual Definition.
static java.lang.String	URL_NS Namespace for the metadata definition.
static java.lang.String	USE_PERSIST_STRUCT

Fields inherited from class oracle.adf.model.adapter.AbstractDefinition

CACHE_TO_SOURCEPATH, DONT_CACHE, mDCConfiguration, 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

Constructors

Constructor and Description
URLDCDefinition()
URLDCDefinition(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDefinition(java.lang.String defName, AbstractURLChildDefinition def) Used to add a Definition to the URLDCDefinition aggregate map.
DataControl	createDataControl() Creates an instance of data control generated from the metadata definition.
java.lang.String	getAdapterType() Returns the type of the adapter.
java.util.Collection<AbstractURLChildDefinition>	getAllChildDefinitions()
java.lang.String	getDCName() Returns the name of the data control.
AbstractURLChildDefinition	getDefinition(java.lang.String defName) Returns a Definition based on the definition name.
Node	getMetadata() Returns the element that defines the metadata for the data control.
java.lang.String	getRootStructureName() Gets the root structure definition name
StructureDefinition	getStructure() Gets the structure definition of the output data.
boolean	isStructureDirty(boolean refresh) Tells the framework whether the Data control structure is dirty and needs to be refreshed on the palette.
void	loadFromMetadata(Node node, java.util.Map params) Loads the definition from a metadata Node.
void	removeDefinition(java.lang.String defName) Removes the Definition from the aggregate
void	setRootStructureName(java.lang.String rootDefName) Sets the root structure definition name

Methods inherited from class oracle.adf.model.adapter.AbstractDefinition

assignDefaultPackage, createDuplicateDetailIterator, getAdapterContext, getCachingMode, getConfiguration, getConfigurationFullName, getDefClassName, getDefinitionParent, getDefinitionType, getFactoryClassName, getFullName, getJUDTDataControlName, getName, getParameters, getProperties, getProperty, getRuntimeParameters, isSupported, setAdapterContext, setCachingMode, setCompileProjectOnCreate, setConfigurationFullName, setFullName, setName, setProperty, shouldCompileProjectOnCreate, useDefinitionProvider, usePersistedStructure

Methods inherited from class java.lang.Object

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

Field Detail

URL_NS

public static final java.lang.String URL_NS

Namespace for the metadata definition.

See Also:

Constant Field Values

DEFINITIONS

public static final java.lang.String DEFINITIONS

Definition tag as the root.

See Also:

Constant Field Values

IMPL_DEF

public static final java.lang.String IMPL_DEF

Implementation class for the individual Definition.

See Also:

Constant Field Values

ID

public static final java.lang.String ID

ID for the individual Definition.

See Also:

Constant Field Values

USE_PERSIST_STRUCT

public static final java.lang.String USE_PERSIST_STRUCT

See Also:

Constant Field Values

Constructor Detail

URLDCDefinition

public URLDCDefinition()

URLDCDefinition

public URLDCDefinition(java.lang.String name)

Method Detail

createDataControl

public DataControl createDataControl()

Description copied from class: AbstractDefinition

Creates an instance of data control generated from the metadata definition.

Specified by:

createDataControl in class AbstractDefinition

Returns:

the data control instance.

getMetadata

public Node getMetadata()

Description copied from class: AbstractDefinition

Returns the element that defines the metadata for the data control.

Specified by:

getMetadata in class AbstractDefinition

Returns:

a Node that defines the metadata for this instance. This metadata will be used at the runtime to fetch data from the data source.

getStructure

public StructureDefinition getStructure()

Description copied from class: AbstractDefinition

Gets the structure definition of the output data.

Specified by:

getStructure in interface DataControlDefinition

Specified by:

getStructure in class AbstractDefinition

Returns:

Definition of the output data structure.

loadFromMetadata

public void loadFromMetadata(Node node,
                    java.util.Map params)

Description copied from class: AbstractDefinition

Loads the definition from a metadata Node.

Specified by:

loadFromMetadata in class AbstractDefinition

Parameters:

node - the metadata node. It can be null if no metadata is defined.

params - context parameters.

addDefinition

public void addDefinition(java.lang.String defName,
                 AbstractURLChildDefinition def)

Used to add a Definition to the URLDCDefinition aggregate map. The Definition to be added can be an instance of XMLDCDef,CSVDCDef (or JSONDCDef in future).

Parameters:

defName -

def -

getDefinition

public AbstractURLChildDefinition getDefinition(java.lang.String defName)

Returns a Definition based on the definition name.

Parameters:

defName -

Returns:

removeDefinition

public void removeDefinition(java.lang.String defName)

Removes the Definition from the aggregate

Parameters:

defName -

getAllChildDefinitions

public java.util.Collection<AbstractURLChildDefinition> getAllChildDefinitions()

Returns:

For internal use only. Application developers should not use this

Returns all the child definitions present in this URL DC

isStructureDirty

public boolean isStructureDirty(boolean refresh)

Tells the framework whether the Data control structure is dirty and needs to be refreshed on the palette.

Overrides:

isStructureDirty in class AbstractDefinition

Parameters:

refresh - flag to indicate if the refresh is requested for the structure.

Returns:

refresh value The URL DC implementation always returns refresh flag.

getAdapterType

public java.lang.String getAdapterType()

Returns the type of the adapter.

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

getRootStructureName

public java.lang.String getRootStructureName()

Gets the root structure definition name

Overrides:

getRootStructureName in class AbstractDefinition

getDCName

public java.lang.String getDCName()

Description copied from class: AbstractDefinition

Returns the name of the data control.

Specified by:

getDCName in class AbstractDefinition

setRootStructureName

public void setRootStructureName(java.lang.String rootDefName)

Sets the root structure definition name

Overrides:

setRootStructureName in class AbstractDefinition