|
Oracle Fusion Middleware interMedia Domains Java API Reference for Oracle ADF Business Components 11g Release 1 (11.1.1.4.0) E10656-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ord.im.OrdAudioBase oracle.ord.im.OrdAudio oracle.ord.im.OrdAudioDomain
public class OrdAudioDomain
Represents interMedia ORDSYS.ORDAudio database type as a domain class in the Business Components 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
- getComments
- setComments
- getAllAttributes
- getContentInLob
- getContentAsBlobDomain
- getBFileDomain
- getCommentsAsClobDomain
setComments
, getAllAttributes
and
getContentInLob
.
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
OrdAudioDomain
. 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.
OrdAudio
,
Serialized FormField Summary |
---|
Fields inherited from class oracle.ord.im.OrdAudio |
---|
_OrdAudioCustomDatumFactory |
Fields inherited from class oracle.ord.im.OrdAudioBase |
---|
__dataSource, __onn, _factory, _OrdAudioBaseCustomDatumFactory, _OrdAudioBaseFactory, _SQL_NAME, _SQL_TYPECODE, _sqlType, _struct |
Constructor Summary | |
---|---|
OrdAudioDomain()
Constructs a new OrdAudioDomain instance. |
|
OrdAudioDomain(byte[] bytes)
Constructs a new OrdAudioDomain instance. |
|
OrdAudioDomain(OrdContentSource source)
Constructs a new OrdAudioDomain instance. |
|
OrdAudioDomain(oracle.ord.im.OrdHttpUploadFile ohuf)
Constructs a new OrdAudioDomain instance. |
|
OrdAudioDomain(java.lang.String fileName)
Constructs a new OrdAudioDomain instance. |
Method Summary | |
---|---|
boolean |
checkProperties(byte[][] ctx)
|
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. |
int |
closeSource(byte[][] ctx)
|
oracle.sql.ORAData |
create(oracle.sql.Datum d,
int sqlType)
Internal: Applications should not use this method. |
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 OrdAudioDomain 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)
|
void |
generateTempFilePath()
Internal: Applications should not use this method. |
oracle.sql.CLOB |
getAllAttributes(byte[][] ctx)
Returns the audio properties in a temporary Clob in a form defined by the format plug-in. |
java.lang.String |
getAttribute(byte[][] ctx,
java.lang.String name)
|
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()
|
int |
getAudioDuration()
|
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.sql.Blob |
getBlobContent()
Returns the Blob locator from the localData attribute. |
java.sql.Clob |
getClobComments()
Returns the Clob locator from the comments attribute. |
oracle.sql.CLOB |
getComments()
Deprecated. Use getClobComments method. Returns the CLOB locator from the comments attribute.
|
oracle.jbo.domain.ClobDomain |
getCommentsAsClobDomain()
Returns a ClobDomain object which wraps the
Clob locator obtained from the getComments() method. |
java.lang.String |
getCompressionType()
|
oracle.sql.BLOB |
getContent()
Deprecated. Use getBlobContent method. 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. |
oracle.sql.BLOB |
getContentInLob(byte[][] ctx,
java.lang.String[] mimetype,
java.lang.String[] format)
Returns the data from the Blob specified by the localData attribute in a temporary Blob in the database. |
int |
getContentLength()
Returns the length of the audio data. |
int |
getContentLength(byte[][] ctx)
Returns the length of the audio data using source plug-in context information. |
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. |
java.lang.String |
getDescription()
|
java.lang.String |
getEncoding()
|
static oracle.sql.CustomDatumFactory |
getFactory()
Deprecated. |
java.lang.String |
getFormat()
|
java.lang.String |
getMimeType()
Returns the mimeType attribute. |
int |
getNumberOfChannels()
|
int |
getObjectId()
Internal: Applications should not use this method. |
static oracle.sql.ORADataFactory |
getORADataFactory()
Returns the OrdAudioDomain ORADataFactory for use by the
getORAData 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. |
int |
getSampleSize()
|
int |
getSamplingRate()
|
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()
|
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. |
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. |
protected java.lang.String |
getXMLElementTag()
|
int |
hashCode()
Returns the hash code as a int |
void |
importData(byte[][] ctx)
|
void |
importFrom(byte[][] ctx,
java.lang.String sourceType,
java.lang.String sourceLocation,
java.lang.String sourceName)
|
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()
|
int |
openSource(byte[] userarg,
byte[][] ctx)
Opens a data source. |
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. |
byte[] |
processAudioCommand(byte[][] ctx,
java.lang.String cmd,
java.lang.String args,
byte[][] result)
|
byte[] |
processSourceCommand(byte[][] ctx,
java.lang.String cmd,
java.lang.String args,
byte[][] result)
|
int |
readFromSource(byte[][] ctx,
int startpos,
int numbytes,
byte[][] buffer)
|
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 |
setAudioDuration(int audioDuration)
|
void |
setClobComments(java.sql.Clob comments)
Sets the comments attribute. |
void |
setComments(oracle.sql.CLOB comments)
Deprecated. Use setClobComments method. Sets the comments attribute.
setProperties method.
|
void |
setCompressionType(java.lang.String compressionType)
|
void |
setConnected(boolean value)
Internal: Applications should not use this method. |
void |
setContentLength(int contentLength)
Does nothing for OrdAudioDomain objects. |
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 |
setDescription(java.lang.String description)
|
void |
setEncoding(java.lang.String encoding)
|
void |
setFormat(java.lang.String format)
|
void |
setKnownAttributes(java.lang.String knownformat,
java.lang.String knownencoding,
int knownnumberofchannels,
int knownsamplingrate,
int knownsamplesize,
java.lang.String knowncompressiontype,
int knownaudioduration)
|
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 |
setNumberOfChannels(int numberOfChannels)
|
void |
setProperties()
Parses the audio data properties and sets the attributes in the OrdAudioDomain Java object. |
void |
setProperties(byte[][] ctx)
|
void |
setProperties(byte[][] ctx,
boolean setComments)
|
void |
setSampleSize(int sampleSize)
|
void |
setSamplingRate(int samplingRate)
|
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 |
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. |
int |
trimSource(byte[][] ctx,
int newLen)
|
int |
writeToSource(byte[][] ctx,
int startpos,
int numbytes,
byte[] buffer)
|
Methods inherited from class oracle.ord.im.OrdAudio |
---|
isConnectionNull |
Methods inherited from class oracle.ord.im.OrdAudioBase |
---|
_init_struct, create, setContextFrom, setValueFrom, toDatum, toDatum |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public OrdAudioDomain()
OrdAudioDomain
instance. Before it's
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.ORDAudio object.
public OrdAudioDomain(byte[] bytes)
OrdAudioDomain
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.ORDAudio object.
Users should use deferred loading to load the audio content into
the database.
Calling this constructor has the same effect of calling the following two statements.
OrdAudioDomain audio = new OrdAudioDomain(); audio.setContentSource(new OrdByteArraySource(bytes));
bytes
- the byte array that contains the audio contentOrdContentSource
,
OrdByteArraySource
public OrdAudioDomain(java.lang.String fileName)
OrdAudioDomain
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.ORDAudio object.
Users should use deferred loading to load the audio content into
the database.
Calling this constructor has the same effect of calling the following two statements.
OrdAudioDomain audio = new OrdAudioDomain(); audio.setContentSource(new OrdFileSource(fileName));
fileName
- the audio file nameOrdContentSource
,
OrdFileSource
public OrdAudioDomain(OrdContentSource source)
OrdAudioDomain
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.ORDAudio object.
Users should use deferred loading to load the audio content into
the database.
Calling this constructor has the same effect of calling the following two statements.
OrdAudioDomain audio = new OrdAudioDomain(); audio.setContentSource(source);
source
- the audio content sourceOrdContentSource
public OrdAudioDomain(oracle.ord.im.OrdHttpUploadFile ohuf)
OrdAudioDomain
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.ORDAudio object.
Users should use deferred loading to load the audio content into
the database.
Calling this constructor has the same effect of calling the following two statements.
OrdAudioDomain audio = new OrdAudioDomain(); audio.setContentSource(new OrdHttpUploadFileSource(ohuf));
ohuf
- the audio content wrapped as an OrdHttpUploadFile
objectOrdContentSource
,
OrdHttpUploadFileSource
Method Detail |
---|
public int getObjectId()
OrdDomainIOInterface
getObjectId
in interface OrdDomainIOInterface
public static oracle.sql.ORADataFactory getORADataFactory()
OrdAudioDomain ORADataFactory
for use by the
getORAData
method. Specify this method as the factory
parameter of the getORAData
method when retrieving an
OrdAudioDomain
object from an OracleResultSet
or OracleCallableStatement
. For example:
OrdAudioDomain audio = (OrdAudioDomain)rset. getORAData( 1, OrdAudioDomain.getORADataFactory() );
OrdAudioDomain
implementation of the
ORADataFactory
interfacepublic static oracle.sql.CustomDatumFactory getFactory()
OrdAudioDomain CustomDatumFactory
for use by the
getCustomDatum
method. Specify this method as the factory
parameter of the getCustomDatum
method when retrieving an
OrdAudioDomain
object from an OracleResultSet
or OracleCallableStatement
. For example:
OrdAudioDomain audio = (OrdAudioDomain)rset. getCustomDatum( 1, OrdAudioDomain.getFactory() );
OrdAudioDomain
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 "OrdAudioDomain:
<mimetype>:<length>".
toString
in class java.lang.Object
String
object describing this objectpublic int hashCode()
int
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
OrdAudioDomain
objects by their last update time
and content length. For performance reasons, bit by bit comparison
of binary content is not done.
equals
in class java.lang.Object
obj
- the object to be compared with this object
true
if the two OrdAudioDomain
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 oracle.ord.im.OrdAudio
oracle.sql.BLOB
java.sql.SQLException
- if an error occurs when accessing the localData attributepublic java.sql.Blob getBlobContent() throws java.sql.SQLException
getBlobContent
in class oracle.ord.im.OrdAudio
java.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 oracle.ord.im.OrdAudio
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 oracle.ord.im.OrdAudio
true
if the data is stored locally in the database
in a BLOB; otherwise, returns false
java.sql.SQLException
- if an error occurs when accessing the
attribute called local.public void clearLocal() throws java.sql.SQLException
OrdDomainIOInterface
clearLocal
in interface OrdDomainIOInterface
clearLocal
in class oracle.ord.im.OrdAudio
java.sql.SQLException
- if an error occurs when accessing the
attribute called local.public void setLocal() throws java.sql.SQLException
OrdDomainIOInterface
setLocal
in interface OrdDomainIOInterface
setLocal
in class oracle.ord.im.OrdAudio
java.sql.SQLException
- if an error occurs when accessing the
attribute called local.public void deleteContent() throws java.sql.SQLException
OrdDomainIOInterface
deleteContent
in interface OrdDomainIOInterface
deleteContent
in class oracle.ord.im.OrdAudio
java.sql.SQLException
- if an error occurs when executing the corresponding
deleteContent method in the database.public void importData(byte[][] ctx) throws java.sql.SQLException
importData
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void importFrom(byte[][] ctx, java.lang.String sourceType, java.lang.String sourceLocation, java.lang.String sourceName) throws java.sql.SQLException
importFrom
in class oracle.ord.im.OrdAudio
java.sql.SQLException
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 oracle.ord.im.OrdAudio
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
.
java.sql.SQLException
- if an error occurs when accessing an object
attribute or when executing a
method in the database.
java.io.IOException
- if an error occurs when reading the data file.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 oracle.ord.im.OrdAudio
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
.
java.sql.SQLException
- if an error occurs when accessing an object
attribute or when executing a
method in the database.
java.io.IOException
- if an error occurs when reading the InputStream.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 oracle.ord.im.OrdAudio
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 when accessing an object
attribute or when executing
a method in the database.
java.io.IOException
- if an error occurs reading the byte array.public int getContentLength() throws java.sql.SQLException
getContentLength
in interface OrdDomainIOInterface
getContentLength
in class oracle.ord.im.OrdAudio
int
java.sql.SQLException
- if an error occurs while executing the corresponding
getContentLength method in the databaseOrdImage.getContentLength()
,
OrdDoc.getContentLength()
,
OrdAudio.getContentLength()
,
OrdVideo.getContentLength()
public int getContentLength(byte[][] ctx) throws java.sql.SQLException
getContentLength
in class oracle.ord.im.OrdAudio
ctx
- the source plug-in context information
int
java.sql.SQLException
- if an error occurs while executing the corresponding
getContentLength method in the databasepublic void setMimeType(java.lang.String MimeType) throws java.sql.SQLException
OrdDomainIOInterface
setMimeType
in interface OrdDomainIOInterface
setMimeType
in class oracle.ord.im.OrdAudio
java.sql.SQLException
- if an error occurs when accessing the mimeType
attribute.public java.lang.String getMimeType() throws java.sql.SQLException
OrdDomainIOInterface
getMimeType
in interface OrdDomainIOInterface
getMimeType
in class oracle.ord.im.OrdAudio
String
.
java.sql.SQLException
- if an error occurs when 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 oracle.ord.im.OrdAudio
sourceType
- the source type, for example, "FILE", "HTTP".sourceLocation
- the source location, for example, MEDIA_DIR,
www.xyzcoimages.com/public.sourceName
- the source name, for example, media_content.dat
java.sql.SQLException
- if an error occurs when accessing the srcType,
srcLocation, or srcName attributes.public java.lang.String getSourceType() throws java.sql.SQLException
OrdDomainIOInterface
getSourceType
in interface OrdDomainIOInterface
getSourceType
in class oracle.ord.im.OrdAudio
String
.
java.sql.SQLException
- if an error occurs when accessing the
srcType attribute.public java.lang.String getSourceLocation() throws java.sql.SQLException
OrdDomainIOInterface
getSourceLocation
in interface OrdDomainIOInterface
getSourceLocation
in class oracle.ord.im.OrdAudio
String
.
java.sql.SQLException
- if an error occurs when accessing the
srcLocation attribute.public java.lang.String getSourceName() throws java.sql.SQLException
OrdDomainIOInterface
getSourceName
in interface OrdDomainIOInterface
getSourceName
in class oracle.ord.im.OrdAudio
String
.
java.sql.SQLException
- if an error occurs when accessing the srcName
attribute.public java.lang.String getSource() throws java.sql.SQLException
getSource
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public java.lang.String getDescription() throws java.sql.SQLException
getDescription
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setDescription(java.lang.String description) throws java.sql.SQLException
setDescription
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public oracle.sql.CLOB getComments() throws java.sql.SQLException
getComments
in class oracle.ord.im.OrdAudio
oracle.sql.CLOB
java.sql.SQLException
- if an error occurs when accessing the comments
attributepublic java.sql.Clob getClobComments() throws java.sql.SQLException
getClobComments
in class oracle.ord.im.OrdAudio
java.sql.Clob
java.sql.SQLException
- if an error occurs when accessing the comments
attributepublic void setComments(oracle.sql.CLOB comments) throws java.sql.SQLException
setProperties
method.
setComments
in class oracle.ord.im.OrdAudio
comments
- the new attribute value
java.sql.SQLException
- if an error occurs when accessing the comments
attributepublic void setClobComments(java.sql.Clob comments) throws java.sql.SQLException
setProperties
method.
setClobComments
in class oracle.ord.im.OrdAudio
comments
- the new attribute value
java.sql.SQLException
- if an error occurs when accessing the comments
attributepublic java.lang.String getEncoding() throws java.sql.SQLException
getEncoding
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setEncoding(java.lang.String encoding) throws java.sql.SQLException
setEncoding
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public int getNumberOfChannels() throws java.sql.SQLException
getNumberOfChannels
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setNumberOfChannels(int numberOfChannels) throws java.sql.SQLException
setNumberOfChannels
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public int getSamplingRate() throws java.sql.SQLException
getSamplingRate
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setSamplingRate(int samplingRate) throws java.sql.SQLException
setSamplingRate
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public int getSampleSize() throws java.sql.SQLException
getSampleSize
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setSampleSize(int sampleSize) throws java.sql.SQLException
setSampleSize
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public java.lang.String getCompressionType() throws java.sql.SQLException
getCompressionType
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setCompressionType(java.lang.String compressionType) throws java.sql.SQLException
setCompressionType
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public int getAudioDuration() throws java.sql.SQLException
getAudioDuration
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setAudioDuration(int audioDuration) throws java.sql.SQLException
setAudioDuration
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public java.lang.String getFormat() throws java.sql.SQLException
getFormat
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setFormat(java.lang.String format) throws java.sql.SQLException
setFormat
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public boolean checkProperties(byte[][] ctx) throws java.sql.SQLException
checkProperties
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setProperties() throws java.sql.SQLException
OrdAudioDomain
Java object. This method sets the
format, mimeType, encoding,
numberOfChannels, samplingRate, sampleSize, compressionType, and
audioDuration attributes. An attribute is set to null if the
corresponding property cannot be extracted for a specific audio format.
This method throws a SQLException
if the audio format is
not recognized.
setProperties(byte[][])
or
setProperties(byte[][], boolean)
instead of this method.
Otherwise, this method may fail.
setProperties
in interface OrdDomainIOInterface
java.sql.SQLException
- if an error occurs while executing the corresponding
setProperties method in the databaseOrdImageDomain.setProperties()
,
setProperties()
,
OrdVideoDomain.setProperties()
,
OrdDocDomain.setProperties()
public void setProperties(byte[][] ctx) throws java.sql.SQLException
setProperties
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setProperties(byte[][] ctx, boolean setComments) throws java.sql.SQLException
setProperties
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setContentLength(int contentLength) throws java.sql.SQLException
OrdAudioDomain
objects. This method exists
only for the OrdDomainIOInterface
.
setContentLength
in interface OrdDomainIOInterface
java.sql.SQLException
- if an error occurs when accessing the
contentLength attribute.OrdImage.setContentLength(int)
,
OrdDoc.setContentLength(int)
public int trimSource(byte[][] ctx, int newLen) throws java.sql.SQLException
trimSource
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public int openSource(byte[] userarg, byte[][] ctx) throws java.sql.SQLException
This method throws Exception
instead of
SQLException
in Oracle 817 version OrdAudioDomain
class.
openSource
in class oracle.ord.im.OrdAudio
userarg
- additional source plug-in information that may be required
by user-defined source plug-ins.ctx
- the source plug-in context information.
int
, where 0 indicates success and
a non-0 value indicates a failure code specific to the source
plug-in.
java.sql.SQLException
- if an error occurs executing the corresponding
openSource method in the database.public int closeSource(byte[][] ctx) throws java.sql.SQLException
closeSource
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public byte[] processSourceCommand(byte[][] ctx, java.lang.String cmd, java.lang.String args, byte[][] result) throws java.sql.SQLException
processSourceCommand
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public byte[] processAudioCommand(byte[][] ctx, java.lang.String cmd, java.lang.String args, byte[][] result) throws java.sql.SQLException
processAudioCommand
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void setUpdateTime(java.sql.Timestamp currentTime) throws java.sql.SQLException
OrdDomainIOInterface
setUpdateTime
in interface OrdDomainIOInterface
setUpdateTime
in class oracle.ord.im.OrdAudio
currentTime
- the update time in a java.sql.Timestamp
,
or null
to set the update time to the
database server's current SYSDATE time.
java.sql.SQLException
- if an error occurs when 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 oracle.ord.im.OrdAudio
java.sql.Timestamp
.
java.sql.SQLException
- if an error occurs when accessing the
updateTime attribute.public java.lang.String getAttribute(byte[][] ctx, java.lang.String name) throws java.sql.SQLException
getAttribute
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public oracle.sql.CLOB getAllAttributes(byte[][] ctx) throws java.sql.SQLException
attributeName=attributeValue
, where the list contains the
following attributes: format, mimeType, encoding, numberOfChannels,
samplingRate, sampleSize, compressionType, and audioDuration. For
user-defined formats, the information is presented in a form defined
by the format plug-in.
getAllAttributes
in class oracle.ord.im.OrdAudio
ctx
- the format plug-in context information
java.sql.Clob
java.sql.SQLException
- if an error occurs while executing the corresponding
getAllAttributes method in the databasepublic oracle.sql.BLOB getContentInLob(byte[][] ctx, java.lang.String[] mimetype, java.lang.String[] format) throws java.sql.SQLException
getContentInLob
in class oracle.ord.im.OrdAudio
ctx
- the format plug-in context informationmimetype
- a String[]
array, 1 element in length, into
which the mimeType attribute is written as element 0format
- a String[]
array, 1 element in length, into
which the format attribute is written as element 0
java.sql.Blob
java.sql.SQLException
- if an error occurs while creating the temporary Blob or
while executing the corresponding getContentInLob method
in the databasepublic void setKnownAttributes(java.lang.String knownformat, java.lang.String knownencoding, int knownnumberofchannels, int knownsamplingrate, int knownsamplesize, java.lang.String knowncompressiontype, int knownaudioduration) throws java.sql.SQLException
setKnownAttributes
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public int readFromSource(byte[][] ctx, int startpos, int numbytes, byte[][] buffer) throws java.sql.SQLException
readFromSource
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public int writeToSource(byte[][] ctx, int startpos, int numbytes, byte[] buffer) throws java.sql.SQLException
writeToSource
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public void export(byte[][] ctx, java.lang.String sourceType, java.lang.String sourceLocation, java.lang.String sourceName) throws java.sql.SQLException
export
in class oracle.ord.im.OrdAudio
java.sql.SQLException
public boolean getDataInFile(java.lang.String filename) throws java.sql.SQLException, java.io.IOException
OrdDomainIOInterface
getDataInFile
in interface OrdDomainIOInterface
getDataInFile
in class oracle.ord.im.OrdAudio
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
.
java.sql.SQLException
- if an error occurs when accessing an object attribute.
java.io.IOException
- if an error occurs when reading the data from the BLOB
or when writing the data to the output file.public java.io.InputStream getDataInStream() throws java.sql.SQLException
OrdDomainIOInterface
getDataInStream
in interface OrdDomainIOInterface
getDataInStream
in class oracle.ord.im.OrdAudio
InputStream
from which the data can be read.
java.sql.SQLException
- if an error occurs when 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 oracle.ord.im.OrdAudio
byte[]
array containing the data.
java.sql.SQLException
- if an error occurs when accessing an object attribute.
java.io.IOException
- if an error occurs when reading the data from the BLOB.
java.lang.OutOfMemoryError
- if sufficient memory cannot be allocated to
hold the data.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
object
java.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
object
java.sql.SQLException
- if an error occurs in calling
getBFILE
method.OrdImage.getBFILE()
,
OrdAudio.getBFILE()
,
OrdVideo.getBFILE()
,
OrdDoc.getBFILE()
public oracle.jbo.domain.ClobDomain getCommentsAsClobDomain() throws java.sql.SQLException
ClobDomain
object which wraps the
Clob locator obtained from the getComments()
method.
ClobDomain
object
java.sql.SQLException
- if an error occurs while calling the
getComments
methodpublic 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.ORAData create(oracle.sql.Datum d, int sqlType) throws java.sql.SQLException
create
in interface oracle.sql.ORADataFactory
create
in class oracle.ord.im.OrdAudioBase
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.protected java.lang.String getXMLElementTag()
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)
OrdDomainIOInterface
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 Fusion Middleware interMedia Domains Java API Reference for Oracle ADF Business Components 11g Release 1 (11.1.1.4.0) E10656-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |