oracle.panama.feed
Interface FeedUtil

public interface FeedUtil

Utility class for getting feed constants. This is a Singleton class: get the singleton instance using the FeedLocator.

See Also:

FeedLocator

Field Summary

Type	Field
static java.lang.String	NULL_CONTENT

Method Summary

Type	Method
java.lang.String	getArgumentDisplayName(java.lang.String key)
java.util.Map	getFormatArgumentDefs(java.lang.String format) Get the valid arguments for a given format.
java.lang.String[]	getFormatNames() Get the list of currently installed formats.
java.util.Map	getParamArgumentDefs(java.lang.String format) Get the list of parameter arguments that can be specified on a per-CP basis for the current format.
java.lang.String[]	getParameterDataTypes() Deprecated. use DataType[] getPtgDataTypes() instead
java.util.Map	getProtocolArgumentDefs(java.lang.String protocol) Get the valid arguments for the current protocol.
java.lang.String[]	getProtocolNames() Get the list of currently installed protocols.
DataType[]	getPtgDataTypes() Get a list of valid data types to use for the DataFeeder parameters.
boolean	isColumnNameValid(java.lang.String paramName) Check if the parameter name is valid for being used as a database column name.

Field Detail

NULL_CONTENT

public static final java.lang.String NULL_CONTENT

Method Detail

getProtocolNames

public java.lang.String[] getProtocolNames()

Get the list of currently installed protocols.

Returns:

array of valid protocol names

getProtocolArgumentDefs

public java.util.Map getProtocolArgumentDefs(java.lang.String protocol)

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

Parameters:

protocol - name

Returns:

valid arguments to use for the current protocol

getFormatNames

public java.lang.String[] getFormatNames()

Get the list of currently installed formats.

Returns:

array of format names

getFormatArgumentDefs

public java.util.Map getFormatArgumentDefs(java.lang.String format)

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

Parameters:

format - name

Returns:

valid arguments to use for the given format

getParamArgumentDefs

public java.util.Map getParamArgumentDefs(java.lang.String format)

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.

getParameterDataTypes

public java.lang.String[] getParameterDataTypes()
                                         throws PanamaException

Deprecated. use DataType[] getPtgDataTypes() instead

Get a list of valid data types to use for the DataFeeder parameters. These are the data types that can be used when creating a new DataFeeder parameter

Returns:

String[] array of valid type names

See Also:

DataFeeder.createMetaData, FeedMetaData.getDataType

getPtgDataTypes

public DataType[] getPtgDataTypes()
                           throws PanamaException

Get a list of valid data types to use for the DataFeeder parameters. These are the data types that can be used when creating a new DataFeeder parameter

Returns:

DataType[] array of valid ptg data type objects

See Also:

DataFeeder.createMetaData, FeedMetaData.getDataType

isColumnNameValid

public boolean isColumnNameValid(java.lang.String paramName)

Check if the parameter name is valid for being used as a database column name. The rule is that a valid column name must begin with a letter, be less than or equal to 30 characters, and consist of only alphanumeric characters and the special characters $, _, and #. Additionallym it may not be a reserved word in SQL.

Parameters:

name - of the parameter

Returns:

boolean true if valid or false otherwise.

getArgumentDisplayName

public java.lang.String getArgumentDisplayName(java.lang.String key)

Parameters:

key - an argument definition returnrned from getArgumentDefs

Returns:

the display name for the given argument and current locale