org.ujorm.orm.utility

Class OrmTools

java.lang.Object

org.ujorm.orm.utility.OrmTools

public final class OrmTools
extends Object

Many useful methods for

• BLOB/CLOB
• lazy loading
• reloading

Constructor Summary

Constructors

Constructor and Description
OrmTools()

Method Summary

Modifier and Type	Method and Description
static <U extends org.ujorm.Ujo> U	clone(U entity) Clone the argument entity using all direct keys including the original ORM session, if any.
static SerialBlob	createBlob(byte[] bytes) Create a new Blob
static SerialBlob	createBlob(InputStream inputStream) Create a new Blob
static SerialClob	createClob(char[] text) Create a new Clob.
static SerialClob	createClob(Reader reader) Create a new Clob.
static SerialClob	createClob(String text) Create a new Clob.
static org.ujorm.criterion.Criterion	createCriterion(MetaTable table, org.ujorm.criterion.Criterion crn, List<Object> primaryKeys) Create new a Criterion.
static byte[]	getBlobBytes(Blob blob) Returns byte array to the maximal length Integer.MAX_VALUE.
static InputStream	getBlobStream(Blob blob) Returns a Blob byte array to the maximal length Integer.MAX_VALUE.
static char[]	getClob(Clob clob) Returns a result to the maximal length Integer.MAX_VALUE.
static String	getClobString(Clob clob) Returns a result to the maximal length Integer.MAX_VALUE.
static boolean	isFilled(Collection collection) Is the Collection not null and not empty ?
static boolean	isFilled(CharSequence text) Is the Text not null and not empty ?
static boolean	isFilled(Object value) Returns true, if the argument text is not null and not empty.
static <UJO extends OrmUjo> List<UJO>	loadLazyValues(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> List<UJO>	loadLazyValuesAsBatch(Iterable<UJO> ujos, org.ujorm.Key<UJO,? extends OrmUjo> key) Load lazy value for all items and required keys by the one SQL statement.
static <UJO extends ExtendedOrmUjo> List<UJO>	loadLazyValuesAsBatch(Query<UJO> query) Load lazy value for all items and all relation keys by the rule: a one SQL statement per relation key.
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 SerialBlob createBlob(byte[] bytes)

Create a new Blob

Parameters:

bytes - The null value is supported.

createBlob

public static SerialBlob createBlob(InputStream inputStream)

Create a new Blob

Parameters:

inputStream -

getBlobBytes

public static byte[] getBlobBytes(Blob blob)
                           throws org.ujorm.core.IllegalUjormException,
                                  IndexOutOfBoundsException

Returns byte array to the maximal length Integer.MAX_VALUE.

Parameters:

blob - The null value is supported.

Throws:

IllegalStateException - A container for the SQLExeption

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

org.ujorm.core.IllegalUjormException

getBlobStream

public static InputStream getBlobStream(Blob blob)
                                 throws org.ujorm.core.IllegalUjormException

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

Throws:

IllegalStateException - A container for the SQLExeption

org.ujorm.core.IllegalUjormException

createClob

public static final SerialClob createClob(char[] text)

Create a new Clob.

Parameters:

text - The null value is supported.

createClob

public static SerialClob createClob(String text)

Create a new Clob.

Parameters:

text - The null value is supported.

createClob

public static SerialClob createClob(Reader reader)

Create a new Clob.

getClobString

public static String getClobString(Clob clob)
                            throws org.ujorm.core.IllegalUjormException,
                                   IndexOutOfBoundsException

Returns a result to the maximal length Integer.MAX_VALUE.

Parameters:

clob - The null value is supported.

Throws:

IllegalStateException - A container for the SQLExeption

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

org.ujorm.core.IllegalUjormException

getClob

public static char[] getClob(Clob clob)
                      throws IllegalStateException,
                             IndexOutOfBoundsException

Returns a result to the maximal length Integer.MAX_VALUE.

Parameters:

clob - The null value is supported

Throws:

IllegalStateException - A container for the SQLExeption

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> List<UJO> loadLazyValues(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.ujorm.orm.OrmUjo)

loadLazyValuesAsBatch

public static <UJO extends ExtendedOrmUjo> List<UJO> loadLazyValuesAsBatch(Iterable<UJO> ujos,
                                                                           org.ujorm.Key<UJO,? extends OrmUjo> key)

Load lazy value for all items and required keys 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> List<UJO> loadLazyValuesAsBatch(Query<UJO> query)

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

Parameters:

query - An Ujorm 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.

createCriterion

public static org.ujorm.criterion.Criterion createCriterion(MetaTable table,
                                                            org.ujorm.criterion.Criterion crn,
                                                            List<Object> primaryKeys)

Create new a Criterion. Both parameters are joined by the OR operator however if a one from data parameters is null, than the operator is ignored.

Parameters:

table - NotNull

crn - Nullable

foreighKeys - Nullable

Returns:

NotNull

isFilled

public static boolean isFilled(CharSequence text)

Is the Text not null and not empty ?

isFilled

public static boolean isFilled(Collection collection)

Is the Collection not null and not empty ?

isFilled

public static boolean isFilled(Object value)

Returns true, if the argument text is not null and not empty.

clone

public static <U extends org.ujorm.Ujo> U clone(U entity)
                                         throws IllegalStateException

Clone the argument entity using all direct keys including the original ORM session, if any. All lazy relations will be loaded.

Throws:

IllegalStateException