|
Oracle ADF Business Components interMedia Domains API Reference Oracle JDeveloper 10g (10.1.2) B10394-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ord.im.OrdImageBase
oracle.ord.im.OrdImage
oracle.ord.im.OrdImageDomain
Represents interMedia ORDSYS.ORDImage database type as a domain class in the Business Component for Java (BC4J) framework. Most methods in this class are BC4J tier independent. They can work on either the client tier or the middle tier, which allows the application which uses these methods to work in a tier independent fashion. There are some exceptions which are marked as local mode only:
getContent
getBFILE
The BC4J tier independent counterparts of these two methods are the following:
getContentAsBlobDomain
getBFileDomain
The term client tier refers to the machine on which the application client is running. Middle tier refers to the server on which the BC4J business components are deployed. The user can use "local mode only" methods when he deploys BC4J and the client application to the same machine. Whereas, the user should use tier independent methods when the application client and BC4J reside on separate machines.
The constructor for this class will create an instance of an OrdImageDomain
. The user should either manually obtain a valid BLOB locator and a JDBC connection for this instance, or rely on the BC4J framework to obtain a BLOB locator and a JDBC connection for it. See OrdContentSource
for discussion about how to load media content to the database by using the interMedia BC4J domain classes.
OrdImage
, Serialized FormField Summary |
Fields inherited from class oracle.ord.im.OrdImageBase |
_SQL_NAME, _SQL_TYPECODE |
Constructor Summary | |
OrdImageDomain() Constructs a new OrdImageDomain instance. |
|
OrdImageDomain(byte[] bytes) Constructs a new OrdImageDomain instance. |
|
OrdImageDomain(OrdContentSource source) Constructs a new OrdImageDomain instance. |
|
OrdImageDomain(OrdHttpUploadFile ohuf) Constructs a new OrdImageDomain instance. |
|
OrdImageDomain(java.lang.String fileName) Constructs a new OrdImageDomain instance. |
Method Summary | |
boolean |
checkProperties() Checks if the properties of the image data are consistent with the attributes of the OrdImage Java object. |
void |
clearContentSource() Internal: Applications should not use this method. |
void |
clearLocal() Clears the attribute called local to indicate that the content 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. |
java.lang.Object |
createDomainFromSerializedXML(org.w3c.dom.Element element) Create a domain instance by reading the xml-data out of the given xml-node. |
void |
deleteContent() Deletes any data stored in the database BLOB specified by the localData attribute. |
void |
domainToBeModified(oracle.jbo.domain.DomainInterface d) Internal: Applications should not use this method. |
void |
doneCommit(oracle.jbo.TransactionStateEvent event) Internal: Applications should not use this method. |
void |
doneRollback(oracle.jbo.TransactionStateEvent event) Internal: Applications should not use this method. |
boolean |
equals(java.lang.Object obj) Compares two OrdImageDomain objects by their last update time and content length. |
void |
export(byte[][] ctx, java.lang.String sourceType, java.lang.String sourceLocation, java.lang.String sourceName) Exports the data from the BLOB specified by the localData attribute. |
void |
generateTempFilePath() Internal: Applications should not use this method. |
java.lang.Object |
getAttribute(int index) Internal: Applications should not use this method. |
java.lang.Object |
getAttribute(java.lang.String name) Internal: Applications should not use this method. |
int |
getAttributeCount() Internal: Applications should not use this method. |
int |
getAttributeIndexOf(java.lang.String name) Internal: Applications should not use this method. |
java.lang.String[] |
getAttributeNames() |
java.lang.Object[] |
getAttributeValues() |
oracle.sql.BFILE |
getBFILE() Returns a BFILE locator from the database when the srcType attribute is "FILE". |
oracle.jbo.domain.BFileDomain |
getBFileDomain() Returns a BFileDomain object which wraps the BFILE locator obtained from the getBFILE method. |
java.lang.String |
getCompressionFormat() Returns the value of the compressionFormat attribute. |
oracle.sql.BLOB |
getContent() Returns the BLOB locator from the localData attribute. |
oracle.jbo.domain.BlobDomain |
getContentAsBlobDomain() Returns a BlobDomain object which wraps the BLOB locator from the localData attribute. |
java.lang.String |
getContentFormat() Returns the value of the contentFormat attribute. |
int |
getContentLength() Returns the contentLength attribute. |
OrdContentSource |
getContentSource() Gets the content source which was previously set by the setContentSource method. |
java.lang.Object |
getCTPassivationHandle() Internal: Applications should not use this method. |
static oracle.sql.CustomDatumFactory |
getCustomDatumFactory() Internal: Applications should not use this method. |
java.lang.Object |
getData() Internal: Applications should not use this method. |
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() Returns the OrdImageDomain CustomDatumFactory for use by the getCustomDatum method. |
java.lang.String |
getFormat() Returns the value of the fileFormat attribute. |
int |
getHeight() Returns the value of the height attribute. |
java.lang.String |
getMimeType() Returns the mimeType attribute. |
int |
getObjectId() Internal: Applications should not use this method. |
oracle.jbo.domain.DomainOwnerInterface |
getOwner() Internal: Applications should not use this method. |
int |
getOwnerAttributeIndex() Internal: Applications should not use this method. |
java.lang.String |
getRemoteIdString() Internal: Applications should not use this method. |
org.w3c.dom.Node |
getSerializedDomainXML(org.w3c.dom.Document xmlDoc) Creates the XML node in the given XML document for this domain's data. |
long |
getSize() Internal: Applications should not use this 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. |
int |
getTierInfo() Gets the tier number information that this object lives in. |
java.sql.Timestamp |
getUpdateTime() Returns the updateTime attribute. |
int |
getWidth() Returns the value of the width attribute. |
org.w3c.dom.Node |
getXMLContentNode(org.w3c.dom.Document xmlDoc) Internal: Applications should not use this method. |
static oracle.jbo.domain.XMLDomainFactory |
getXMLDomainFactory(java.lang.Class attrClass) Internal: Applications should not use this method. |
int |
hashCode() Returns the hash code as a int |
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 sourceType, java.lang.String sourceLocation, java.lang.String sourceName) Imports data from an external source into the database BLOB specified by the localData attribute. |
boolean |
isAddedToTransaction() Internal: Applications should not use this method. |
boolean |
isConnected() Determines whether the domain object has an internal JDBC connection to the database. |
boolean |
isLocal() Determines whether the content 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 |
loadFromDatabase(oracle.jbo.Transaction xAct) Internal: Applications should not use this method. |
oracle.svcmsg.ResponseValues |
marshal() |
void |
prepareForDML(java.lang.Object context) Internal: Applications should not use this method. |
java.lang.String |
printXMLDefinition(java.util.Hashtable allDefs, java.io.PrintWriter pw, boolean bContainees) Internal: Applications should not use this method. |
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 |
removeListenerFromTransaction() Internal: Applications should not use this method. |
void |
saveToDatabase(oracle.jbo.Transaction xAct) Internal: Applications should not use this method. |
void |
saveToDatabase(oracle.jbo.Transaction xAct, java.lang.Object emptySQLObject) Internal: Applications should not use this method. |
void |
setAddToTransactionState(boolean value) Internal: Applications should not use this method. |
void |
setAttribute(int index, java.lang.Object value) Internal: Applications should not use this method. |
void |
setAttribute(java.lang.String name, java.lang.Object value) Internal: Applications should not use this method. |
void |
setCompressionFormat(java.lang.String CompressionFormat) Sets the value of the compressionFormat attribute. |
void |
setConnected(boolean value) Internal: Applications should not use this method. |
void |
setContentFormat(java.lang.String ContentFormat) Sets the value of the contentFormat attribute. |
void |
setContentLength(int newContentLength) Sets the contentLength attribute. |
void |
setContentSource(OrdContentSource source) Sets the content source for deferred loading. |
void |
setContentSourceOnly(OrdContentSource source) Internal: Applications should not use this method. |
void |
setContext(oracle.jbo.domain.DomainOwnerInterface owner, oracle.jbo.Transaction trans, java.lang.Object ctx) Internal: Applications should not use this method. |
void |
setCTPassivationHandle(java.lang.Object handle) Internal: Applications should not use this method. |
void |
setFormat(java.lang.String format) Sets the value of the fileFormat attribute. |
void |
setHeight(int height) Sets the value of the height attribute. |
void |
setLocal() Sets the attribute called local to indicate that the content 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 OrdImageDomain Java object. |
void |
setProperties(java.lang.String cmd) Writes the characteristics of a foreign image into the appropriate attribute fields. |
void |
setSource(java.lang.String sourceType, java.lang.String sourceLocation, java.lang.String sourceName) Sets the srcType, srcLocation, and srcName attributes. |
void |
setUpdateTime(java.sql.Timestamp currentTime) Sets the updateTime attribute. |
void |
setWidth(int width) Sets the value of the width attribute. |
void |
syncClientLob(oracle.jbo.domain.LobInterface newArrival) Internal: Applications should not use this method. |
void |
syncServerLob(oracle.jbo.domain.LobInterface oldObj) Internal: Applications should not use this method. |
java.lang.String |
toString() Returns a String object describing this object. |
Methods inherited from class oracle.ord.im.OrdImage |
getORADataFactory |
Methods inherited from class oracle.ord.im.OrdImageBase |
create, toDatum, toDatum |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public OrdImageDomain()
OrdImageDomain
instance. Before it has been inserted into the database table and selected back; this new instance doesn't have a JDBC connection to the database. It also doesn't have a corresponding existing database ORDSYS.ORDImage object.public OrdImageDomain(byte[] bytes)
OrdImageDomain
instance. Before it has been inserted into the database table and selected back; this new instance doesn't have a JDBC connection to the database. It also doesn't have a corresponding existing database ORDSYS.ORDImage object. Users should use deferred loading to load the image content into the database.
Calling this constructor has the same effect of calling the following two statements.
OrdImageDomain image = new OrdImageDomain(); image.setContentSource(new OrdByteArraySource(bytes));
bytes
- the byte array that contains the image contentOrdContentSource
, OrdByteArraySource
public OrdImageDomain(java.lang.String fileName)
OrdImageDomain
instance. Before it has been inserted into the database table and selected back; this new instance doesn't have a JDBC connection to the database. It also doesn't have a corresponding existing database ORDSYS.ORDImage object. Users should use deferred loading to load the image content into the database.
Calling this constructor has the same effect of calling the following two statements.
OrdImageDomain image = new OrdImageDomain(); image.setContentSource(new OrdFileSource(fileName));
fileName
- the image file nameOrdContentSource
, OrdFileSource
public OrdImageDomain(OrdContentSource source)
OrdImageDomain
instance. Before it has been inserted into the database table and selected back; this new instance doesn't have a JDBC connection to the database. It also doesn't have a corresponding existing database ORDSYS.ORDImage object. Users should use deferred loading to load the image content into the database.
Calling this constructor has the same effect of calling the following two statements.
OrdImageDomain image = new OrdImageDomain(); image.setContentSource(source);
source
- the image content sourceOrdContentSource
public OrdImageDomain(OrdHttpUploadFile ohuf)
OrdImageDomain
instance. Before it has been inserted into the database table and selected back; this new instance doesn't have a JDBC connection to the database. It also doesn't have a corresponding existing database ORDSYS.ORDImage object. Users should use deferred loading to load the image content into the database.
Calling this constructor has the same effect of calling the following two statements.
OrdImageDomain image = new OrdImageDomain(); image.setContentSource(new OrdHttpUploadFileSource(ohuf));
ohuf
- the image content wrapped as an OrdHttpUploadFile
objectOrdContentSource
, OrdHttpUploadFileSource
Method Detail |
public int getObjectId()
OrdDomainIOInterface
getObjectId
in interface OrdDomainIOInterface
public static oracle.sql.CustomDatumFactory getFactory()
OrdImageDomain CustomDatumFactory
for use by the getCustomDatum
method. Specify this method as the factory parameter of the getCustomDatum
method when retrieving an OrdImageDomain
object from an OracleResultSet
or OracleCallableStatement
. For example:
OrdImageDomain img = (OrdImageDomain)rset. getCustomDatum( 1, OrdImageDomain.getFactory() );
OrdImageDomain
implementation of the CustomDatumFactory
interfacepublic static oracle.sql.CustomDatumFactory getCustomDatumFactory()
public java.lang.String toString()
String
object describing this object. The format of the description is "OrdImageDomain: <mimetype>:<length>".String
object describing this objectpublic int hashCode()
int
public boolean equals(java.lang.Object obj)
OrdImageDomain
objects by their last update time and content length. For performance reasons, bit by bit comparison of binary content is not done.obj
- the object to be compared with this objecttrue
if the two OrdImageDomain
objects have the same last update time and content length; otherwise, returns false
public oracle.sql.BLOB getContent() throws java.sql.SQLException
getContent
in class OrdImage
oracle.sql.BLOB
java.sql.SQLException
- if an error occurs when accessing the localData attributepublic oracle.sql.BFILE getBFILE() throws java.sql.SQLException
getBFILE
in class OrdImage
oracle.sql.BFILE
.java.sql.SQLException
- if an error occurs while executing the corresponding getBFILE method in the databasepublic boolean isLocal() throws java.sql.SQLException
OrdDomainIOInterface
isLocal
in interface OrdDomainIOInterface
isLocal
in class OrdImage
true
if the data is stored locally in the database in a BLOB; false
otherwise.java.sql.SQLException
- if an error occurs accessing the local attribute.public void clearLocal() throws java.sql.SQLException
OrdDomainIOInterface
clearLocal
in interface OrdDomainIOInterface
clearLocal
in class OrdImage
java.sql.SQLException
- if an error occurs accessing the local attribute.public void setLocal() throws java.sql.SQLException
OrdDomainIOInterface
setLocal
in interface OrdDomainIOInterface
setLocal
in class OrdImage
java.sql.SQLException
- if an error occurs accessing the local attribute.public void deleteContent() throws java.sql.SQLException
OrdDomainIOInterface
deleteContent
in interface OrdDomainIOInterface
deleteContent
in class OrdImage
java.sql.SQLException
- if an error occurs executing the corresponding deleteContent method in the database.public void importData(byte[][] ctx) throws java.sql.SQLException
OrdImage
OrdImage.setFormat(java.lang.String)
method to set the value of the fileFormat attribute to a String
beginning with "other" to disable the automatic call to the setProperties method.importData
in class OrdImage
ctx
- the source plug-in context information.java.sql.SQLException
- if an error occurs executing the corresponding import method or the setProperties method in the database.public void importFrom(byte[][] ctx, java.lang.String sourceType, java.lang.String sourceLocation, java.lang.String sourceName) throws java.sql.SQLException
OrdImage
OrdImage.setFormat(java.lang.String)
method to set the value of the fileFormat attribute to "other" to disable the automatic call to the setProperties method.importFrom
in class OrdImage
ctx
- the source plug-in context information. See Oracle interMedia Reference for more information.sourceType
- the source type from which the data will be imported.sourceLocation
- the source location from which the data will be imported.sourceName
- the source name from which the data will be imported.java.sql.SQLException
- if an error occurs executing the corresponding importFrom method or the setProperties method in the database.public boolean loadDataFromFile(java.lang.String filename) throws java.sql.SQLException, java.io.IOException
OrdDomainIOInterface
OrdDomainIOInterface.deleteContent()
, to delete any existing data in the BLOB.OrdDomainIOInterface.setLocal()
, to set the local flag.setUpdateTime()
, to set the updateTime attribute to the database server's current SYSDATE time.loadDataFromFile
in interface OrdDomainIOInterface
loadDataFromFile
in class OrdImage
filename
- the name of the file from which the data will be loaded.true
if the data is loaded successfully; otherwise, an exception is raised if an error occurs. This method never returns false
.java.io.IOException
- if an error occurs reading the data file.java.sql.SQLException
- if an error occurs accessing an object attribute or executing a method in the database.public boolean loadDataFromInputStream(java.io.InputStream inpStream) throws java.sql.SQLException, java.io.IOException
OrdDomainIOInterface
InputStream
into the database BLOB specified by the localData attribute. Before loading the data, this method calls the following methods:
OrdDomainIOInterface.deleteContent()
, to delete any existing data in the BLOB.OrdDomainIOInterface.setLocal()
, to set the local flag.setUpdateTime()
, to set the updateTime attribute to the database server's current SYSDATE time.loadDataFromInputStream
in interface OrdDomainIOInterface
loadDataFromInputStream
in class OrdImage
inpStream
- the name of the InputStream
object from which the data will be loaded.true
if the data is loaded successfully; otherwise, an exception is raised if an error occurs. This method never returns false
.java.io.IOException
- if an error occurs reading the InputStream object.java.sql.SQLException
- if an error occurs accessing an object attribute or executing a method in the database.public boolean loadDataFromByteArray(byte[] byteArr) throws java.sql.SQLException, java.io.IOException
OrdDomainIOInterface
OrdDomainIOInterface.deleteContent()
, to delete any existing data in the BLOB.OrdDomainIOInterface.setLocal()
, to set the local flag.setUpdateTime()
, to set the updateTime attribute to the database server's current SYSDATE time.loadDataFromByteArray
in interface OrdDomainIOInterface
loadDataFromByteArray
in class OrdImage
byteArr
- the name of the local byte[]
array from which the data will be loaded.true
if the data is loaded successfully; otherwise, an exception is raised if an error occurs. This method never returns false
.java.sql.SQLException
- if an error occurs accessing an object attribute or executing a method in the database.java.io.IOException
- if an error occurs reading the byte array.public void process(java.lang.String cmd) throws java.sql.SQLException
OrdImage
See Oracle interMedia Reference for more information on the various image processing operations that can be performed on an image.
process
in class OrdImage
cmd
- a String
that specifies a list of image processing operations to perform on the image.java.sql.SQLException
- if an error occurs executing the corresponding process method in the database.public void setCompressionFormat(java.lang.String CompressionFormat) throws java.sql.SQLException
OrdImage
The OrdImage.setProperties()
method sets the value of this attribute automatically for certain image formats; use this method only if you are not using the setProperties method. This method sets only the attribute value; it does not modify the image data itself.
setCompressionFormat
in class OrdImage
CompressionFormat
- the new attribute value.java.sql.SQLException
- if an error occurs accessing the compressionFormat attribute.public java.lang.String getCompressionFormat() throws java.sql.SQLException
OrdImage
getCompressionFormat
in class OrdImage
String
.java.sql.SQLException
- if an error occurs accessing the compressionFormat attribute.public void setContentFormat(java.lang.String ContentFormat) throws java.sql.SQLException
OrdImage
The OrdImage.setProperties()
method sets the value of this attribute automatically for certain image formats; use this method only if you are not using the setProperties method. This method sets only the attribute value; it does not modify the image data itself.
setContentFormat
in class OrdImage
ContentFormat
- the new attribute value.java.sql.SQLException
- if an error occurs accessing the contentFormat attribute.public java.lang.String getContentFormat() throws java.sql.SQLException
OrdImage
getContentFormat
in class OrdImage
String
.java.sql.SQLException
- if an error occurs accessing the contentFormat attribute.public void setContentLength(int newContentLength) 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.setContentLength
in interface OrdDomainIOInterface
setContentLength
in class OrdImage
newContentLength
- the new attribute value.java.sql.SQLException
- if an error occurs when accessing the contentLength attributepublic int getContentLength() throws java.sql.SQLException
getContentLength
in interface OrdDomainIOInterface
getContentLength
in class OrdImage
int
java.sql.SQLException
- if an error occurs when accessing the contentLength attributepublic java.lang.String getFormat() throws java.sql.SQLException
OrdImage
getFormat
in class OrdImage
String
.java.sql.SQLException
- if an error occurs accessing the fileFormat attribute.public void setFormat(java.lang.String format) throws java.sql.SQLException
OrdImage
The OrdImage.setProperties()
method sets the value of this attribute automatically for certain image formats; use this method only if you are not using the setProperties method. This method sets only the attribute value; it does not modify the image data itself. Set the value of the fileFormat attribute to a String
beginning with "other" to disable the automatic call to the setProperties method by the importData and importFrom methods.
setFormat
in class OrdImage
format
- the new attribute value.java.sql.SQLException
- if an error occurs accessing the fileFormat attribute.public void setMimeType(java.lang.String MimeType) throws java.sql.SQLException
OrdDomainIOInterface
setMimeType
in interface OrdDomainIOInterface
setMimeType
in class OrdImage
MimeType
- the new attribute value.java.sql.SQLException
- if an error occurs accessing the mimeType attribute.public java.lang.String getMimeType() throws java.sql.SQLException
OrdDomainIOInterface
getMimeType
in interface OrdDomainIOInterface
getMimeType
in class OrdImage
String
.java.sql.SQLException
- if an error occurs accessing the mimeType attribute.public void setSource(java.lang.String sourceType, java.lang.String sourceLocation, java.lang.String sourceName) throws java.sql.SQLException
OrdDomainIOInterface
setSource
in interface OrdDomainIOInterface
setSource
in class OrdImage
sourceType
- the type of the source.sourceLocation
- the location of the source.sourceName
- the name of the source.java.sql.SQLException
- if an error occurs accessing the srcType, srcLocation, or srcName attributes.public java.lang.String getSourceType() throws java.sql.SQLException
OrdDomainIOInterface
getSourceType
in interface OrdDomainIOInterface
getSourceType
in class OrdImage
String
.java.sql.SQLException
- if an error occurs accessing the srcType attribute.public java.lang.String getSourceLocation() throws java.sql.SQLException
OrdDomainIOInterface
getSourceLocation
in interface OrdDomainIOInterface
getSourceLocation
in class OrdImage
String
.java.sql.SQLException
- if an error occurs accessing the srcLocation attribute.public java.lang.String getSourceName() throws java.sql.SQLException
OrdDomainIOInterface
getSourceName
in interface OrdDomainIOInterface
getSourceName
in class OrdImage
String
.java.sql.SQLException
- if an error occurs accessing the srcName attribute.public java.lang.String getSource() throws java.sql.SQLException
OrdImage
srcType://srcLocation/srcName
.getSource
in class OrdImage
String
.java.sql.SQLException
- if an error occurs executing the corresponding getSource method in the database.public boolean checkProperties() throws java.sql.SQLException
OrdImage
checkProperties
in class OrdImage
true
if the properties of the image data are consistent with the attributes of the OrdImage Java object; false
otherwise.java.sql.SQLException
- if an error occurs executing the corresponding checkProperties method in the database.public void setProperties() throws java.sql.SQLException
OrdImageDomain
Java object. This method sets the height , width, contentLength, fileFormat, contentFormat, compressionFormat, and mimeType attributes. An attribute is set to null if the corresponding property cannot be extracted for a specific image format. This method throws a SQLException
if the image format is not recognized.setProperties
in interface OrdDomainIOInterface
setProperties
in class OrdImage
java.sql.SQLException
- if an error occurs while executing the corresponding setProperties method in the databasepublic void setProperties(java.lang.String cmd) throws java.sql.SQLException
OrdImage
setProperties
in class OrdImage
cmd
- a String
that specifies the image characteristics to set for the foreign image.java.sql.SQLException
- if an error occurs executing the corresponding setProperties method in the database.public void setUpdateTime(java.sql.Timestamp currentTime) throws java.sql.SQLException
OrdDomainIOInterface
setUpdateTime
in interface OrdDomainIOInterface
setUpdateTime
in class OrdImage
currentTime
- the update time or the null value, used to set the value of the updateTime attribute to the current SYSDATE time.java.sql.SQLException
- if an error occurs executing the corresponding setUpdateTime method in the database.public java.sql.Timestamp getUpdateTime() throws java.sql.SQLException
OrdDomainIOInterface
getUpdateTime
in interface OrdDomainIOInterface
getUpdateTime
in class OrdImage
java.sql.Timestamp
object.java.sql.SQLException
- if an error occurs accessing the updateTime attribute.public int getWidth() throws java.sql.SQLException
OrdImage
getWidth
in class OrdImage
int
).java.sql.SQLException
- if an error occurs accessing the width attribute.public void setWidth(int width) throws java.sql.SQLException
OrdImage
The OrdImage.setProperties()
method sets the value of this attribute automatically for certain image formats; use this method only if you are not using the setProperties method. This method sets only the attribute value; it does not modify the image data itself.
setWidth
in class OrdImage
width
- the new attribute value.java.sql.SQLException
- if an error occurs accessing the width attribute.public int getHeight() throws java.sql.SQLException
OrdImage
getHeight
in class OrdImage
int
).java.sql.SQLException
- if an error occurs accessing the height attribute.public void setHeight(int height) throws java.sql.SQLException
OrdImage
The OrdImage.setProperties()
method sets the value of this attribute automatically for certain image formats; use this method only if you are not using the setProperties method. This method sets only the attribute value; it does not modify the image data itself.
setHeight
in class OrdImage
height
- the new attribute value.java.sql.SQLException
- if an error occurs accessing the height attribute.public void export(byte[][] ctx, java.lang.String sourceType, java.lang.String sourceLocation, java.lang.String sourceName) throws java.sql.SQLException
OrdImage
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.
This method will work only if you are running Oracle release 8.1.7 or later.
The remainder of this description describes the use of the export method and the Oracle-supplied "file" source plug-in. User-written plug-ins will behave differently.
The export method implemented by the Oracle-supplied "file" source plug-in copies, but does not modify, the image data stored in the database BLOB specified by the localData attribute.
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 OrdImage.clearLocal()
method to indicate the image data is stored outside the database and call the OrdImage.deleteContent()
method to delete the image data stored in the database BLOB.
See Oracle interMedia Reference for information about the privileges required to write to a database directory object. See Oracle Database Java Developer's Guide and the java.io.FilePermission class in the Java API for information about security and performance.
export
in class OrdImage
ctx
- the source plug-in context information.sourceType
- the source type to which the content will be exported.sourceLocation
- the source location to which the content will be exported.sourceName
- the source name to which the content will be exported.java.sql.SQLException
- if an error occurs executing the corresponding export method in the database.public void copy(OrdImage dest) throws java.sql.SQLException
OrdImage
copy
in class OrdImage
dest
- the destination OrdImage
object to which the data will be copied.java.sql.SQLException
- if an error occurs calling the corresponding copy method in the database.public void processCopy(java.lang.String cmd, OrdImage dest) throws java.sql.SQLException
OrdImage
processCopy
in class OrdImage
cmd
- a String
that specifies a list of image processing operations to perform on the image.dest
- the destination OrdImage
object.java.sql.SQLException
- if an error occurs calling the corresponding processCopy method in the database.public boolean getDataInFile(java.lang.String filename) throws java.sql.SQLException, java.io.IOException
OrdDomainIOInterface
getDataInFile
in interface OrdDomainIOInterface
getDataInFile
in class OrdImage
filename
- the name of the file to which the data will 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
.java.io.IOException
- if an error occurs reading the data from the BLOB or writing the data to the output file.java.sql.SQLException
- if an error occurs accessing an object attribute.public java.io.InputStream getDataInStream() throws java.sql.SQLException
OrdDomainIOInterface
getDataInStream
in interface OrdDomainIOInterface
getDataInStream
in class OrdImage
InputStream
object from which the data will be read.java.sql.SQLException
- if an error occurs accessing an object attribute.public byte[] getDataInByteArray() throws java.sql.SQLException, java.io.IOException, java.lang.OutOfMemoryError
OrdDomainIOInterface
getDataInByteArray
in interface OrdDomainIOInterface
getDataInByteArray
in class OrdImage
byte[]
array containing the data.java.lang.OutOfMemoryError
- if sufficient memory cannot be allocated to hold the data.java.io.IOException
- if an error occurs reading the data from the BLOB.java.sql.SQLException
- if an error occurs accessing an object attribute.public oracle.jbo.domain.BlobDomain getContentAsBlobDomain() throws java.sql.SQLException
OrdDomainIOInterface
BlobDomain
object which wraps the BLOB locator from the localData attribute.getContentAsBlobDomain
in interface OrdDomainIOInterface
BlobDomain
objectjava.sql.SQLException
- if an error occurs in calling getContent
method.OrdImage.getContent()
, OrdAudio.getContent()
, OrdVideo.getContent()
, OrdDoc.getContent()
public oracle.jbo.domain.BFileDomain getBFileDomain() throws java.sql.SQLException
OrdDomainIOInterface
BFileDomain
object which wraps the BFILE locator obtained from the getBFILE
method.getBFileDomain
in interface OrdDomainIOInterface
BFileDomain
objectjava.sql.SQLException
- if an error occurs in calling getBFILE
method.OrdImage.getBFILE()
, OrdAudio.getBFILE()
, OrdVideo.getBFILE()
, OrdDoc.getBFILE()
public void setContentSource(OrdContentSource source)
OrdDomainIOInterface
OrdHttpUploadFile
object. The loading of content from the client into the database doesn't happen inside this method. It's deferred to the next postChanges
method call.
If the source parameter is null
, this method just resets the previously set content source.
In 3Tier environment, this method registers the domain object in the client post listener list so the content won't be replicated from CT to MT. The content will be streamed to the database directly after the postChanges
.
setContentSource
in interface OrdDomainIOInterface
source
- the content source for the deferred loadingOrdContentSource
public OrdContentSource getContentSource()
OrdDomainIOInterface
setContentSource
method.getContentSource
in interface OrdDomainIOInterface
public oracle.sql.CustomDatum create(oracle.sql.Datum d, int sqlType) throws java.sql.SQLException
OrdImage
create
in interface oracle.sql.CustomDatumFactory
create
in class OrdImage
java.sql.SQLException
public static oracle.jbo.domain.XMLDomainFactory getXMLDomainFactory(java.lang.Class attrClass)
public org.w3c.dom.Node getXMLContentNode(org.w3c.dom.Document xmlDoc)
getXMLContentNode
in interface oracle.jbo.domain.XMLDomainInterface
public java.lang.Object createDomainFromSerializedXML(org.w3c.dom.Element element)
createDomainFromSerializedXML
in interface oracle.jbo.domain.XMLDomainReaderFactory
public org.w3c.dom.Node getSerializedDomainXML(org.w3c.dom.Document xmlDoc)
getSerializedDomainXML
in interface oracle.jbo.domain.XMLDomainWriter
xmlDoc
- name of the XML document in which the node should be created.public java.lang.String printXMLDefinition(java.util.Hashtable allDefs, java.io.PrintWriter pw, boolean bContainees)
printXMLDefinition
in interface oracle.jbo.domain.XMLDomainInterface
public void domainToBeModified(oracle.jbo.domain.DomainInterface d)
domainToBeModified
in interface oracle.jbo.domain.DomainOwnerInterface
public java.lang.Object getAttribute(int index)
getAttribute
in interface oracle.jbo.AttributeList
public java.lang.Object getAttribute(java.lang.String name)
getAttribute
in interface oracle.jbo.AttributeList
public void setAttribute(int index, java.lang.Object value)
setAttribute
in interface oracle.jbo.AttributeList
public void setAttribute(java.lang.String name, java.lang.Object value)
setAttribute
in interface oracle.jbo.AttributeList
public int getAttributeCount()
getAttributeCount
in interface oracle.jbo.AttributeList
public int getAttributeIndexOf(java.lang.String name)
getAttributeIndexOf
in interface oracle.jbo.AttributeList
public java.lang.String[] getAttributeNames()
getAttributeNames
in interface oracle.jbo.AttributeList
public java.lang.Object[] getAttributeValues()
getAttributeValues
in interface oracle.jbo.AttributeList
public void syncServerLob(oracle.jbo.domain.LobInterface oldObj)
syncServerLob
in interface oracle.jbo.domain.LobInterface
public void syncClientLob(oracle.jbo.domain.LobInterface newArrival)
syncClientLob
in interface oracle.jbo.domain.LobInterface
public long getSize()
getSize
in interface oracle.jbo.domain.LobInterface
public java.lang.String getRemoteIdString()
getRemoteIdString
in interface oracle.jbo.domain.LobInterface
public void saveToDatabase(oracle.jbo.Transaction xAct) throws java.sql.SQLException
saveToDatabase
in interface oracle.jbo.domain.BlobDomainInterface
java.sql.SQLException
public void saveToDatabase(oracle.jbo.Transaction xAct, java.lang.Object emptySQLObject) throws java.sql.SQLException, java.io.IOException
saveToDatabase
in interface oracle.jbo.domain.BlobDomainInterface
java.sql.SQLException
java.io.IOException
public void prepareForDML(java.lang.Object context)
prepareForDML
in interface oracle.jbo.domain.BlobDomainInterface
public void loadFromDatabase(oracle.jbo.Transaction xAct) throws java.lang.Exception
loadFromDatabase
in interface oracle.jbo.domain.BlobDomainInterface
java.lang.Exception
public oracle.jbo.domain.DomainOwnerInterface getOwner()
getOwner
in interface oracle.jbo.domain.LobInterface
public int getOwnerAttributeIndex()
getOwnerAttributeIndex
in interface oracle.jbo.domain.LobInterface
public java.lang.Object getData()
getData
in interface oracle.jbo.domain.DomainInterface
public void setContext(oracle.jbo.domain.DomainOwnerInterface owner, oracle.jbo.Transaction trans, java.lang.Object ctx)
setContext
in interface oracle.jbo.domain.DomainInterface
public oracle.svcmsg.ResponseValues marshal()
marshal
in interface oracle.jbo.domain.MarshalledDomain
public boolean isConnected()
OrdDomainState
isConnected
in interface OrdDomainState
true
if the there exists an internal JDBC connection; otherwise, returns false
public int getTierInfo()
OrdDomainState
The returned value indicates the tier information.
getTierInfo
in interface OrdDomainState
public void setConnected(boolean value)
setConnected
in interface OrdDomainState
public void removeListenerFromTransaction()
OrdDomainState
removeListenerFromTransaction
in interface OrdDomainState
public boolean isAddedToTransaction()
isAddedToTransaction
in interface OrdDomainState
public void setAddToTransactionState(boolean value)
setAddToTransactionState
in interface OrdDomainState
public void doneCommit(oracle.jbo.TransactionStateEvent event)
doneCommit
in interface oracle.jbo.TransactionStateListener
public void doneRollback(oracle.jbo.TransactionStateEvent event)
doneRollback
in interface oracle.jbo.TransactionStateListener
public void setContentSourceOnly(OrdContentSource source)
setContentSourceOnly
in interface OrdDomainIOInterface
public void setCTPassivationHandle(java.lang.Object handle)
setCTPassivationHandle
in interface OrdDomainSupportInterface
public java.lang.Object getCTPassivationHandle()
getCTPassivationHandle
in interface OrdDomainSupportInterface
public void generateTempFilePath()
generateTempFilePath
in interface OrdDomainSupportInterface
public void clearContentSource()
OrdDomainIOInterface
clearContentSource
in interface OrdDomainIOInterface
|
Oracle ADF Business Components interMedia Domains API Reference Oracle JDeveloper 10g (10.1.2) B10394-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |