oracle.panama.feed
Interface DataFeeder

All Superinterfaces:

ModelObject, PassThroughDataFeeder, XMLObject

public interface DataFeeder

extends PassThroughDataFeeder

Fields inherited from interface oracle.panama.model.ModelObject

TYPEID

Method Summary

Type	Method
void	addInputParameter(FeedMetaData ip) Add a new input parameter for the external data source.
void	addInputParameters(FeedMetaData[] ip) Add an array of new input parameters for the external data source.
void	addOutputParameter(FeedMetaData tp) Add a new output parameter
void	addOutputParameters(FeedMetaData[] tp) Add an array of new output parameters
void	createFeedDefinition() Create the feed definition -- this will register the Input/Output parameters with the alert framework and create the cache table if needed.
FeedMetaData	createMetaData(java.lang.String name, java.lang.String type) Create a FeedMetaData instance, for use with add{Input,Output}Parameter The SQL type of the FeedMetaData should be one of the predefined types in the @see oracle.panama.feed.FeeedUtil interface
ContentProviderInfo	getContentProviderInfo() get the Content provider info for this DataFeeder For now, each DataFeeder has only one ContentProviderInfo.
java.util.Map[]	getData(java.util.Map params) Retrieve the data feed from application's feed table for a given set of parameters.
java.lang.String	getDataFilterHook() Get the name of the current DataFilterHook
java.lang.String	getDownloadHook() Get the class name of the current DownloadHook
FeedMetaData	getInputParameter(java.lang.String paramName) Get a named input parameter.
FeedMetaData[]	getInputParameters() Get all input parameters currently defined for this DataFeeder
java.lang.String	getName() Get the name of this DataFeeder
FeedMetaData	getOutputParameter(java.lang.String paramName) Get a named output parameter
FeedMetaData[]	getOutputParameters() Get all output parameters currently defined for this DataFeeder
boolean	isCachingDisabled() Query whether caching is disabled
void	setCachingDisabled(boolean disableFlag) Disable data caching
void	setData(java.util.Map data) Store data in the data cache
void	setDataFilterHook(java.lang.String className) Set the name of the current DataFilterHook
void	setDownloadHook(java.lang.String className) Set the name of the current DownloadHook
void	setName(java.lang.String name) Set the name of this DataFeeder

Methods inherited from interface oracle.panama.feed.PassThroughDataFeeder

getClassName, setClassName

Methods inherited from interface oracle.panama.model.ModelObject

delete, getCreatedDate, getId, getLastModifiedDate, getTypeId, getTypeName, isSystem, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Method Detail

getName

public java.lang.String getName()

Get the name of this DataFeeder

Specified by:

getName in interface PassThroughDataFeeder

Returns:

String the name of this DataFeeder

setName

public void setName(java.lang.String name)

Set the name of this DataFeeder

Specified by:

setName in interface ModelObject

Parameters:

String - the name to set for this DataFeeder

addInputParameter

public void addInputParameter(FeedMetaData ip)

Add a new input parameter for the external data source. The input parameter should be created first using the function

Parameters:

FeedMetaData - the input parameter to add

See Also:

Once the parameter is added using this function it cannot be removed from the DataFeeder, only invalidated., #createFeedMetaData

addInputParameters

public void addInputParameters(FeedMetaData[] ip)

Add an array of new input parameters for the external data source. The input parameters should be created first using the function createMetaData. Once the parameter is added using this function it cannot be removed from the DataFeeder, only invalidated.

Specified by:

addInputParameters in interface PassThroughDataFeeder

Parameters:

FeedMetaData - the input parameter to add

See Also:

#createFeedMetaData

getInputParameters

public FeedMetaData[] getInputParameters()

Get all input parameters currently defined for this DataFeeder

Specified by:

getInputParameters in interface PassThroughDataFeeder

Returns:

FeedMetaData[] all input parameters for this DataFeeder

getInputParameter

public FeedMetaData getInputParameter(java.lang.String paramName)

Get a named input parameter.

Specified by:

getInputParameter in interface PassThroughDataFeeder

Parameters:

name - of input parameter to get

Returns:

