|
Business Components | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.jbo.domain.Struct
This class provides a lightweight wrapper for oracle.sql.STRUCT, the Java representation of the Struct database type. This wrapper allows an instance of the oracle.sql.STRUCT to be used as a domain object.
The oracle.jbo.domain.StructDomain class is the Java representation of the underlying database type that you must use if you want to exploit the domain feature of Business Components for Java.
Field Summary | |
protected XMLDomainFactory[] |
mAttrXmlFac
Factories for each of the attibutes if they have one. |
protected java.lang.Object |
mConnection
Internal: Applications should not use this field. |
protected java.lang.Object[] |
mContext
Internal: Applications should not use this field. |
protected java.lang.Object |
mData
Internal: Applications should not use this field. |
protected int |
mOwnerAttrIndex
Index of the attribute in the domain owner's container. |
protected Transaction |
mTxn
Internal: Applications should not use this field. |
protected XMLDomainFactory |
mXmlFac
The factory object that creates an instance of this STRUCT given an XML element. |
Constructor Summary | |
protected |
Struct()
Constructs an instance of this class. |
protected |
Struct(oracle.sql.Datum d)
Internal: Applications should not use this constructor. |
Method Summary | |
int[] |
buildAttrSQLTypes()
Returns an array of the SQL datatypes of the attributes in this StructDomain object. |
void |
domainToBeModified(DomainInterface d)
Notification method that this domain calls whenever any of its attribute values are about to be modified. |
boolean |
equals(java.lang.Object obj)
Tests this for equality with another object. |
abstract oracle.sql.CustomDatumFactory[] |
getAttrCustomDatumFactories()
Returns factories that oracle.sql requires to create the attributes of this structure. |
java.lang.Object |
getAttribute(int index)
Returns the attribute from this StructDomain object, given its index. |
java.lang.Object |
getAttribute(java.lang.String name)
Returns the attribute from this StructDomain object, given its name. |
int |
getAttributeCount()
Returns the number of attributes in this StructDomain object. |
int |
getAttributeIndexOf(java.lang.String name)
Returns the index of a named attribute in this StructDomain object. |
abstract int[] |
getAttrSQLTypes()
Returns the SQL types for the attributes of the structure. |
protected java.lang.String |
getAttrXMLElementTag(AttributeDef ad)
Returns the class name of this domain, appended with the name of the attribute as xml-element tag for this domain-attribute. |
abstract java.lang.String |
getColumnType()
Returns the column type of the database column that corresponds to this STRUCT. |
java.lang.Object |
getData()
Internal: Applications should not use this method. |
abstract StructureDef |
getStructureDef()
Returns the structure definition, that describes the details of the attributes, of this domain. |
org.w3c.dom.Node |
getXMLContentNode(org.w3c.dom.Document xmlDoc)
Creates the xml node in the given xml document for this domain's data. |
static XMLDomainFactory |
getXMLDomainFactory(java.lang.Class attrClass)
Internal: Applications should not use this method. |
protected java.lang.String |
getXMLElementTag()
Returns this class name as xml-element tag for this Struct domain object. |
int |
hashCode()
Computes a hash code for this StructDomain object. |
protected void |
initAttrXMLDomainFactories(AttributeDef[] attrs)
Internal: Applications should not use this method. |
protected abstract void |
initStructureDef()
Initializes the structure definition of this object and its attribute definitions. |
protected boolean |
isAttrXMLCData(AttributeDef ad)
Returns false always. |
java.lang.String |
printXMLDefinition(java.util.Hashtable allDefs,
java.io.PrintWriter pw,
boolean bContainees)
Prints the DTD info for this domain in the given print writer. |
protected void |
readAttrsFromXML(org.w3c.dom.Element rowElt)
Reads all the attribute values from the xml-element and sets them into this row. |
void |
setAttribute(int index,
java.lang.Object value)
Sets the value of an attribute in this StructDomain, at the given index position. |
void |
setAttribute(java.lang.String name,
java.lang.Object value)
Sets the value of an attribute in this StructDomain object, given the attributes's name. |
void |
setAttributeNoCheck(int index,
java.lang.Object value)
Sets the value of an attribute in this StructDomain object, at the given index position. |
void |
setContext(DomainOwnerInterface owner,
Transaction trans,
java.lang.Object ctx)
Internal: Applications should not use this method. |
oracle.sql.Datum |
toDatum(oracle.jdbc.driver.OracleConnection conn)
Internal: Applications should not use this method. |
java.lang.String |
toString()
Internal: Applications should not use this method. |
Methods inherited from class java.lang.Object |
clone,
finalize,
getClass,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected java.lang.Object mData
protected java.lang.Object mConnection
protected Transaction mTxn
protected java.lang.Object[] mContext
protected int mOwnerAttrIndex
protected XMLDomainFactory mXmlFac
protected XMLDomainFactory[] mAttrXmlFac
Constructor Detail |
protected Struct() throws java.sql.SQLException
protected Struct(oracle.sql.Datum d) throws java.sql.SQLException
d
- a datum object.Method Detail |
public abstract java.lang.String getColumnType()
public abstract StructureDef getStructureDef()
public abstract int[] getAttrSQLTypes()
public abstract oracle.sql.CustomDatumFactory[] getAttrCustomDatumFactories()
protected abstract void initStructureDef()
public java.lang.Object getData()
Converts this
to a Struct JDBC object.
this
, or null
,
if the conversion fails.public void domainToBeModified(DomainInterface d)
d
- the domain being modified.public void setContext(DomainOwnerInterface owner, Transaction trans, java.lang.Object ctx)
public boolean equals(java.lang.Object obj)
this
for equality with another object.
The argument is converted to a STRUCT
object, if necessary.
obj
- an arbitrary Object
.true
if conversion was successful and the converted
argument is identical to this
.public int hashCode()
this
StructDomain object.this
StructDomain object.public java.lang.String toString()
For testing purposes only. Converts this
Struct
object to a text representation.
public oracle.sql.Datum toDatum(oracle.jdbc.driver.OracleConnection conn) throws java.sql.SQLException
Converts this Struct
Domain object back into an
SQL STRUCT
object.
conn
- Not used.Datum
containing STRUCT
object.public java.lang.Object getAttribute(int index)
index
- index for the attribute in the StructDomain object.public java.lang.Object getAttribute(java.lang.String name)
name
- name for the attribute in the StructDomain object.public void setAttribute(int index, java.lang.Object value)
index
- index for the attribute in the StructDomain object.value
- value for the attribute.public void setAttributeNoCheck(int index, java.lang.Object value)
index
- index for the attribute in the StructDomain object.value
- value for the attribute.public void setAttribute(java.lang.String name, java.lang.Object value)
name
- name of the attribute in the StructDomain object.value
- value for the attribute.public int getAttributeCount()
public int getAttributeIndexOf(java.lang.String name)
name
- name of an attribute in this StructDomain object.public int[] buildAttrSQLTypes()
protected java.lang.String getXMLElementTag()
protected java.lang.String getAttrXMLElementTag(AttributeDef ad)
ad
- the name of an AttributeDef.protected boolean isAttrXMLCData(AttributeDef ad)
ad
- name of an AttributeDef.public org.w3c.dom.Node getXMLContentNode(org.w3c.dom.Document xmlDoc)
xmlDoc
- name of the XML document in which the node should be created.protected void readAttrsFromXML(org.w3c.dom.Element rowElt)
public java.lang.String printXMLDefinition(java.util.Hashtable allDefs, java.io.PrintWriter pw, boolean bContainees)
The allDefs hashtable contains predefined XML definitions and is passed by whatever calls this method.
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.public static XMLDomainFactory getXMLDomainFactory(java.lang.Class attrClass)
protected void initAttrXMLDomainFactories(AttributeDef[] attrs)
|
Business Components | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |