oracle.panama.feed
Interface ContentProviderInfo

public interface ContentProviderInfo

Field Summary

Type	Field
static java.lang.String	COLUMN_NUMBER
static java.lang.String	DELIMITER
static java.lang.String	ENDPOS
static java.lang.String	FORMAT_DELIMITED
static java.lang.String	FORMAT_FIXED
static java.lang.String	FORMAT_XML
static java.lang.String	FTP_MODE
static java.lang.String	HTTP_METHOD
static java.lang.String	LINESEP
static java.lang.String	PASSWORD
static java.lang.String	PROTOCOL_APP
static java.lang.String	PROTOCOL_FILE
static java.lang.String	PROTOCOL_FTP
static java.lang.String	PROTOCOL_HTTP
static java.lang.String	PROTOCOL_SQL
static java.lang.String	QUOTECHAR
static java.lang.String	SQL_QUERY
static java.lang.String	STARTPOS
static java.lang.String	STYLESHEET
static java.lang.String	USERNAME

Method Summary

Type	Method
java.lang.String	getDataFilterHook() Get the current data filter hook used
java.lang.String	getDataParser() Get the current DataParser implementation class name.
java.lang.String	getDataSource() Get the current DataSource implementation class name.
java.lang.String	getExternalNameForParameter(FeedMetaData parameter) Get the external name that this ContentProvider uses for the given parameter.
java.util.Map	getFormatArgumentDefs() Get the valid arguments for the current format.
java.util.Map	getFormatArguments() Get the arguments currently used for the current format
java.lang.String	getFormatType() Get the name of the current format
java.lang.String[]	getFormatTypes() Get a list of valid format names.
java.lang.String	getName() Get the name of this content provider.
java.lang.String	getNullValue() Get the null value specified for this ContentProvider
java.util.Map	getParamArgumentDefs() Get the list of parameter arguments that can be specified on a per-CP basis for the current format.
java.util.Map	getParamArguments(FeedMetaData parameter) Get the arguments currently set for this CP for the given parameter.
java.lang.String	getPrimarySource() Get the source of data for this content provider.
java.util.Map	getProtocolArgumentDefs() Get the valid arguments for the current protocol.
java.util.Map	getProtocolArguments() Get the arguments to use for the current protocol
java.lang.String	getProtocolType() Get the name of the current protocol
java.lang.String[]	getProtocolTypes() Get a list of valid protocol names.
UpdatePolicy	getUpdatePolicy() Get the update policy for the current content provider If for example you need to modify the batch size for the feed you would do the following: dataFeed.getContentProvider().getUpdatePolicy().setBatchSize(100); Currently, each ContentProvider has one default UpdatePolicy.
void	setDataFilterHook(java.lang.String className) Set the data filter hook to use
void	setDataParser(java.lang.String dataParser) Set the current DataParser implementation class name.
void	setDataSource(java.lang.String dataSource) Set the current DataSource implementation class name.
void	setExternalNameForParameter(FeedMetaData parameter, java.lang.String externalName) Set the external name that this ContentProvider uses for the given parameter.
void	setFormatArguments(java.util.Map initArgs) Set the arguments to use for the current format
void	setFormatType(java.lang.String formatName) Set the format to use
void	setName(java.lang.String name) Set the name of this content provider
void	setNullValue(java.lang.String nullValue) Set the null value that is used by this ContentProvider
void	setParamArguments(FeedMetaData parameter, java.util.Map arguments) Set the parameter argument for this parameter.
void	setPrimarySource(java.lang.String source) Set the source of data for this content provider.
void	setProtocolArguments(java.util.Map initArgs) Set the arguments to use for the current protocol
void	setProtocolType(java.lang.String protocolName) Set the protocol to use

Field Detail

PROTOCOL_APP

public static final java.lang.String PROTOCOL_APP

PROTOCOL_FILE

public static final java.lang.String PROTOCOL_FILE

PROTOCOL_FTP

public static final java.lang.String PROTOCOL_FTP

PROTOCOL_HTTP

public static final java.lang.String PROTOCOL_HTTP

PROTOCOL_SQL

public static final java.lang.String PROTOCOL_SQL

FORMAT_DELIMITED

public static final java.lang.String FORMAT_DELIMITED

FORMAT_FIXED

public static final java.lang.String FORMAT_FIXED

FORMAT_XML

public static final java.lang.String FORMAT_XML

HTTP_METHOD

public static final java.lang.String HTTP_METHOD

USERNAME

public static final java.lang.String USERNAME

PASSWORD

public static final java.lang.String PASSWORD

FTP_MODE

public static final java.lang.String FTP_MODE

SQL_QUERY

public static final java.lang.String SQL_QUERY

STYLESHEET

public static final java.lang.String STYLESHEET

DELIMITER

public static final java.lang.String DELIMITER

LINESEP

public static final java.lang.String LINESEP

QUOTECHAR

public static final java.lang.String QUOTECHAR

COLUMN_NUMBER

public static final java.lang.String COLUMN_NUMBER

STARTPOS

public static final java.lang.String STARTPOS

ENDPOS

public static final java.lang.String ENDPOS

Method Detail

getName

public java.lang.String getName()

Get the name of this content provider.

Returns:

the name of this content provider

setName

public void setName(java.lang.String name)

Set the name of this content provider

Parameters:

content - provider name

getPrimarySource

public java.lang.String getPrimarySource()