FeedMetaData definition for the parameter, null if not found

addOutputParameter

public void addOutputParameter(FeedMetaData tp)

Add a new output parameter

Parameters:

FeedMetaData - the output parameter to add

See Also:

#createFeedMetaData

addOutputParameters

public void addOutputParameters(FeedMetaData[] tp)

Add an array of new output parameters

Specified by:

addOutputParameters in interface PassThroughDataFeeder

Parameters:

FeedMetaData[] - the output parameters to add

See Also:

#createFeedMetaData

getOutputParameters

public FeedMetaData[] getOutputParameters()

Get all output parameters currently defined for this DataFeeder

Specified by:

getOutputParameters in interface PassThroughDataFeeder

Returns:

FeedMetaData[] all output parameters for this DataFeeder

getOutputParameter

public FeedMetaData getOutputParameter(java.lang.String paramName)

Get a named output parameter

Specified by:

getOutputParameter in interface PassThroughDataFeeder

Parameters:

String - name of output parameter to get

Returns:

FeedMetaData definition for the parameter, null if not found

getContentProviderInfo

public ContentProviderInfo getContentProviderInfo()

get the Content provider info for this DataFeeder For now, each DataFeeder has only one ContentProviderInfo. Multiple (pluggable) ContentProviderInfo may be supported in an future release.

Returns:

ContentProviderInfo Content provider info for this DataFeeder

isCachingDisabled

public boolean isCachingDisabled()

Query whether caching is disabled

Returns:

boolean is caching disabled

setCachingDisabled

public void setCachingDisabled(boolean disableFlag)

Disable data caching

Parameters:

disableFlag - true if caching should be disabled

createMetaData

public FeedMetaData createMetaData(java.lang.String name,
                                   java.lang.String type)

Create a FeedMetaData instance, for use with add{Input,Output}Parameter The SQL type of the FeedMetaData should be one of the predefined types in the @see oracle.panama.feed.FeeedUtil interface

Specified by:

createMetaData in interface PassThroughDataFeeder

Parameters:

String - name of the new FeedMetaData

String - SQL type of the new FeedMetaData, from FeedUtil

Returns:

new FeedMetaData instance

createFeedDefinition

public void createFeedDefinition()
                          throws PanamaException

Create the feed definition -- this will register the Input/Output parameters with the alert framework and create the cache table if needed. It is assumed that the client has defined the columns in the table by calling setInputParameters() and setOutputParameters() first.

Specified by:

createFeedDefinition in interface PassThroughDataFeeder

Throws:

PanamaException - if the table cannot be created

getData

public java.util.Map[] getData(java.util.Map params)
                        throws PanamaException

Retrieve the data feed from application's feed table for a given set of parameters. The method will return all matching rows. Each row is presented in the returned vector as a Map (hashtable). The values contained in the returned hashtable are in name/value format. If no data is found or if there is no cache table the method will return null.

Specified by:

getData in interface PassThroughDataFeeder

Parameters:

params - the names and values of parameters to look for

Returns:

all matching data values

Throws:

PanamaException - if an error was encountered in retrieving the data.

setData

public void setData(java.util.Map data)
             throws PanamaException

Store data in the data cache

Parameters:

data - Map of parameter names -> parameter values.

getDataFilterHook

public java.lang.String getDataFilterHook()

Get the name of the current DataFilterHook

Returns:

String class name of data filter hook

See Also:

oracle.panama.rt.hook.DataFilterHook

setDataFilterHook

public void setDataFilterHook(java.lang.String className)

Set the name of the current DataFilterHook

Parameters:

String - className the name of the class that implements the DataFilter hook

See Also:

oracle.panama.rt.hook.DataFilterHook

getDownloadHook

public java.lang.String getDownloadHook()

Get the class name of the current DownloadHook

Returns:

String class name of data filter hook, NULL if not set

See Also:

oracle.panama.rt.hook.DownloadHook

setDownloadHook

public void setDownloadHook(java.lang.String className)

Set the name of the current DownloadHook

Parameters:

the - name of the class that implements the Download hook

See Also:

oracle.panama.rt.hook.DownloadHook