Oracle® interMedia Java Classes Reference 10g Release 1 (10.1) Part Number B10830-01 |
|
|
View PDF |
Format
public void setProperties(byte[ ] [ ] ctx, boolean setComments)
Description
Parses the media data properties, sets the values of the attributes in the OrdDoc Java object, and optionally populates the CLOB specified by the comments attribute. This method sets the values of the format, mimeType, and contentLength attributes. An attribute is set to null if the corresponding property cannot be extracted for a specific media format. If the setComments parameter is true, this method also populates the CLOB specified by the comments attribute with all extracted properties in XML form. If the setComments parameter is false, the comments attribute is not modified. This method throws a SQLException error if the media format is not recognized.
The format attribute determines which format plug-in is used to parse the media data properties. If the format attribute is null when the setProperties( ) method is called, then the default, Oracle-supplied, format plug-in is used to parse the media data properties and fill in various attributes, including the actual media data format, for supported media formats. See Oracle interMedia Reference for information on the media formats supported by the Oracle-supplied format plug-ins. Note that the ORDDoc.init methods in the database always set the value of the format attribute to null. If the format attribute is not null, then the format plug-in specified by the format attribute will be called when the setProperties( ) method is called.
Parameters
The format plug-in context information.
A Boolean value that specifies whether or not to populate the CLOB specified by the comments attribute.
Return Value
None.
Exceptions
java.sql.SQLException
This exception is thrown if an error occurs executing the corresponding setProperties( ) method in the database.
Examples
None.