The DataHandler class is the base class for the data handlers. It is contained in the com.crossworlds.DataHandlers package. All data handlers, including custom data handlers, must extend this abstract class.
The methods documented in this chapter fall into three categories:
Table 78 lists the methods of the DataHandler
class.
Table 78. Member methods of the DataHandler class
Member methods | Type | Description | Page |
---|---|---|---|
createHandler() | Public Static | Creates an instance of a data handler. | createHandler() |
getBO() - abstract | Abstract | Populates a business object with values extracted from serialized input data. | getBO() - abstract |
getBO() - public | Public | Converts serialized data to a business object. | getBO() - public |
getBOName() | Public | Gets the name of a business object based on the content of the serialized data. | getBOName() |
getBooleanOption() | Public | Gets the value of the specified data-handler configuration option if it contains Boolean data. | getBooleanOption() |
getByteArrayFromBO() | Public | Serializes a business object into a byte array. | getByteArrayFromBO() |
getEncoding() | Public | Retrieves the character encoding that the data handler is using. | getEncoding() |
getLocale() | Public | Retrieves the locale of the data handler. | getLocale() |
getOption() | Public | Gets the value of the specified data-handler configuration option (if it has been set). | getOption() |
getStreamFromBO() | Abstract | Serializes a business object into an InputStream object. | getStreamFromBO() |
getStringFromBO() | Abstract | Serializes a business object into a String object. | getStringFromBO() |
setConfigMOName() | Static | Sets the name of the top-level data-handler meta-object in a static property of the DataHandler base class. | setConfigMOName() |
setEncoding() | Public | Sets the character encoding that the data handler is using. | setEncoding() |
setLocale() | Public | Sets the locale of the data handler. | setLocale() |
setOption() | Public | Sets the value of the specified data-handler configuration option. | setOption() |
traceWrite() | Public | Calls the appropriate trace-write function to write a trace message for the data handler. | traceWrite() |