Package com.storedobject.core

Class StoredObjectUtility

java.lang.Object

com.storedobject.core.StoredObjectUtility

public final class StoredObjectUtility
extends Object

For internal use only.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StoredObjectUtility.Link<L extends StoredObject>
static class	StoredObjectUtility.MethodList

Constructor Summary

Constructors

Constructor	Description
StoredObjectUtility()

Method Summary

Modifier and Type	Method	Description
static StringList	browseColumns(Class<? extends StoredObject> objectClass)
static String	browseOrder(Class<? extends StoredObject> objectClass)
static <T extends StoredObject> boolean	changed(T newObject, T oldObject, StyledBuilder changes)
static ClassAttribute<? extends StoredObject>	classAttribute(int family)
static <T extends StoredObject> ClassAttribute<T>	classAttribute(Class<T> objectClass)
static <T extends StoredObject> ClassAttribute<T>	classAttribute(T object)
static String[]	createDDL(Class<? extends StoredObject> objectClass)
static StoredObjectUtility.Link<?>	createLink(Class<? extends StoredObject> masterClass, String linkDetails)	Creates a new Link object based on the specified master class and link details.
static Method	createMethod(Class<?> objectClass, String attributeName)
static StoredObjectUtility.MethodList	createMethodList(Class<?> objectClass, String attributeName)
static StoredObjectUtility.MethodList[]	createMethodLists(Class<?> objectClass, StringList attributeNames)
static Method[]	createMethods(Class<?> objectClass, String[] attributeNames)
static String	createSQL(ClassAttribute<?> ca, String columns, String condition, String order, boolean only, boolean header, int skip, int limit, int[] distinct)	Create a SQL execution string.
static StringList	displayColumns(Class<? extends StoredObject> objectClass)
static String[]	dropDDL(Class<? extends StoredObject> objectClass)
static <O extends StoredObject> StringBuilder	dump(StoredObject object, StringBuilder buffer)
static Object	emptyValue(Class<?> p)
static boolean	execute(Method method, Object object, String value)
static void	executeRaw(Method method, Object object, Object objectValue)
static <T extends StoredObject> int	family(Class<T> objectClass)
static String[]	foreignKeysDDL(Class<? extends StoredObject> objectClass)
static <T extends StoredObject> T	get(Class<T> objectClass, String nameField, String nameValue)
static <T extends StoredObject> T	get(Class<T> objectClass, String nameField, String nameValue, boolean any)
static <T extends StoredObject> T	get(Class<T> objectClass, String nameField, String nameValue, String extraCondition)
static <T extends StoredObject> T	get(Class<T> objectClass, String nameField, String nameValue, String extraCondition, boolean any)
static Class<? extends StoredObject>	getObjectClass(String className)
static Query	getTransactionLog(SystemUser su, Timestamp from, Timestamp to)
static int	hints(Class<? extends StoredObject> objectClass)
static int	howBig(Class<? extends StoredObject> objectClass, boolean any)
static Properties	initialize(File properties)
static Properties	initialize(File properties, Properties variables)
static Properties	initialize(InputStream in)
static Properties	initialize(InputStream in, Properties variables)
static Properties	initialize(String propertiesFileName)
static Properties	initialize(String propertiesFileName, Properties variables)
static Properties	initialize(Properties properties)
static Properties	initialize(Properties properties, Properties variables)
static ArrayList<StoredObjectUtility.Link<?>>	linkDetails(Class<? extends StoredObject> masterClass)
static ArrayList<StoredObjectUtility.Link<?>>	linkDetails(Class<? extends StoredObject> masterClass, StringList extraLinks)
static StringList	links(Class<? extends StoredObject> masterClass)
static <T extends StoredObject> ObjectIterator<T>	list(Class<T> objectClass, String nameField, String nameValue)
static <T extends StoredObject> ObjectIterator<T>	list(Class<T> objectClass, String nameField, String nameValue, boolean any)
static <T extends StoredObject> ObjectIterator<T>	list(Class<T> objectClass, String nameField, String nameValue, String extraCondition)
static <T extends StoredObject> ObjectIterator<T>	list(Class<T> objectClass, String nameField, String nameValue, String extraCondition, boolean any)
static StringList	protectedColumns(Class<? extends StoredObject> objectClass)
static String[]	reindex(Class<? extends StoredObject> objectClass)
static <O extends StoredObject> O	retrieveObject(Class<O> objectClass, Object value)	Retrieve an instance of the StoredObject from the value provided.
static boolean	sameContent(TransactionManager tm, StoredObject one, StoredObject two)
static StringList	searchColumns(Class<? extends StoredObject> objectClass)
static String	stackTrace()
static String	stackTrace(int count)
static String	stackTrace(int count, boolean includeCore)
static String	stackTrace(int count, boolean includeCore, int skip)
static int	statusUI(Class<? extends StoredObject> objectClass)
static void	substituteVariables(Properties properties, Properties variables)
static String	toDisplay(Device device, Object anything)
static String	toDisplay(Object anything)
static <O extends StoredObject> String	toString(StoredObject object)
static <O extends StoredObject> String	toString(StoredObject object, boolean showAttributes)

