Business Components

oracle.jbo.domain
Class Array

java.lang.Object
  |
  +--oracle.jbo.domain.Array
All Implemented Interfaces:
BlobDomainInterface, CustomDatum, DomainInterface, DomainOwnerInterface, LobInterface, MarshalledDomain, MutableDomainInterface, oracle.jdbc.internal.ObjectData, java.io.Serializable, XMLDomainInterface

public synchronized class Array
extends java.lang.Object
implements LobInterface, DomainOwnerInterface, XMLDomainInterface, CustomDatum, java.io.Serializable, MarshalledDomain

See Also:
Serialized Form

Field Summary
protected  int mOwnerAttrIndex
           
 
Constructor Summary
protected Array()
           
  Array(ArrayDescriptor, java.sql.Connection, byte[])
           
  Array(ArrayDescriptor, java.sql.Connection, java.lang.Object)
           
  Array(Datum)
           
  Array(java.lang.Object[])
           
 
Method Summary
 void domainToBeModified(DomainInterface)
          Notification method that this domain calls whenever any of its attribute values are about to be modified.
 boolean equals(java.lang.Object)
           
 java.lang.Object[] getArray()
           
static CustomDatumFactory getCustomDatumFactory()
           
 java.lang.Object getData()
          Internal: Applications should not use this method.
 java.lang.Class getElemType()
           
protected  java.lang.String getElemXMLElementTag()
           
 java.lang.Object[] getInternalArray()
           
 DomainOwnerInterface getOwner()
          Returns the reference to owner of this domain (could be the row that this domain instance belongs to.)
 int getOwnerAttributeIndex()
           
 java.lang.String getRemoteIdString()
           
 long getSize()
           
 Node getXMLContentNode(Document)
          Creates the XML node in the given XML document for this domain's data.
static XMLDomainFactory getXMLDomainFactory(java.lang.Class)
           
protected  java.lang.String getXMLElementTag()
           
protected  boolean isElemXMLCData()
           
 void loadFromDatabase(Transaction)
           
 ResponseValues marshal()
           
 void prepareForDML(java.lang.Object)
          Internal: Applications should not use this method.
 java.lang.String printXMLDefinition(java.util.Hashtable, java.io.PrintWriter, boolean)
          Prints the DTD info for this domain in the given print writer.
protected  void readAttrsFromXML(Element)
           
 void saveToDatabase(Transaction)
           
 void saveToDatabase(Transaction, java.lang.Object)
          Internal: Applications should not use this method.
 void setContext(DomainOwnerInterface, Transaction, java.lang.Object)
          Internal: Applications should not use this method.
 void syncClientLob(LobInterface)
          Synchronize client-side data from the given lob
 void syncServerLob(LobInterface)
          Synchronize the streams from an older version of this object so that this version works with the opened streams (if any).
 Datum toDatum(OracleConnection)
           
 void useElementType(java.lang.Class)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mOwnerAttrIndex

protected int mOwnerAttrIndex
Constructor Detail

Array

protected Array()
         throws java.sql.SQLException

Array

public Array(java.lang.Object[])

Array

public Array(ArrayDescriptor,
             java.sql.Connection,
             java.lang.Object)
      throws java.sql.SQLException

Array

public Array(ArrayDescriptor,
             java.sql.Connection,
             byte[])
      throws java.sql.SQLException

Array

public Array(Datum)
      throws java.sql.SQLException
Method Detail

getCustomDatumFactory

public static CustomDatumFactory getCustomDatumFactory()

useElementType

public void useElementType(java.lang.Class)

toDatum

public Datum toDatum(OracleConnection)
              throws java.sql.SQLException
Specified by:
toDatum in interface CustomDatum

getData

public java.lang.Object getData()
Description copied from interface: DomainInterface
Internal: Applications should not use this method.

Returns the value in the format that is acceptable to the database.

For domain classes based on oracle.sql.* classes, this method returns a Datum object. For domains based on java.lang types such as String, the value-holder object that is passed to JDBC is returned.

Specified by:
getData in interface DomainInterface
Following copied from interface: oracle.jbo.domain.DomainInterface
Returns:
a formatted value object.

domainToBeModified

public void domainToBeModified(DomainInterface)
Description copied from interface: DomainOwnerInterface
Notification method that this domain calls whenever any of its attribute values are about to be modified. This Domain should always notify its owner.
Specified by:
domainToBeModified in interface DomainOwnerInterface
Following copied from interface: oracle.jbo.domain.DomainOwnerInterface
Parameters:
d - the domain being modified.

setContext

public void setContext(DomainOwnerInterface,
                       Transaction,
                       java.lang.Object)
Description copied from interface: DomainInterface
Internal: Applications should not use this method.
Specified by:
setContext in interface DomainInterface

getRemoteIdString

public java.lang.String getRemoteIdString()
Specified by:
getRemoteIdString in interface LobInterface

getArray

public java.lang.Object[] getArray()

getInternalArray

public java.lang.Object[] getInternalArray()

getElemType

public java.lang.Class getElemType()

equals

public boolean equals(java.lang.Object)
Overrides:
equals in class java.lang.Object

getXMLElementTag

protected java.lang.String getXMLElementTag()

getElemXMLElementTag

protected java.lang.String getElemXMLElementTag()

isElemXMLCData

protected boolean isElemXMLCData()

getXMLContentNode

public Node getXMLContentNode(Document)
Description copied from interface: XMLDomainInterface
Creates the XML node in the given XML document for this domain's data.

Specified by:
getXMLContentNode in interface XMLDomainInterface
Following copied from interface: oracle.jbo.domain.XMLDomainInterface
Parameters:
xmlDoc - name of the XML document in which the node should be created.

readAttrsFromXML

protected void readAttrsFromXML(Element)

printXMLDefinition

public java.lang.String printXMLDefinition(java.util.Hashtable,
                                           java.io.PrintWriter,
                                           boolean)
Description copied from interface: XMLDomainInterface
Prints the DTD info for this domain in the given print writer. Returns the DTD string to be added to this domain's container entity/domain.

The allDefs hashtable contains predefined XML definitions and is passed by whatever calls this method.

Specified by:
printXMLDefinition in interface XMLDomainInterface
Following copied from interface: oracle.jbo.domain.XMLDomainInterface
Parameters:
allDefs - a hashtable of predefined XML definitions passed from whatever calls this method.
pw - print writer into which the defnition is being printed.
bContainees - if true, prints definitions of contained objects.

getXMLDomainFactory

public static XMLDomainFactory getXMLDomainFactory(java.lang.Class)

loadFromDatabase

public void loadFromDatabase(Transaction)
                      throws java.lang.Exception
Specified by:
loadFromDatabase in interface BlobDomainInterface
Following copied from interface: oracle.jbo.domain.BlobDomainInterface
Parameters:
transaction - the DBTransactionImpl of the current Application Module.

saveToDatabase

public void saveToDatabase(Transaction)
                    throws java.lang.Exception
Specified by:
saveToDatabase in interface BlobDomainInterface
Following copied from interface: oracle.jbo.domain.BlobDomainInterface
Parameters:
transaction - the DBTransactionImpl instance of the current Application Module.

saveToDatabase

public void saveToDatabase(Transaction,
                           java.lang.Object)
                    throws java.lang.Exception
Description copied from interface: BlobDomainInterface
Internal: Applications should not use this method.

Uses the given transaction context to store data back into the database using the LOB-locator which should be set before this method is invoked.

Specified by:
saveToDatabase in interface BlobDomainInterface

prepareForDML

public void prepareForDML(java.lang.Object)
Description copied from interface: BlobDomainInterface
Internal: Applications should not use this method.
Specified by:
prepareForDML in interface BlobDomainInterface

syncClientLob

public void syncClientLob(LobInterface)
Description copied from interface: LobInterface
Synchronize client-side data from the given lob
Specified by:
syncClientLob in interface LobInterface

syncServerLob

public void syncServerLob(LobInterface)
Description copied from interface: LobInterface
Synchronize the streams from an older version of this object so that this version works with the opened streams (if any).
Specified by:
syncServerLob in interface LobInterface

getOwner

public DomainOwnerInterface getOwner()
Description copied from interface: LobInterface
Returns the reference to owner of this domain (could be the row that this domain instance belongs to.)
Specified by:
getOwner in interface LobInterface

getOwnerAttributeIndex

public int getOwnerAttributeIndex()
Specified by:
getOwnerAttributeIndex in interface LobInterface

getSize

public long getSize()
Specified by:
getSize in interface LobInterface

marshal

public ResponseValues marshal()
Specified by:
marshal in interface MarshalledDomain

Business Components