Get the source of data for this content provider. This will typically be an URI for HTTP/FTP, a file name for app/file.

Returns:

the source string (i.e. URL) for the data of this content provider

setPrimarySource

public void setPrimarySource(java.lang.String source)

Set the source of data for this content provider.

Parameters:

source - the source string (i.e. URL) of data for this content provider

getProtocolTypes

public java.lang.String[] getProtocolTypes()

Get a list of valid protocol names. These are the valid protocol names to use for the @see setProtocolType.

Returns:

the list of current protocols.

setProtocolType

public void setProtocolType(java.lang.String protocolName)

Set the protocol to use

Parameters:

name - of protocol, see the PROTOCOL_* constants defined in this interface for a list of valid values

getProtocolType

public java.lang.String getProtocolType()

Get the name of the current protocol

Returns:

the current protocol type

setProtocolArguments

public void setProtocolArguments(java.util.Map initArgs)

Set the arguments to use for the current protocol

Parameters:

initArgs - arguments to use for the current protocol

getProtocolArguments

public java.util.Map getProtocolArguments()

Get the arguments to use for the current protocol

Returns:

arguments to use for the current protocol

getProtocolArgumentDefs

public java.util.Map getProtocolArgumentDefs()

Get the valid arguments for the current protocol. For use by the Service designer

Returns:

valid arguments to use for the current protocol

getFormatTypes

public java.lang.String[] getFormatTypes()

Get a list of valid format names. These are the valid format names to use for the @see setFormatType.

Returns:

the list of current format.

setFormatType

public void setFormatType(java.lang.String formatName)

Set the format to use

Parameters:

name - of format, see the FORMAT_* constants defined in this interface for a list of valid values

getFormatType

public java.lang.String getFormatType()

Get the name of the current format

Returns:

the current format type

setFormatArguments

public void setFormatArguments(java.util.Map initArgs)

Set the arguments to use for the current format

Parameters:

initArgs - arguments to use for the current format

getFormatArguments

public java.util.Map getFormatArguments()

Get the arguments currently used for the current format

Returns:

Map arguments currently used for the current format

getFormatArgumentDefs

public java.util.Map getFormatArgumentDefs()

Get the valid arguments for the current format. For use by the Service designer

Returns:

Map valid arguments to use for the current format

setDataFilterHook

public void setDataFilterHook(java.lang.String className)

Set the data filter hook to use

Parameters:

className - class to use for the data filter hook

See Also:

<{FeedDataFilterHook}>

getDataFilterHook

public java.lang.String getDataFilterHook()

Get the current data filter hook used

Returns:

className class to use for the data filter hook, null if not set

setExternalNameForParameter

public void setExternalNameForParameter(FeedMetaData parameter,
                                        java.lang.String externalName)
                                 throws PanamaException

Set the external name that this ContentProvider uses for the given parameter.

Parameters:

parameter - a parameter that has been defined for the DataFeeder that owns this ContentProvider

the - external name for this parameter.

getExternalNameForParameter

public java.lang.String getExternalNameForParameter(FeedMetaData parameter)

Get the external name that this ContentProvider uses for the given parameter.

Parameters:

parameter - a parameter that has been defined for the DataFeeder that owns this ContentProvider

Returns:

the external name for this parameter

getParamArgumentDefs

public java.util.Map getParamArgumentDefs()

Get the list of parameter arguments that can be specified on a per-CP basis for the current format. Parameter arguments include

1. the external name for the parameter
2. the ordinal column number for the parameter (format=Delimited)
3. the text column number for the parameter (format=Text)

Returns:

the list of parameter arguments that can be specified on a per-CP basis for the current format.

getParamArguments

public java.util.Map getParamArguments(FeedMetaData parameter)

Get the arguments currently set for this CP for the given parameter.

Parameters:

FeedMetaData - parameter the parameter to get options for

Returns:

the arguments currently set for this CP for the given parameter.

setParamArguments

public void setParamArguments(FeedMetaData parameter,
                              java.util.Map arguments)

Set the parameter argument for this parameter. A list of valid parameter arguments can be retrieved using @see getParamArgumentDefs

Parameters:

FeedMetaData - parameter the parameter to set options for

Map - arguments the parameter options to set for the given parameter

getUpdatePolicy

public UpdatePolicy getUpdatePolicy()

Get the update policy for the current content provider If for example you need to modify the batch size for the feed you would do the following: dataFeed.getContentProvider().getUpdatePolicy().setBatchSize(100); Currently, each ContentProvider has one default UpdatePolicy. Multiple UpdatePolicies may be supported in a future release.

Returns:

the current Update Policy

getDataSource

public java.lang.String getDataSource()

Get the current DataSource implementation class name.

Returns:

String the current DataSource implementation class name

setDataSource

public void setDataSource(java.lang.String dataSource)

Set the current DataSource implementation class name.

Parameters:

String - dataSource name of class that implements DataSource interface

getDataParser

public java.lang.String getDataParser()

Get the current DataParser implementation class name.

Returns:

String the current DataParser implementation class name

setDataParser

public void setDataParser(java.lang.String dataParser)

Set the current DataParser implementation class name.

Parameters:

dataParser - name of class that implements DataParser interface

getNullValue

public java.lang.String getNullValue()

Get the null value specified for this ContentProvider

Returns:

content provider null value

setNullValue

public void setNullValue(java.lang.String nullValue)

Set the null value that is used by this ContentProvider

Parameters:

content - provider null value