Methods inherited from class java.lang.Object

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

Constructor Details

StoredObjectUtility

public StoredObjectUtility()

Method Details

classAttribute

public static ClassAttribute<? extends StoredObject> classAttribute(int family)

family

public static <T extends StoredObject> int family(Class<T> objectClass)

classAttribute

public static <T extends StoredObject>
ClassAttribute<T> classAttribute(T object)

classAttribute

public static <T extends StoredObject>
ClassAttribute<T> classAttribute(Class<T> objectClass)

createDDL

public static String[] createDDL(Class<? extends StoredObject> objectClass)
                          throws Exception

Throws:

Exception

foreignKeysDDL

public static String[] foreignKeysDDL(Class<? extends StoredObject> objectClass)

dropDDL

public static String[] dropDDL(Class<? extends StoredObject> objectClass)

reindex

public static String[] reindex(Class<? extends StoredObject> objectClass)

substituteVariables

public static void substituteVariables(Properties properties,
 Properties variables)

initialize

public static Properties initialize(Properties properties)

initialize

public static Properties initialize(Properties properties,
 Properties variables)

initialize

public static Properties initialize(InputStream in)

initialize

public static Properties initialize(InputStream in,
 Properties variables)

initialize

public static Properties initialize(File properties)

initialize

public static Properties initialize(File properties,
 Properties variables)

initialize

public static Properties initialize(String propertiesFileName)

initialize

public static Properties initialize(String propertiesFileName,
 Properties variables)

howBig

public static int howBig(Class<? extends StoredObject> objectClass,
 boolean any)

hints

public static int hints(Class<? extends StoredObject> objectClass)

statusUI

public static int statusUI(Class<? extends StoredObject> objectClass)

displayColumns

public static StringList displayColumns(Class<? extends StoredObject> objectClass)

searchColumns

public static StringList searchColumns(Class<? extends StoredObject> objectClass)

protectedColumns

public static StringList protectedColumns(Class<? extends StoredObject> objectClass)

browseColumns

public static StringList browseColumns(Class<? extends StoredObject> objectClass)

links

public static StringList links(Class<? extends StoredObject> masterClass)

browseOrder

public static String browseOrder(Class<? extends StoredObject> objectClass)

toDisplay

public static String toDisplay(Object anything)

toDisplay

public static String toDisplay(Device device,
 Object anything)

createMethod

public static Method createMethod(Class<?> objectClass,
 String attributeName)

createMethods

public static Method[] createMethods(Class<?> objectClass,
 String[] attributeNames)

createMethodList

public static StoredObjectUtility.MethodList createMethodList(Class<?> objectClass,
 String attributeName)

createMethodLists

public static StoredObjectUtility.MethodList[] createMethodLists(Class<?> objectClass,
 StringList attributeNames)

execute

public static boolean execute(Method method,
 Object object,
 String value)

executeRaw

public static void executeRaw(Method method,
 Object object,
 Object objectValue)
                       throws Exception

Throws:

Exception

emptyValue

public static Object emptyValue(Class<?> p)

retrieveObject

