oracle.adf.model.rest

Class RestDCDefinition

java.lang.Object

oracle.adf.model.adapter.AbstractDefinition

oracle.adf.model.rest.RestDCDefinition

All Implemented Interfaces:

DataControlDefinition, Definition, NamedDefinition

public class RestDCDefinition
extends AbstractDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestDCDefinition.ParentMediaType
static class	RestDCDefinition.ServiceType

Field Summary

Fields

Modifier and Type	Field and Description
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, mDCConfiguration, mFullName, mRootDefName

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
RestDCDefinition()
RestDCDefinition(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addDescribeOperation(java.lang.String resourceName, DescribeChildOperation def) Used to add a describe based definition to the RestDCDefinition aggregate map.
void	configureRestDCServiceType(RestDCDefinition.ServiceType type, java.lang.String... resources)
void	configureRestDCServiceType(java.lang.String serviceURL, boolean createConnection, RestDCDefinition.ServiceType type, java.lang.String... resources)
DescribeChildOperation	createAndAddDescribeOperation(java.lang.String resourceName)
DescribeChildOperation	createAndAddDescribeOperation(java.lang.String baseUrl, java.lang.String resourceName, boolean createConnection)
void	createAndAddDescribeOperations()
void	createAndAddDescribeOperations(boolean createConnection, java.lang.String connectionURL)
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<DescribeChildOperation>	getAllDescribeOperations()
javax.naming.Context	getConnectionContext()
java.lang.String	getDCName() Returns the name of the data control.
java.lang.String	getDescBaseUrl()
java.lang.String	getDescConnectionName()
DescribeChildOperation	getDescribeOperation(java.lang.String resourceName) Returns a describe based definition for the given resource name.
java.lang.String	getFactoryClassName() Advanced internal placeholder method.
java.lang.String	getJUDTDataControlName()
org.w3c.dom.Node	getMetadata() Returns the element that defines the metadata for the data control.
RestDCDefinition.ParentMediaType	getParentMediaType()
RestDCDefinition.ServiceType	getServiceType()
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.
boolean	isUseSharedLayerConn()
void	loadFromMetadata(org.w3c.dom.Node node, java.util.Map params) Loads the definition from a metadata Node.
void	setDescBaseUrl(java.lang.String descBaseUrl)
void	setDescConnectionName(java.lang.String descConnectionName)
void	setParentMediaType(RestDCDefinition.ParentMediaType parentMediaType)
void	setServiceType(RestDCDefinition.ServiceType serviceType)
void	setUseSharedLayerConn(boolean mUseSharedLayerConn)

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

addParameter, assignDefaultPackage, createDuplicateDetailIterator, disableSharing, enableSharing, getAdapterContext, getCachingMode, getConfiguration, getConfigurationFullName, getDefClassName, getDefinitionParent, getDefinitionType, getFullName, getName, getParameter, getParameterCollection, getParameters, getProperties, getProperty, getRootStructureName, getRuntimeParameters, isSupported, removeParameter, setAdapterContext, setCachingMode, setCompileProjectOnCreate, setConfigurationFullName, setFullName, setName, setProperty, setRootStructureName, 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

Constructor Detail

RestDCDefinition

public RestDCDefinition()

RestDCDefinition

public RestDCDefinition(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 org.w3c.dom.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.

getConnectionContext

public final javax.naming.Context getConnectionContext()
                                                throws java.lang.Exception

Throws:

java.lang.Exception

loadFromMetadata

public void loadFromMetadata(org.w3c.dom.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.

configureRestDCServiceType

public void configureRestDCServiceType(RestDCDefinition.ServiceType type,
                                       java.lang.String... resources)

configureRestDCServiceType

public void configureRestDCServiceType(java.lang.String serviceURL,
                                       boolean createConnection,
                                       RestDCDefinition.ServiceType type,
                                       java.lang.String... resources)

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.

addDescribeOperation

@Concealed
public void addDescribeOperation(java.lang.String resourceName,
                                            DescribeChildOperation def)

Used to add a describe based definition to the RestDCDefinition aggregate map.

Parameters:

resourceName -

def -

For internal use only. Application developers should not use this

setUseSharedLayerConn

public void setUseSharedLayerConn(boolean mUseSharedLayerConn)

isUseSharedLayerConn

public boolean isUseSharedLayerConn()

getDescribeOperation

public DescribeChildOperation getDescribeOperation(java.lang.String resourceName)

Returns a describe based definition for the given resource name.

Parameters:

resourceName -

Returns:

getServiceType

public RestDCDefinition.ServiceType getServiceType()

setServiceType

public void setServiceType(RestDCDefinition.ServiceType serviceType)

getAllDescribeOperations

@Concealed
public java.util.Collection<DescribeChildOperation> getAllDescribeOperations()

Returns:

For internal use only. Application developers should not use this

Returns all the describe based 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.

getDCName

public java.lang.String getDCName()

Description copied from class: AbstractDefinition

Returns the name of the data control.

Specified by:

getDCName in class AbstractDefinition

getFactoryClassName

public java.lang.String getFactoryClassName()

Description copied from class: AbstractDefinition

Advanced internal placeholder method.

Overrides:

getFactoryClassName in class AbstractDefinition

getJUDTDataControlName

@Concealed
public java.lang.String getJUDTDataControlName()

Overrides:

getJUDTDataControlName in class AbstractDefinition

getParentMediaType

@Concealed
public RestDCDefinition.ParentMediaType getParentMediaType()

setParentMediaType

@Concealed
public void setParentMediaType(RestDCDefinition.ParentMediaType parentMediaType)

createAndAddDescribeOperation

public DescribeChildOperation createAndAddDescribeOperation(java.lang.String baseUrl,
                                                            java.lang.String resourceName,
                                                            boolean createConnection)

createAndAddDescribeOperation

public DescribeChildOperation createAndAddDescribeOperation(java.lang.String resourceName)

createAndAddDescribeOperations

public void createAndAddDescribeOperations(boolean createConnection,
                                           java.lang.String connectionURL)

createAndAddDescribeOperations

public void createAndAddDescribeOperations()

setDescConnectionName

public void setDescConnectionName(java.lang.String descConnectionName)

getDescConnectionName

public java.lang.String getDescConnectionName()

setDescBaseUrl

public void setDescBaseUrl(java.lang.String descBaseUrl)

getDescBaseUrl

public java.lang.String getDescBaseUrl()