oracle.adfinternal.model.adapter.webservice

Class DataFormat

java.lang.Object

oracle.adfinternal.model.adapter.webservice.DataFormat

public class DataFormat
extends java.lang.Object

DataFormat defines the format of the SOAP response contents. The repsonse envelope though in XML format can actually contain different data in the body. The content of the body could be a CSV stream or HTML content

Since:

10.1.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DELIMITER Delimiter character for CSV data
static java.lang.String	ENC_STYLE Encoding style for CSV format
static java.lang.String	FORMAT_CSV CSV format
static java.lang.String	FORMAT_XML XML format
static java.lang.String	IS_FIRST_ROW_NAMES does the first row of CSV stream denote column names
static java.lang.String	QUOTE_CHAR Quote character for CSV data
static java.lang.String	TRANS_LOC XSL Location for XML format
static java.lang.String	TRANS_RESULT

Constructor Summary

Constructors

Constructor and Description
DataFormat(java.lang.String format) Instantiate this DataFormat.
DataFormat(java.lang.String format, java.util.Map formatProps) Instantiate this DataFormat

Method Summary

Methods

Modifier and Type	Method and Description
void	addProperty(java.lang.String propName, java.lang.Object propVal) Add a property to this DataFormat
void	addProperty(java.lang.String propName, java.lang.String propVal) Add a property to this DataFormat
java.lang.String	getFormat() Get the format represented by this Data Format
java.util.Map	getProperties() Get all the properties associated with this DataFormat
java.lang.Object	getProperty(java.lang.String propName) Get the specified property for this DataFormat
java.lang.Object	processData(java.lang.Object source, java.lang.Object referenceRoot, java.lang.String returnType) Process the data based on the handler properties this data format encapsulates.
java.lang.Object	processData(java.lang.Object source, java.lang.Object referenceRoot, java.lang.String returnType, boolean isStructureV2) Process the data based on the handler properties this data format encapsulates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORMAT_XML

public static final java.lang.String FORMAT_XML

XML format

See Also:

Constant Field Values

FORMAT_CSV

public static final java.lang.String FORMAT_CSV

CSV format

See Also:

Constant Field Values

ENC_STYLE

public static final java.lang.String ENC_STYLE

Encoding style for CSV format

See Also:

Constant Field Values

IS_FIRST_ROW_NAMES

public static final java.lang.String IS_FIRST_ROW_NAMES

does the first row of CSV stream denote column names

See Also:

Constant Field Values

DELIMITER

public static final java.lang.String DELIMITER

Delimiter character for CSV data

See Also:

Constant Field Values

QUOTE_CHAR

public static final java.lang.String QUOTE_CHAR

Quote character for CSV data

See Also:

Constant Field Values

TRANS_LOC

public static final java.lang.String TRANS_LOC

XSL Location for XML format

See Also:

Constant Field Values

TRANS_RESULT

public static final java.lang.String TRANS_RESULT

See Also:

Constant Field Values

Constructor Detail

DataFormat

public DataFormat(java.lang.String format)

Instantiate this DataFormat.

Parameters:

format - The data format value for this DataFormat

DataFormat

public DataFormat(java.lang.String format,
          java.util.Map formatProps)

Instantiate this DataFormat

Parameters:

format - The data format value for this DataFormat.

formatProps - The properties for this data format

Method Detail

addProperty

public void addProperty(java.lang.String propName,
               java.lang.String propVal)

Add a property to this DataFormat

Parameters:

propName - The Name of this property

propVal - The property Value

addProperty

public void addProperty(java.lang.String propName,
               java.lang.Object propVal)

Add a property to this DataFormat

Parameters:

propName - The Name of this property

propVal - The property Value

getFormat

public java.lang.String getFormat()

Get the format represented by this Data Format

Returns:

The format represented by this DataFormat

getProperty

public java.lang.Object getProperty(java.lang.String propName)

Get the specified property for this DataFormat

Parameters:

propName - the Property to be queried

getProperties

public java.util.Map getProperties()

Get all the properties associated with this DataFormat

Returns:

Map of all the properties for this DataFormat.

processData

public java.lang.Object processData(java.lang.Object source,
                           java.lang.Object referenceRoot,
                           java.lang.String returnType)
                             throws java.lang.Exception

Process the data based on the handler properties this data format encapsulates.

Parameters:

source - The raw data to be processed.

Returns:

The processed data representation as is provided by the FormatDataHandler.

Throws:

java.lang.Exception

processData

public java.lang.Object processData(java.lang.Object source,
                           java.lang.Object referenceRoot,
                           java.lang.String returnType,
                           boolean isStructureV2)
                             throws java.lang.Exception

Process the data based on the handler properties this data format encapsulates.

Parameters:

source - The raw data to be processed.

referenceRoot -

returnType -

isStructureV2 - will make sure results are fetched without accessor name.

Returns:

The processed data representation as is provided by the FormatDataHandler.

Throws:

java.lang.Exception