oracle.jbo.domain
Class Ref

oracle.jbo.domain.Ref

All Implemented Interfaces:

java.io.Serializable

public class Ref

implements java.io.Serializable

This class provides a lightweight wrapper for oracle.sql.Ref, the Java representation of the REF database type. This wrapper allows an instance of the oracle.sql.Ref to be used as an immutable Domain object.

The oracle.jbo.domain.Ref 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.

Since:

JDeveloper 3.0

See Also:

Serialized Form

Constructor Summary

Type	Constructor
protected	Ref() Internal: Applications should not invoke this constructor.
	Ref(Datum d) Internal: Applications should not invoke this constructor.
	Ref(java.lang.String structName, byte[] data) Internal: Applications should not invoke this constructor.

Method Summary

Type	Method
boolean	equals(java.lang.Object obj) Tests this for equality with another object.
byte[]	getBytes() Returns the contents of the Ref in byte format.
static CustomDatumFactory	getCustomDatumFactory() Internal: Applications should not invoke this method.
java.lang.Object	getData() Internal: Applications should not invoke this method.
oracle.jbo.Row	getReferencedObject(oracle.jbo.domain.DomainAttributeDef ad) Returns an an instance of the refernced row, given the attribute definition object.
java.lang.String	getStructName() Returns the name of the struct associated with this RefDomain.
void	setContext(oracle.jbo.domain.DomainOwnerInterface owner, oracle.jbo.Transaction trans, java.lang.Object fac) Internal: Applications should not invoke this method.
Datum	toDatum(OracleConnection conn) Internal: Applications should not invoke this method.

Constructor Detail

Ref

protected Ref()
       throws java.sql.SQLException

Internal: Applications should not invoke this constructor.

Ref

public Ref(java.lang.String structName,
           byte[] data)

Internal: Applications should not invoke this constructor.

Creates a Ref Domain object.

Ref

public Ref(Datum d)
    throws java.sql.SQLException

Internal: Applications should not invoke this constructor.

Method Detail

getCustomDatumFactory

public static CustomDatumFactory getCustomDatumFactory()

Internal: Applications should not invoke this method.

Initializes the Ref Domain. This method is invoked when Business Components for Java is initialized.

Returns:

the CustomDatumFactory for the Ref Domain.

toDatum

public Datum toDatum(OracleConnection conn)
              throws java.sql.SQLException

Internal: Applications should not invoke this method.

Converts this Ref Domain object back into a SQL REF object.

Parameters:

conn - Not used.

Returns:

A Datum containing REF object.

Throws:

java.sql.SQLException - Never.

setContext

public void setContext(oracle.jbo.domain.DomainOwnerInterface owner,
                       oracle.jbo.Transaction trans,
                       java.lang.Object fac)

Internal: Applications should not invoke this method.

getData

public java.lang.Object getData()

Internal: Applications should not invoke this method.

Converts this to a JDBC object.

Returns:

the JDBC representation of this, or null, if the conversion fails.

getStructName

public java.lang.String getStructName()

Returns the name of the struct associated with this RefDomain.

Returns:

the name of the struct.

getBytes

public byte[] getBytes()

Returns the contents of the Ref in byte format.

Returns:

a byte array containing the contents of the Ref.

getReferencedObject

public oracle.jbo.Row getReferencedObject(oracle.jbo.domain.DomainAttributeDef ad)

Returns an an instance of the refernced row, given the attribute definition object. The referenced row is returned as an Row object.

Parameters:

ad - the attribute's attribute definition object.

Returns:

the row corredsponding to the attribute definition object.

See Also:

Row

equals

public boolean equals(java.lang.Object obj)

Tests this for equality with another object.

The argument is converted to a Ref object, if necessary.

Parameters:

other - an arbitrary Object.

Returns:

true if conversion was successful and the converted argument is identical to this.