oracle.jbo.domain
Class NullValue

java.lang.Object
  oracle.jbo.domain.NullValue

All Implemented Interfaces:

java.io.Serializable, DomainInterface, XMLDomainInterface, XMLDomainWriter

Direct Known Subclasses:

NoMasterRowMarker, WhereClauseParamNoValue

public class NullValue
extends java.lang.Object
implements DomainInterface, XMLDomainWriter, java.io.Serializable

Provides a means of creating and serializing null Domain objects.

The zero-parameter constructors for each Domain type produce default objects, rather than null objects. Use the constructors for this class to produce typed null Domain objects.

Since:

JDeveloper 3.0

See Also:

Serialized Form

Constructor Summary

NullValue()
Creates a default null Domain object, of type VARCHAR.

NullValue(int sqlTypeId)
Creates a null value for a specified Domain type.

NullValue(java.lang.String sqlType)
Creates a null value for a specified Domain type.

Method Summary

boolean	equals(java.lang.Object obj) Tests this for equality with another object.
java.lang.Object	getData() Internal: Applications should not invoke this method.
Node	getSerializedDomainXML(Document xmlDoc) Creates the xml node in the given xml document for this domain's data in hex format of the byte[] representation of the data.
java.lang.String	getSQLType() Converts this to string naming a JDBC type.
int	getSQLTypeId() Converts this to a JDBC type ID.
Node	getXMLContentNode(Document xmlDoc) Creates the xml node in the given xml document for this domain's data.
static XMLDomainReaderFactory	getXMLDomainFactory(java.lang.Class attrClass) Internal: Applications should not use this method.
int	hashCode() Generates a hashcode for NullValue.
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.
void	setContext(DomainOwnerInterface owner, Transaction trans, java.lang.Object ctx) Internal: Applications should not invoke this method.
java.lang.String	toString() For testing purposes only: converts this to a string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NullValue

public NullValue()

Creates a default null Domain object, of type VARCHAR.

NullValue

public NullValue(int sqlTypeId)

Creates a null value for a specified Domain type.

Parameters:

sqlTypeId - an integer representing a JDBC type.

See Also:

"java.sql.TYPES"

NullValue

public NullValue(java.lang.String sqlType)

Creates a null value for a specified Domain type.

Parameters:

sqlType - an string representing a JDBC type.

See Also:

JboTypeMap

Method Detail

getSQLTypeId

public int getSQLTypeId()

Converts this to a JDBC type ID.

See Also:

"java.sql.TYPES"

getSQLType

public java.lang.String getSQLType()

Converts this to string naming a JDBC type.

See Also:

JboTypeMap

getData

public java.lang.Object getData()

Internal: Applications should not invoke this method.

Converts this to a JDBC object.

Specified by:

getData in interface DomainInterface

Returns:

a formatted value object.

setContext

public void setContext(DomainOwnerInterface owner,
                       Transaction trans,
                       java.lang.Object ctx)

Internal: Applications should not invoke this method.

Specified by:

setContext in interface DomainInterface

toString

public java.lang.String toString()

For testing purposes only: converts this to a string.

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Generates a hashcode for NullValue.

Overrides:

hashCode in class java.lang.Object

Returns:

the hashcode.

equals

public boolean equals(java.lang.Object obj)

Tests this for equality with another object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - an arbitrary Object.

Returns:

true if the parameter is either null, or a NullValue of the same Domain type as this.

printXMLDefinition

public 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. 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

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.

getXMLContentNode

public Node getXMLContentNode(Document xmlDoc)

Creates the xml node in the given xml document for this domain's data.

Specified by:

getXMLContentNode in interface XMLDomainInterface

Parameters:

xmlDoc - name of the XML document in which the node should be created.

getSerializedDomainXML

public Node getSerializedDomainXML(Document xmlDoc)

Creates the xml node in the given xml document for this domain's data in hex format of the byte[] representation of the data.

Specified by:

getSerializedDomainXML in interface XMLDomainWriter

Parameters:

xmlDoc - name of the XML document in which the node should be created.

getXMLDomainFactory

public static XMLDomainReaderFactory getXMLDomainFactory(java.lang.Class attrClass)

Internal: Applications should not use this method.