org.ujoframework.orm.utility
Class OrmTools

java.lang.Object
  org.ujoframework.orm.utility.OrmTools

public final class OrmTools
extends java.lang.Object

Many useful methods for

• BLOB/CLOB
• lazy loading
• reloading

Author:

Pavel Ponec

Constructor Summary

OrmTools()


Method Summary

static javax.sql.rowset.serial.SerialBlob	createBlob(byte[] bytes) Create a new Blob
static javax.sql.rowset.serial.SerialBlob	createBlob(java.io.InputStream inputStream) Create a new Blob
static javax.sql.rowset.serial.SerialClob	createClob(char[] text) Create a new Clob.
static javax.sql.rowset.serial.SerialClob	createClob(java.io.Reader reader) Create a new Clob.
static javax.sql.rowset.serial.SerialClob	createClob(java.lang.String text) Create a new Clob.
static byte[]	getBlobBytes(java.sql.Blob blob) Returns byte array to the maximal length Integer.MAX_VALUE.
static java.io.InputStream	getBlobStream(java.sql.Blob blob) Returns a Blob byte array to the maximal length Integer.MAX_VALUE.
static char[]	getClob(java.sql.Clob clob) Returns a result to the maximal length Integer.MAX_VALUE.
static java.lang.String	getClobString(java.sql.Clob clob) Returns a result to the maximal length Integer.MAX_VALUE.
static <UJO extends OrmUjo> java.util.List<UJO>	loadLazyValues(java.lang.Iterable<UJO> ujos, int depth) Load all lazy values for the current parameter recursively until optional depth.
static void	loadLazyValues(OrmUjo ujo) Load all lazy values for the current parameter.
static void	loadLazyValues(OrmUjo ujo, int depth) Load all lazy values for the current parameter recursively until optional depth.
static <UJO extends ExtendedOrmUjo> java.util.List<UJO>	loadLazyValuesAsBatch(java.lang.Iterable<UJO> ujos, UjoProperty<UJO,? extends OrmUjo> property) Load lazy value for all items and required property by the one SQL statement.
static <UJO extends ExtendedOrmUjo> java.util.List<UJO>	loadLazyValuesAsBatch(Query<UJO> query) Load lazy value for all items and all relation properties by the rule: a one SQL statement per relation property.
boolean	reload(OrmUjo ujo, Session session) Reload values of the persistent object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrmTools

public OrmTools()

Method Detail

createBlob

public static final javax.sql.rowset.serial.SerialBlob createBlob(byte[] bytes)

Create a new Blob

Parameters:

bytes - The null value is supported.

Returns:

createBlob

public static javax.sql.rowset.serial.SerialBlob createBlob(java.io.InputStream inputStream)

Create a new Blob

Parameters:

inputStream -

Returns:

getBlobBytes

public static byte[] getBlobBytes(java.sql.Blob blob)
                           throws java.lang.IllegalStateException,
                                  java.lang.IndexOutOfBoundsException

Returns byte array to the maximal length Integer.MAX_VALUE.

Parameters:

blob - The null value is supported.

Throws:

java.lang.IllegalStateException - A container for the SQLExeption

java.lang.IndexOutOfBoundsException - Length of the bytes is great than Integer.MAX_VALUE

getBlobStream

public static java.io.InputStream getBlobStream(java.sql.Blob blob)
                                         throws java.lang.IllegalStateException

Returns a Blob byte array to the maximal length Integer.MAX_VALUE.

Throws:

java.lang.IllegalStateException - A container for the SQLExeption

createClob

public static final javax.sql.rowset.serial.SerialClob createClob(char[] text)

Create a new Clob.

Parameters:

text - The null value is supported.

createClob

public static final javax.sql.rowset.serial.SerialClob createClob(java.lang.String text)

Create a new Clob.

Parameters:

text - The null value is supported.

createClob

public static final javax.sql.rowset.serial.SerialClob createClob(java.io.Reader reader)

Create a new Clob.

getClobString

public static java.lang.String getClobString(java.sql.Clob clob)
                                      throws java.lang.IllegalStateException,
                                             java.lang.IndexOutOfBoundsException

Returns a result to the maximal length Integer.MAX_VALUE.

Parameters:

clob - The null value is supported.

Throws:

java.lang.IllegalStateException - A container for the SQLExeption

java.lang.IndexOutOfBoundsException - Length of the bytes is great than Integer.MAX_VALUE

getClob

public static char[] getClob(java.sql.Clob clob)
                      throws java.lang.IllegalStateException,
                             java.lang.IndexOutOfBoundsException

Returns a result to the maximal length Integer.MAX_VALUE.

Parameters:

clob - The null value is supported

Throws:

java.lang.IllegalStateException - A container for the SQLExeption

java.lang.IndexOutOfBoundsException - Length of the bytes is great than Integer.MAX_VALUE

loadLazyValues

public static void loadLazyValues(OrmUjo ujo)

Load all lazy values for the current parameter.

loadLazyValues

public static void loadLazyValues(OrmUjo ujo,
                                  int depth)

Load all lazy values for the current parameter recursively until optional depth.

Parameters:

ujo - The object must not be null.

depth - The object depth.

loadLazyValues

public static <UJO extends OrmUjo> java.util.List<UJO> loadLazyValues(java.lang.Iterable<UJO> ujos,
                                                                      int depth)

Load all lazy values for the current parameter recursively until optional depth.

Parameters:

ujos - The parameter can be the Query, UjoIterator and some List for example.

depth - The object resursion depth.

Returns:

Returns a list of items or the parameter ujos. If the 'ujos' parameter is type of List, than method returns the parameter directly.

reload

public boolean reload(OrmUjo ujo,
                      Session session)

Reload values of the persistent object.
Note: If the object has implemented the interface ExtendedOrmUjo than foreign keys are reloaded, else a lazy initialization for first depth is done.

Parameters:

ujo - The persistent object to relading values.

Returns:

The FALSE value means that the object is missing in the database.

See Also:

Session.reload(org.ujoframework.orm.OrmUjo)

loadLazyValuesAsBatch

public static <UJO extends ExtendedOrmUjo> java.util.List<UJO> loadLazyValuesAsBatch(java.lang.Iterable<UJO> ujos,
                                                                                     UjoProperty<UJO,? extends OrmUjo> property)

Load lazy value for all items and required property by the one SQL statement.

Parameters:

ujos - The parameter can be the Query, UjoIterator and some List for example.

Returns:

Returns a list of items or the parameter ujos. If the 'ujos' parameter is type of List, than method returns the parameter directly.

loadLazyValuesAsBatch

public static <UJO extends ExtendedOrmUjo> java.util.List<UJO> loadLazyValuesAsBatch(Query<UJO> query)

Load lazy value for all items and all relation properties by the rule: a one SQL statement per relation property.

Parameters:

query -

Returns:

Returns a list of items or the parameter ujos. If the 'ujos' parameter is type of List, than method returns the parameter directly.