|
Oracle interMedia Java Classes API Reference 10g Release 1 (10.1) Part No. B12248-01 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
oracle.ord.im.OrdImage
The OrdImage class is used to represent an instance of the ORDSYS.ORDImage database type in a Java application. The OrdImage class includes a set of methods to get and set various object attributes, plus a set of methods that perform various operations on an OrdImage Java object.
Users of this class are assumed to be familiar with Oracle interMedia Java Classes User's Guide and Reference and Oracle interMedia User's Guide and Reference.
All methods operate on the attributes of the OrdImage Java object in the application with the exception of those methods that access the image data for read or write purposes.
If your application modifies the OrdImage Java object, or the image data in the database, you must update the ORDImage SQL object in the database to make those changes permanent.
Some methods in the OrdImage Java class are handed off to a database source plug-in for processing; these methods have byte [] ctx []
as a context parameter. Applications should allocate a 64-byte array to hold any context information that may be required by a source plug-in. For example, a plug-in may initialize the context information in one call and use that information in a subsequent call. Note that 64 bytes should be sufficient for most plug-ins, however, some user-defined plug-ins may need additional space. The following example illustrates how to allocate the array:
byte [] ctx [] = new byte[1][64];
Constructor Summary | |
OrdImage() Internal constructor used only by the Oracle ORAData interface factory method to create an instance of the class. |
Method Summary | |
boolean |
checkProperties() Checks if the properties of the image data are consistent with the attributes of the OrdImage Java object. |
void |
clearLocal() Clears the local attribute to indicate that the image data is stored externally. |
void |
copy(OrdImage dest) Copies an OrdImage Java object. |
oracle.sql.CustomDatum |
create(oracle.sql.Datum d, int sqlType) Internal method used only by the Oracle CustomDatum interface. |
void |
deleteContent() Deletes any data stored in the database BLOB specified by the localData attribute. |
void |
export(byte[][] ctx, java.lang.String srcType, java.lang.String srcLocation, java.lang.String srcName) Exports the data from the BLOB specified by the localData attribute. |
oracle.sql.BFILE |
getBFILE() Returns a BFILE locator from the database when the srcType attribute is "FILE". |
java.lang.String |
getCompressionFormat() Returns the compressionFormat attribute. |
oracle.sql.BLOB |
getContent() Returns the BLOB locator from the localData attribute. |
java.lang.String |
getContentFormat() Returns the contentFormat attribute. |
int |
getContentLength() Returns the contentLength attribute. |
byte[] |
getDataInByteArray() Returns a byte array containing the data from the database BLOB specified by the localData attribute. |
boolean |
getDataInFile(java.lang.String filename) Writes the data from the database BLOB specified by the localData attribute to a local file. |
java.io.InputStream |
getDataInStream() Returns an InputStream from which the data in the database BLOB specified by the localData attribute can be read. |
static oracle.sql.CustomDatumFactory |
getFactory() Deprecated. CustomDatumFactory method. New applications should use the ORADataFactory interface |
java.lang.String |
getFormat() Returns the fileFormat attribute. |
int |
getHeight() Returns the height attribute. |
java.lang.String |
getMimeType() Returns the mimeType attribute. |
static oracle.sql.ORADataFactory |
getORADataFactory() Returns the OrdImage ORADataFactory for use by the getORAData method. |
java.lang.String |
getSource() Returns the source information in the form srcType://srcLocation/srcName . |
java.lang.String |
getSourceLocation() Returns the srcLocation attribute. |
java.lang.String |
getSourceName() Returns the srcName attribute. |
java.lang.String |
getSourceType() Returns the srcType attribute. |
java.sql.Timestamp |
getUpdateTime() Returns the updateTime attribute. |
int |
getWidth() Returns the width attribute. |
void |
importData(byte[][] ctx) Imports data from an external source into the database BLOB specified by the localData attribute. |
void |
importFrom(byte[][] ctx, java.lang.String srcType, java.lang.String srcLocation, java.lang.String srcName) Imports data from an external source into the database BLOB specified by the localData attribute. |
boolean |
isLocal() Indicates if the image data is stored locally in the database in a BLOB specified by the localData attribute. |
boolean |
loadDataFromByteArray(byte[] byteArr) Loads data from a byte array into the database BLOB specified by the localData attribute. |
boolean |
loadDataFromFile(java.lang.String filename) Loads data from a file into the database BLOB specified by the localData attribute. |
boolean |
loadDataFromInputStream(java.io.InputStream inpStream) Loads data from an InputStream into the database BLOB specified by the localData attribute. |
void |
process(java.lang.String cmd) Performs one or more image processing operations on the image data in the database BLOB specified by the localData attribute. |
void |
processCopy(java.lang.String cmd, OrdImage dest) Copies the image data to the destination object and performs one or more image processing operations on the image data. |
void |
setCompressionFormat(java.lang.String compressionFormat) Sets the compressionFormat attribute. |
void |
setContentFormat(java.lang.String contentFormat) Sets the contentFormat attribute. |
void |
setContentLength(int contentLength) Sets the contentLength attribute. |
void |
setFormat(java.lang.String fileFormat) Sets the fileFormat attribute. |
void |
setHeight(int height) Sets the height attribute. |
void |
setLocal() Sets the local attribute to indicate that the image data is stored locally in the database in a BLOB specified by the localData attribute. |
void |
setMimeType(java.lang.String mimeType) Sets the mimeType attribute. |
void |
setProperties() Parses the image data properties and sets the attributes in the OrdImage Java object. |
void |
setProperties(java.lang.String description) Writes the characteristics of a foreign image into the appropriate attribute fields. |
void |
setSource(java.lang.String srcType, java.lang.String srcLocation, java.lang.String srcName) Sets the srcType, srcLocation, and srcName attributes. |
void |
setUpdateTime(java.sql.Timestamp currentTime) Sets the updateTime attribute. |
void |
setWidth(int width) Sets the width attribute. |
Constructor Detail |
public OrdImage()
Method Detail |
public boolean isLocal() throws java.sql.SQLException
true
if the data is stored locally in the database in a BLOB, false
otherwise.public void setLocal() throws java.sql.SQLException
public void clearLocal() throws java.sql.SQLException
public java.lang.String getSourceType() throws java.sql.SQLException
String
.public java.lang.String getSourceLocation() throws java.sql.SQLException
String
.public java.lang.String getSourceName() throws java.sql.SQLException
String
.public java.lang.String getSource() throws java.sql.SQLException
srcType://srcLocation/srcName
.String
.public void setSource(java.lang.String srcType, java.lang.String srcLocation, java.lang.String srcName) throws java.sql.SQLException
srcType
- the source type, for example, "FILE", "HTTP".srcLocation
- the source location, for example, IMAGES_DIR, www.xyzcoimages.com/public.srcName
- the source name, for example, scenery1.jpgpublic java.sql.Timestamp getUpdateTime() throws java.sql.SQLException
java.sql.Timestamp
.public void setUpdateTime(java.sql.Timestamp currentTime) throws java.sql.SQLException
currentTime
- the update time in a java.sql.Timestamp
, or null
to set the update time to the database server's current SYSDATE time.public oracle.sql.BLOB getContent() throws java.sql.SQLException
oracle.sql.BLOB
.public oracle.sql.BFILE getBFILE() throws java.sql.SQLException
oracle.sql.BFILE
.public int getHeight() throws java.sql.SQLException
int
.public void setHeight(int height) throws java.sql.SQLException
setProperties
sets this attribute automatically for certain image formats; use this method only if you are not using setProperties. This method sets the attribute value only; it does not modify the image data itself.height
- the new attribute value.public int getWidth() throws java.sql.SQLException
int
.public void setWidth(int width) throws java.sql.SQLException
setProperties
sets this attribute automatically for certain image formats; use this method only if you are not using setProperties. This method sets the attribute value only; it does not modify the image data itself.width
- the new attribute value.public int getContentLength() throws java.sql.SQLException
int
.public void setContentLength(int contentLength) throws java.sql.SQLException
setProperties
sets this attribute automatically for certain media formats; use this method only if you are not using setProperties. This method sets the attribute value only; it does not modify the media data itself.contentLength
- the new attribute value.public java.lang.String getFormat() throws java.sql.SQLException
String
.public void setFormat(java.lang.String fileFormat) throws java.sql.SQLException
setProperties
sets this attribute automatically for certain media formats; use this method only if you are not using setProperties. This method sets the attribute value only; it does not modify the media data itself. Set the fileFormat attribute to a String
beginning with "OTHER" to disable the automatic call to setProperties by the importData
and importFrom
methods.fileFormat
- the new attribute value.public java.lang.String getContentFormat() throws java.sql.SQLException
String
.public void setContentFormat(java.lang.String contentFormat) throws java.sql.SQLException
setProperties
sets this attribute automatically for certain media formats; use this method only if you are not using setProperties. This method sets the attribute value only; it does not modify the media data itself.contentFormat
- the new attribute value.public java.lang.String getCompressionFormat() throws java.sql.SQLException
String
.public void setCompressionFormat(java.lang.String compressionFormat) throws java.sql.SQLException
setProperties
sets this attribute automatically for certain media formats; use this method only if you are not using setProperties. This method sets the attribute value only; it does not modify the media data itself.compressionFormat
- the new attribute value.public java.lang.String getMimeType() throws java.sql.SQLException
String
.public void setMimeType(java.lang.String mimeType) throws java.sql.SQLException
setProperties
sets this attribute automatically for certain media formats; use this method only if you are not using setProperties. This method sets the attribute value only; it does not modify the media data itself.mimeType
- the new attribute value.public boolean loadDataFromFile(java.lang.String filename) throws java.sql.SQLException, java.io.IOException
deleteContent()
, to delete any existing data in the BLOB.setLocal()
, to set the local flag.setUpdateTime()
, to set the updateTime attribute to the database server's current SYSDATE time.filename
- name of the file from which to load data.true
if the data is loaded successfully; otherwise, an exception is raised if an error occurs. This method never returns false
.public boolean loadDataFromInputStream(java.io.InputStream inpStream) throws java.sql.SQLException, java.io.IOException
deleteContent()
, to delete any existing data in the BLOB.setLocal()
, to set the local flag.setUpdateTime()
, to set the updateTime attribute to the database server's current SYSDATE time.inpStream
- the InputStream
from which to load data.true
if the data is loaded successfully; otherwise, an exception is raised if an error occurs. This method never returns false
.public boolean loadDataFromByteArray(byte[] byteArr) throws java.sql.SQLException, java.io.IOException
deleteContent()
, to delete any existing data in the BLOB.setLocal()
, to set the local flag.setUpdateTime()
, to set the updateTime attribute to the database server's current SYSDATE time.byteArr
- a byte[]
arrary from which to load data.true
if the data is loaded successfully; otherwise, an exception is raised if an error occurs. This method never returns false
.public boolean getDataInFile(java.lang.String filename) throws java.sql.SQLException, java.io.IOException
filename
- name of the file to which the data is to be written.true
if the data is written to the file successfully; otherwise, an exception is raised if an error occurs. This method never returns false
.public java.io.InputStream getDataInStream() throws java.sql.SQLException
InputStream
from which the data can be read.public byte[] getDataInByteArray() throws java.sql.SQLException, java.io.IOException, java.lang.OutOfMemoryError
byte[]
array containing the data.public void deleteContent() throws java.sql.SQLException
public void importData(byte[][] ctx) throws java.sql.SQLException
setFormat
to set the fileFormat to a String
beginning with "OTHER" to disable the automatic call to setProperties.ctx
- the source plug-in context information.public void importFrom(byte[][] ctx, java.lang.String srcType, java.lang.String srcLocation, java.lang.String srcName) throws java.sql.SQLException
setFormat
to set the fileFormat to "OTHER" to disable the automatic call to setProperties.ctx
- the source plug-in context information.srcType
- the source type, for example, "FILE", "HTTP".srcLocation
- the source location, for example, IMAGES_DIR, www.xyzcoimages.com/public.srcName
- the source name, for example, scenery1.jpg.public void export(byte[][] ctx, java.lang.String srcType, java.lang.String srcLocation, java.lang.String srcName) throws java.sql.SQLException
Not all source plug-ins support the export method. For example, the "FILE" source type is the only Oracle-supplied source type that supports the export method. In addition, this method is supported only by Oracle database server release 8.1.7 or later.
The remainder of this description illustrates the use of the export method and the Oracle-supplied "FILE" source plug-in. User-written plug-ins will have different behaviors.
The export method implemented by the Oracle-supplied "FILE" source plug-in copies the image data from the BLOB specified by the localData attribute, but does not modify the image data stored in the database BLOB in any way.
After exporting the image data, all the image property attributes remain unchanged, however, the srcType, srcLocation, and srcName attributes are updated with values of the srcType, srcLocation, and srcName parameters passed to the export method. After calling the export method, if you no longer intend to manage the image data within the database, call the clearLocal()
method to indicate the image data is stored outside the database and call the deleteContent()
method to delete the image data stored in the database BLOB.
The export method in the database writes only to a database directory object that the user has privilege to access. That is, you can access a directory that you have created using the SQL CREATE DIRECTORY statement, or one to which you have been granted READ access. To execute the CREATE DIRECTORY statement, you must have the CREATE ANY DIRECTORY privilege. In addition, you must use the DBMS_JAVA.GRANT_PERMISSION method to specify which files can be written.
For example, the following SQL*Plus command grants the user, MEDIAUSER
, the permission to write to the file named scenery1.jpg
.
CALL DBMS_JAVA.GRANT_PERMISSION( 'MEDIAUSER', 'java.io.FilePermission', '/images/outdoors/scenery1.jpg', 'write');
The previous example illustrates how to authorize access to write to a single file. In addition, there are various wildcard path specifications that authorize write access to multiple directories and file names. For example, a path specification that ends in "/*"
(where "/"
is the operating-system dependent file separator character) indicates all the files contained in the specified directory. A path specification that ends with "/-"
indicates all files contained in the specified directory and all its subdirectories. A pathname consisting of the special token "<<ALL FILES>>"
authorizes access to any file.
See the security and performance section in Oracle Java Developer's Guide and the java.io.FilePermission class in the Java API for more information.
ctx
- the source plug-in context information.srcType
- the source type, for example, "FILE".srcLocation
- the source location, for example, IMAGES_DIR.srcName
- the source name, for example, scenery1.jpg.public void setProperties() throws java.sql.SQLException
public void setProperties(java.lang.String description) throws java.sql.SQLException
description
- a String
that specifies the image characteristics to set for the foreign image.public boolean checkProperties() throws java.sql.SQLException
true
if the properties of the image data are consistent with the attributes of the OrdImage Java object; false
otherwise.public void process(java.lang.String cmd) throws java.sql.SQLException
cmd
- a String
that specifies a list of image processing operations to perform on the image.public void copy(OrdImage dest) throws java.sql.SQLException
dest
- the destination OrdImage
object.public void processCopy(java.lang.String cmd, OrdImage dest) throws java.sql.SQLException
cmd
- a String
that specifies a list of image processing operations to perform on the image.dest
- the destination OrdImage
object.public static oracle.sql.ORADataFactory getORADataFactory()
OrdImage img = (OrdImage)rset.getORAData( 1, OrdImage.getORADataFactory() );
public static oracle.sql.CustomDatumFactory getFactory()
public oracle.sql.CustomDatum create(oracle.sql.Datum d, int sqlType) throws java.sql.SQLException
|
Oracle interMedia Java Classes API Reference 10g Release 1 (10.1) Part No. B12248-01 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |