|
Oracle ADF Business Components Domains API Reference 10.1.2 B14023-02 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.sql.DATE
oracle.jbo.domain.Date
This class extends oracle.sql.DATE, Oracle's Java representation of the DATE database type. This class allows an instance of the oracle.sql.DATE to be used as an immutable domain object.
The intent of many of the methods in this class is to wrap the corresponding method in the oracle.sql class such that it returns an instance of an oracle.jbo.domain.* object.
The oracle.jbo.domain.Date 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.
Date
objects consist of data (a byte array) and a Domain type code. Domain dates extend SQL dates by being convertable to and from JDBC values.
The oracle.jbo.domain.Date class accepts dates and times in the same format accepted by java.sql.TimeStamp (either a long milliseconds time value or the year, month, day, hour, minute, second, nano format) and java.sql.Date (either a milliseconds time value or the year, month, day format).
The following code snippet demonstrates one technique of converting from the date format expressed by oracle.jbo.domain.Date to another format.
... Date convertedDate = new Date(); String convertedDateString; java.text.SimpleDateFormat displayDateFormat = new java.text.SimpleDateFormat ("MM/dd/yyyy"); convertedDateString = displayDateFormat.format(convertedDate.dateValue());
The following code snippet demonstrates one technique of converting from an oracle.jbo.domain.Date data item to a java.util.Date data item:
... oracle.jbo.domain.Date dt = row.getBirthDate(); java.sql.Date ts = (java.sql.Date) dt.dateValue(); // since java.sql.Date is a java.util.Date, then... Calendar c = new Calendar(dt); ...
Field Summary | |
static java.sql.Time |
ZERO_TIME |
Constructor Summary | |
Date() Creates a default Date Domain object. |
|
Date(byte[] value) Internal: Applications should not invoke this method. |
|
Date(Date value) Creates a Date identical to an existing Date . |
|
Date(java.sql.Date value) Creates a Date Domain object from a JDBC Date . |
|
Date(java.lang.Object value) Creates a Date Domain object from a JDBC Object . |
|
Date(java.lang.String value) Creates a Date Domain object from a Java String . |
|
Date(java.sql.Time value) Creates a Date Domain object from a JDBC Time object. |
|
Date(java.sql.Timestamp value) Creates a Date Domain object from a JDBC Timestamp object. |
Method Summary | |
DATE |
addJulianDays(int julianDay, int julianSec) Adds the number of Julian days to a DateDomain. |
DATE |
addMonths(int months) Adds months to a date. |
Number |
diffInMonths(Date date) Calculates the difference between two dates in months. |
boolean |
equals(java.lang.Object other) Tests this for equality with another object. |
static DATE |
fromJulianDays(int julianDay, int julianSec) Converts given Julian days and seconds to a date. |
static DATE |
fromText(java.lang.String datestr, java.lang.String fmt, java.lang.String lang) Converts a formatted string to a date. |
static DATE |
getCurrentDate() Gets current date and time. |
static CustomDatumFactory |
getCustomDatumFactory() Internal: Applications should not invoke this method. |
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.util.Date |
getValue() Return a java.util.Date object with this domain's value. |
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() Computes a hash code for this . |
DATE |
lastDayOfMonth() Returns a date intialized to the last day of the month. |
static void |
main(java.lang.String[] argv) Internal: Applications should not invoke this method. |
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. |
DATE |
round(java.lang.String prec) Returns a date rounded to a specified precision. |
void |
setContext(DomainOwnerInterface owner, Transaction trans, java.lang.Object ctx) Internal: Applications should not invoke this method. |
DATE |
setDayOfWeek(int day) Returns a date initialized to a date advanced to the week of the day specified. |
static Date |
toDate(java.lang.String value) Converts an Oracle Date expressed as a string to a Java Date. |
Datum |
toDatum(oracle.jdbc.driver.OracleConnection conn) Internal: Applications should not invoke this method. |
NUMBER |
toNumber() Converts this date to an oracle.sql.NUMBER. |
java.lang.String |
toString() |
DATE |
truncate(java.lang.String prec) Returns a date truncated to a specified precision. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.sql.Time ZERO_TIME
Constructor Detail |
public Date()
Date
Domain object.
This constructor does not create a null date: use one of the NullValue()
constructors.
public Date(byte[] value)
Creates a Date
Domain object from the given byte array.
value
- a value returned by a previous call to getBytes()
on an SQL object compatable with Date
.public Date(Date value)
Date
identical to an existing Date
.value
- a Date
Domain object.public Date(java.sql.Date value)
Date
Domain object from a JDBC Date
.value
- a DATE
SQL object.public Date(java.sql.Time value)
Date
Domain object from a JDBC Time
object.value
- a Time
SQL object.public Date(java.sql.Timestamp value)
Date
Domain object from a JDBC Timestamp
object.value
- a TimeStamp
SQL object.public Date(java.lang.Object value) throws java.sql.SQLException
Date
Domain object from a JDBC Object
.value
- an Object
that is an instance of Date
, Time
, Timestamp
, or String
.java.sql.SQLException
- if the object is not of one of the recognized classes.public Date(java.lang.String value)
Date
Domain object from a Java String
.value
- a textual representation of a Date
.Method Detail |
public static CustomDatumFactory getCustomDatumFactory()
Initializes the Date
Domain.
This method is invoked when JBO is initialized. Applications should not call this method directly.
CustomDatumFactory
for the Date
Domain.public Datum toDatum(oracle.jdbc.driver.OracleConnection conn) throws java.sql.SQLException
Converts this Date
Domain object back into an SQL DATE
object.
Datum
containing DATE
object.SQLException
- Never.java.sql.SQLException
public java.util.Date getValue()
public java.lang.Object getData()
public void setContext(DomainOwnerInterface owner, Transaction trans, java.lang.Object ctx)
public static Date toDate(java.lang.String value)
public java.lang.String toString()
public boolean equals(java.lang.Object other)
this
for equality with another object. The argument is converted to a Date
object, if necessary.other
- an arbitrary Object
.true
if conversion was successful and the converted argument is identical to this
.public int hashCode()
this
.this
.public DATE addJulianDays(int julianDay, int julianSec)
Date
Domain object initalized to the DATE values added to the Julian days.julianDay
- number of Julian days to add to Date.julianSec
- number of seconds past midnight.Date
Domain object.oracle.jbo.domain.GenericDomainException
public DATE addMonths(int months)
Date
Domain object.public Number diffInMonths(Date date)
Date
Domain object.date
- Date to be subtracted as a DateDomain.public static DATE getCurrentDate()
Date
Domain object.public static DATE fromJulianDays(int julianDay, int julianSec)
Date
Domain object.julianDay
- Number of Julian daysjulianSec
- Number of seconds past midnightoracle.jbo.domain.GenericDomainException
public static DATE fromText(java.lang.String datestr, java.lang.String fmt, java.lang.String lang)
Date
Domain object. param datestr text to convertfmt
- formatlang
- the NLS language the conversion is to be performed in, null indicates use default.oracle.jbo.domain.GenericDomainException
public DATE lastDayOfMonth()
Date
Domain object.oracle.jbo.domain.GenericDomainException
public DATE round(java.lang.String prec)
Date
Domain object.prec
- precision to use while roundingoracle.jbo.domain.GenericDomainException
public DATE setDayOfWeek(int day)
Date
Domain object.day
- day of the week the date needs to be advancedoracle.jbo.domain.GenericDomainException
public NUMBER toNumber()
Date
Domain object.oracle.jbo.domain.GenericDomainException
public DATE truncate(java.lang.String prec)
prec
- precision to use while truncatingDate
Domain object.oracle.jbo.domain.GenericDomainException
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 Node getXMLContentNode(Document xmlDoc)
xmlDoc
- name of the XML document in which the node should be created.public Node getSerializedDomainXML(Document xmlDoc)
xmlDoc
- name of the XML document in which the node should be created.public static XMLDomainReaderFactory getXMLDomainFactory(java.lang.Class attrClass)
public static void main(java.lang.String[] argv) throws java.sql.SQLException
java.sql.SQLException
|
Oracle ADF Business Components Domains API Reference 10.1.2 B14023-02 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2005, Oracle. All rights reserved.