oracle.adf.model.adapter.rest
Class RestURLDCDefinition

java.lang.Object
  oracle.adf.model.adapter.AbstractDefinition
      oracle.adf.model.adapter.rest.RestURLDCDefinition

All Implemented Interfaces:

DataControlDefinition, Definition, NamedDefinition

public class RestURLDCDefinition
extends AbstractDefinition

Since:

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

Field Summary

static java.lang.String	DEFINITIONS Definition tag as the root.
static java.lang.String	REST_NS Namespace for the metadata definition.

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

RestURLDCDefinition()

RestURLDCDefinition(java.lang.String name)

Method Summary

ChildOperation	createAndAddXMLOperation(java.lang.String methodID, java.lang.String sourceLocation, java.lang.String xsdLoc)
ChildOperation	createAndAddXMLOperation(java.lang.String connectionName, java.lang.String methodID, java.lang.String sourceLocation, java.lang.String xsdLoc)
ChildOperation	createAndAddXMLOperation(java.lang.String connectionName, java.lang.String methodID, java.lang.String sourceLocation, java.lang.String xsdLoc, boolean createConnection) Used to create and add a Rest XMLDefinition to the RestURLDCDefinition 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<ChildOperation>	getAllChildOperations()
ChildOperation	getChildOperation(java.lang.String defName) Returns a Definition based on the definition name.
java.lang.String	getDCName() Returns the name of the data control.
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	removeOperation(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, getConfigurationFullName, getDefClassName, getDefinitionParent, getDefinitionType, getFactoryClassName, getFullName, getName, getParameters, getProperties, getProperty, 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

REST_NS

public static final java.lang.String REST_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

Constructor Detail

RestURLDCDefinition

public RestURLDCDefinition()

RestURLDCDefinition

public RestURLDCDefinition(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.

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

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.

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.

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.

createAndAddXMLOperation

public ChildOperation createAndAddXMLOperation(java.lang.String methodID,
                                               java.lang.String sourceLocation,
                                               java.lang.String xsdLoc)

createAndAddXMLOperation

public ChildOperation createAndAddXMLOperation(java.lang.String connectionName,
                                               java.lang.String methodID,
                                               java.lang.String sourceLocation,
                                               java.lang.String xsdLoc)

createAndAddXMLOperation

public ChildOperation createAndAddXMLOperation(java.lang.String connectionName,
                                               java.lang.String methodID,
                                               java.lang.String sourceLocation,
                                               java.lang.String xsdLoc,
                                               boolean createConnection)

Used to create and add a Rest XMLDefinition to the RestURLDCDefinition aggregate map.

Parameters:

connectionName -

methodID -

sourceLocation -

xsdLoc -

getChildOperation

public ChildOperation getChildOperation(java.lang.String defName)

Returns a Definition based on the definition name.

Parameters:

defName -

Returns:

removeOperation

public void removeOperation(java.lang.String defName)

Removes the Definition from the aggregate

Parameters:

defName -

getAllChildOperations

public java.util.Collection<ChildOperation> getAllChildOperations()

Returns:

For internal use only. Application developers should not use this

Returns all the child definitions present in this Rest 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.

getRootStructureName

public java.lang.String getRootStructureName()

Gets the root structure definition name

setRootStructureName

public void setRootStructureName(java.lang.String rootDefName)

Sets the root structure definition name

getDCName

public java.lang.String getDCName()

Description copied from class: AbstractDefinition

Returns the name of the data control.

Specified by:

getDCName in class AbstractDefinition