public static <O extends StoredObject> O retrieveObject(Class<O> objectClass,
 Object value)

Retrieve an instance of the StoredObject from the value provided. The value may be anything including some representation of the Id or the object's stringified value from which it can be crated using its "get" method if it exists.

Type Parameters:

O - Type of the StoredObject.

Parameters:

objectClass - Class of the StoredObject.

value - Value to be converted.

Returns:

The instance created or null if not convertible.

toString

public static <O extends StoredObject> String toString(StoredObject object)

toString

public static <O extends StoredObject> String toString(StoredObject object,
 boolean showAttributes)

dump

public static <O extends StoredObject>
StringBuilder dump(StoredObject object,
 StringBuilder buffer)

getObjectClass

public static Class<? extends StoredObject> getObjectClass(String className)

createLink

public static StoredObjectUtility.Link<?> createLink(Class<? extends StoredObject> masterClass,
 String linkDetails)

Creates a new Link object based on the specified master class and link details.

     Format of the link details:
     Name|Class name[/Any[/Link type]]|Order by|Columns
     Name|Class name[/Link type[/Any]]Order by|Columns
 

Parameters:

masterClass - the class of the master object with which the link is associated; must be a subclass of StoredObject

linkDetails - a string defining the link details; the format of this string determines various properties of the created link

Returns:

a newly created Link object configured according to the given master class and link details

Throws:

SOClassError - if the link details are invalid for the specified master class

linkDetails

public static ArrayList<StoredObjectUtility.Link<?>> linkDetails(Class<? extends StoredObject> masterClass)

linkDetails

public static ArrayList<StoredObjectUtility.Link<?>> linkDetails(Class<? extends StoredObject> masterClass,
 StringList extraLinks)

get

public static <T extends StoredObject> T get(Class<T> objectClass,
 String nameField,
 String nameValue)

get

public static <T extends StoredObject> T get(Class<T> objectClass,
 String nameField,
 String nameValue,
 String extraCondition)

list

public static <T extends StoredObject>
ObjectIterator<T> list(Class<T> objectClass,
 String nameField,
 String nameValue)

list

public static <T extends StoredObject>
ObjectIterator<T> list(Class<T> objectClass,
 String nameField,
 String nameValue,
 String extraCondition)

get

public static <T extends StoredObject> T get(Class<T> objectClass,
 String nameField,
 String nameValue,
 boolean any)

get

public static <T extends StoredObject> T get(Class<T> objectClass,
 String nameField,
 String nameValue,
 String extraCondition,
 boolean any)

list

public static <T extends StoredObject>
ObjectIterator<T> list(Class<T> objectClass,
 String nameField,
 String nameValue,
 boolean any)

list

public static <T extends StoredObject>
ObjectIterator<T> list(Class<T> objectClass,
 String nameField,
 String nameValue,
 String extraCondition,
 boolean any)

stackTrace

public static String stackTrace()

stackTrace

public static String stackTrace(int count)

stackTrace

public static String stackTrace(int count,
 boolean includeCore)

stackTrace

public static String stackTrace(int count,
 boolean includeCore,
 int skip)

getTransactionLog

public static Query getTransactionLog(SystemUser su,
 Timestamp from,
 Timestamp to)

sameContent

public static boolean sameContent(TransactionManager tm,
 StoredObject one,
 StoredObject two)
                           throws Exception

Throws:

Exception

changed

public static <T extends StoredObject> boolean changed(T newObject,
 T oldObject,
 StyledBuilder changes)

createSQL

public static String createSQL(ClassAttribute<?> ca,
 String columns,
 String condition,
 String order,
 boolean only,
 boolean header,
 int skip,
 int limit,
 int[] distinct)

Create a SQL execution string. (Can be used for debugging purposes).

Parameters:

ca - Class attribute.

columns - Columns.

condition - Condition.

order - Order by clause.

only - Whether to use inherited instances or not.

header - Header to be used or not.

skip - Number of rows to be skipped before returning the results.

limit - Limit the number of rows.

distinct - Column numbers for the DISTINCT clause. An empty array is used to consider all the columns.

Returns:

SQL string.