public class DataFormat
extends java.lang.Object
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 contentModifier 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 |
MULTI_NUM_PARTS |
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 and Description |
---|
DataFormat(java.lang.String format)
Instantiate this DataFormat.
|
DataFormat(java.lang.String format,
java.util.Map formatProps)
Instantiate this DataFormat
|
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.
|
public static final java.lang.String FORMAT_XML
public static final java.lang.String FORMAT_CSV
public static final java.lang.String ENC_STYLE
public static final java.lang.String IS_FIRST_ROW_NAMES
public static final java.lang.String DELIMITER
public static final java.lang.String QUOTE_CHAR
public static final java.lang.String TRANS_LOC
public static final java.lang.String TRANS_RESULT
public static final java.lang.String MULTI_NUM_PARTS
public DataFormat(java.lang.String format)
format
- The data format value for this DataFormatpublic DataFormat(java.lang.String format, java.util.Map formatProps)
format
- The data format value for this DataFormat.formatProps
- The properties for this data formatpublic void addProperty(java.lang.String propName, java.lang.String propVal)
propName
- The Name of this propertypropVal
- The property Valuepublic void addProperty(java.lang.String propName, java.lang.Object propVal)
propName
- The Name of this propertypropVal
- The property Valuepublic java.lang.String getFormat()
public java.lang.Object getProperty(java.lang.String propName)
propName
- the Property to be queriedpublic java.util.Map getProperties()
Map
of all the properties for this
DataFormat.public java.lang.Object processData(java.lang.Object source, java.lang.Object referenceRoot, java.lang.String returnType) throws java.lang.Exception
source
- The raw data to be processed.FormatDataHandler
.java.lang.Exception
public java.lang.Object processData(java.lang.Object source, java.lang.Object referenceRoot, java.lang.String returnType, boolean isStructureV2) throws java.lang.Exception
source
- The raw data to be processed.referenceRoot
- returnType
- isStructureV2
- will make sure results are fetched without accessor name.FormatDataHandler
.java.lang.Exception