to.etc.domui.component.meta

Class MetaManager

java.lang.Object

to.etc.domui.component.meta.MetaManager

public final class MetaManager
extends Object

Accessor class to the generalized metadata thingies.

Author:

Frits Jalvingh Created on Jun 16, 2008

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<DisplayPropertyMetaModel>	C_BY_SORT_INDEX Comparator to sort by ascending sortIndex.

Method Summary

Modifier and Type	Method and Description
static void	applyPropertySort(QCriteria<?> q, List<DisplayPropertyMetaModel> properties) Walk the list of properties, and defines the list that should be added as sort properties to the QCriteria.
static boolean	areObjectsEqual(Object a, Object b)
static boolean	areObjectsEqual(Object a, Object b, ClassMetaModel cmm) This is a complex EQUAL routine which compares objects.
static List<DisplayPropertyMetaModel>	calculateObjectProperties(ClassMetaModel cm) Generate some set of columns to show from a class' metadata, if enabled.
static List<SearchPropertyMetaModel>	calculateSearchProperties(ClassMetaModel cm) Try to calculate some search properties off a data class for debug/test pps, if enabled
static void	copyValuesExcept(Object to, Object from, Object... except) Copy all matching properties from "from" to "to", but ignore the specified list of properties.
static INodeContentRenderer<?>	createDefaultComboRenderer(PropertyMetaModel<?> pmm, ClassMetaModel cmm) This creates a default combo option value renderer using whatever metadata is available.
static <T extends Enum<?>> List<ValueLabelPair<T>>	createEnumList(Class<T> clz) Creates a List of Pair's for each domain value in a class which represents a domain (like an enum or Boolean).
static <T> void	fillCopy(T source, T target) Fill target instance with same values as found in source instance.
static <T> void	fillCopy(T source, T target, boolean copyPK, boolean copyTCN, boolean copyTransient, String... ignoredColumns) Fill target instance with same values as found in source instance.
static <T> void	fillCopy(T source, T target, String... ignoredColumns) Fill target instance with same values as found in source instance.
static <X,T extends Collection<X>> List<X>	filter(T in, QCriteria<X> query) Return a new list which contains only the items in the input list that are obeying the specified criteria.
static ClassMetaModel	findClassByTable(String tableName) EXPENSIVE - Use with care - try to find a ClassMetaModel that represents the specified table name.
static ClassMetaModel	findClassMeta(Class<?> clz)
static ClassMetaModel	findClassMeta(IMetaClass mc) Get the metamodel for some metadata-defined object.
static Class<?>	findCollectionType(Type genericType) This tries to determine the value class for a property defined as some kind of Collection<T> or T[].
static <T extends Enum<?>> String	findEnumLabel(T val) Locate the enum's default label.
static PropertyMetaModel<?>	findPropertyMeta(Class<?> clz, String name) Find a property using the metamodel for a class.
static PropertyMetaModel<?>	findPropertyMeta(IMetaClass mc, String name) Find a property using some genericized meta definition.
static List<DisplayPropertyMetaModel>	getComboProperties(PropertyMetaModel<?> pmm) Return the list of defined combo properties, either on property model or class model.
static String	getEnumLabel(Class<?> clz, String property, Object value) Get a label for the enum value "value" presented on the property passed.
static String	getEnumLabel(Enum<?> label) Get a NLSed label for the specified enum label.
static String	getEnumLabel(PropertyMetaModel<?> pmm, Object value) Get a label for the enum value "value" presented on the property passed.
static Object	getPrimaryKey(Object instance) Return the primary key field for a given instance.
static Object	getPrimaryKey(Object instance, ClassMetaModel cmm)
static PropertyMetaModel<?>	getPropertyMeta(Class<?> clz, String name)
static PropertyMetaModel<?>	getPropertyMeta(IMetaClass clz, String name)
static <K,T extends IIdentifyable<K>> String	hasChildRecords(QDataContext dc, String schemaName, T instance) If the persistent class specified has dependent child records this returns the first table name or table entity name (if found) for which children are found.
static <T> boolean	hasDuplicates(List<T> items, T instance, String propertyname) Returns T if instance.propertyname is a duplicate in some other instance in the list.
static String	identify(Object t)
static PropertyMetaModel<?>	internalCalculateDottedPath(ClassMetaModel cmm, String name)
static void	internalClear() Clears the cache.
static boolean	isAccessAllowed(String[][] roleset, IRequestContext ctx) Handles the permission sets like "viewpermission" and "editpermission".
static List<PropertyMetaModel<?>>	parsePropertyPath(ClassMetaModel m, String compoundName) Parse the property path and return the list of properties in the path.
static void	registerModel(IClassMetaModelFactory model)

Methods inherited from class java.lang.Object

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

Field Detail

C_BY_SORT_INDEX

public static final Comparator<DisplayPropertyMetaModel> C_BY_SORT_INDEX

Comparator to sort by ascending sortIndex.

Method Detail

registerModel

public static void registerModel(@Nonnull
                                 IClassMetaModelFactory model)

findClassMeta

@Nonnull
public static ClassMetaModel findClassMeta(@Nonnull
                                                    Class<?> clz)

findClassMeta

@Nonnull
public static ClassMetaModel findClassMeta(@Nonnull
                                                    IMetaClass mc)

Get the metamodel for some metadata-defined object.

Parameters:

mc -

Returns:

internalClear

public static void internalClear()

Clears the cache. In use by reloading class mechanism, hence only ever called while developing never in production. Dont use otherwise.

findPropertyMeta

@Nullable
public static PropertyMetaModel<?> findPropertyMeta(@Nonnull
                                                              Class<?> clz,
                                                              @Nonnull
                                                              String name)

Find a property using the metamodel for a class. Returns null if not found.

Parameters:

clz -

name -

Returns:

findPropertyMeta

@Nullable
public static PropertyMetaModel<?> findPropertyMeta(IMetaClass mc,
                                                              String name)

Find a property using some genericized meta definition. Returns null if not found.

Parameters:

mc -

name -

Returns:

getPropertyMeta

@Nonnull
public static PropertyMetaModel<?> getPropertyMeta(Class<?> clz,
                                                            String name)

getPropertyMeta

@Nonnull
public static PropertyMetaModel<?> getPropertyMeta(IMetaClass clz,
                                                            String name)

isAccessAllowed

public static boolean isAccessAllowed(String[][] roleset,
                                      IRequestContext ctx)

Handles the permission sets like "viewpermission" and "editpermission". If the array contains null the field can be seen by all users. If it has a value the first-level array is a set of ORs; the second level are ANDs. Meaning that an array in the format:

 { {"admin"}
 , {"editroles", "user"}
 , {"tester"}
 };
 

this means that the field is visible for a user with the roles:

        "admin" OR "tester" OR ("editroles" AND "user")
 

Parameters:

roleset -

ctx -

Returns:

createDefaultComboRenderer

@Nonnull
public static INodeContentRenderer<?> createDefaultComboRenderer(@Nullable
                                                                          PropertyMetaModel<?> pmm,
                                                                          @Nullable
                                                                          ClassMetaModel cmm)

This creates a default combo option value renderer using whatever metadata is available.

Parameters:

pmm - If not-null this takes precedence. This then must be the property that is to be filled from the list-of-values in the combo. The property is used to override the presentation only. Formally speaking, pmm.getActualType() must be equal to the combo's list item type, and the renderer expects items of that type.

cmm -

Returns:

areObjectsEqual

public static boolean areObjectsEqual(Object a,
                                      Object b,
                                      ClassMetaModel cmm)

This is a complex EQUAL routine which compares objects. Each of the objects can be null. Objects are considered equal when they are the same reference; if a.equal(b) holds or, when the objects are both objects for which a PK is known, when the PK's are equal. Also works for array types.

Parameters:

a -

b -

cmm -

Returns:

areObjectsEqual

public static boolean areObjectsEqual(Object a,
                                      Object b)

findEnumLabel

public static <T extends Enum<?>> String findEnumLabel(T val)

Locate the enum's default label.

Type Parameters:

T -

Parameters:

val -

Returns:

createEnumList

public static <T extends Enum<?>> List<ValueLabelPair<T>> createEnumList(Class<T> clz)

Creates a List of Pair's for each domain value in a class which represents a domain (like an enum or Boolean). The list is ready to be used by ComboFixed.

Parameters:

clz -

Returns:

internalCalculateDottedPath

public static PropertyMetaModel<?> internalCalculateDottedPath(ClassMetaModel cmm,
                                                               String name)

parsePropertyPath

public static List<PropertyMetaModel<?>> parsePropertyPath(@Nonnull
                                                           ClassMetaModel m,
                                                           String compoundName)

Parse the property path and return the list of properties in the path. This explicitly allows traversing child relations provided generic type information is present to denote the child's type.

Parameters:

m -

compoundName -

Returns:

findCollectionType

@Nullable
public static Class<?> findCollectionType(Type genericType)

This tries to determine the value class for a property defined as some kind of Collection<T> or T[]. If the type cannot be determined this returns null.

Parameters:

genericType -

Returns:

hasDuplicates

public static <T> boolean hasDuplicates(List<T> items,
                                        T instance,
                                        String propertyname)
                                 throws Exception

Returns T if instance.propertyname is a duplicate in some other instance in the list.

Type Parameters:

T -

Parameters:

items -

instance -

propertyname -

Returns:

Throws:

Exception

identify

public static String identify(Object t)

Parameters:

t -

Returns:

getPrimaryKey

public static Object getPrimaryKey(Object instance)
                            throws Exception

Return the primary key field for a given instance. This throws IllegalArgumentException's when the instance passed is not persistent or has an unknown primary key. If the primary key is just null this returns null.

Parameters:

instance -

Returns:

Throws:

Exception

getPrimaryKey

public static Object getPrimaryKey(Object instance,
                                   ClassMetaModel cmm)
                            throws Exception

Throws:

Exception

calculateSearchProperties

@Nonnull
public static List<SearchPropertyMetaModel> calculateSearchProperties(ClassMetaModel cm)

Try to calculate some search properties off a data class for debug/test pps, if enabled

Parameters:

cm -

Returns:

calculateObjectProperties

@Nonnull
public static List<DisplayPropertyMetaModel> calculateObjectProperties(ClassMetaModel cm)

Generate some set of columns to show from a class' metadata, if enabled.

Parameters:

cmm -

Returns:

getEnumLabel

public static String getEnumLabel(Enum<?> label)

Get a NLSed label for the specified enum label.

getEnumLabel

public static String getEnumLabel(Class<?> clz,
                                  String property,
                                  Object value)

Get a label for the enum value "value" presented on the property passed. This will first check to see if this property has overridden the labels for the enum before falling back to the enum's global bundle.

Parameters:

clz -

property -

value -

Returns:

getEnumLabel

public static String getEnumLabel(PropertyMetaModel<?> pmm,
                                  Object value)

Get a label for the enum value "value" presented on the property passed. This will first check to see if this property has overridden the labels for the enum before falling back to the enum's global bundle.

Parameters:

pmm -

value -

Returns:

copyValuesExcept

public static void copyValuesExcept(Object to,
                                    Object from,
                                    Object... except)
                             throws Exception

Copy all matching properties from "from" to "to", but ignore the specified list of properties. Since properties are copied by name the objects can be of different types.

Parameters:

to -

from -

except -

Throws:

Exception

getComboProperties

@Nonnull
public static List<DisplayPropertyMetaModel> getComboProperties(@Nonnull
                                                                         PropertyMetaModel<?> pmm)

Return the list of defined combo properties, either on property model or class model. Returns the empty list if none are defined.

Parameters:

pmm -

Returns:

applyPropertySort

public static void applyPropertySort(@Nonnull
                                     QCriteria<?> q,
                                     @Nonnull
                                     List<DisplayPropertyMetaModel> properties)

Walk the list of properties, and defines the list that should be added as sort properties to the QCriteria.

Parameters:

crit -

properties -

fillCopy

public static <T> void fillCopy(@Nonnull
                                T source,
                                @Nonnull
                                T target)

Fill target instance with same values as found in source instance. PK, TCN and transient properties would not be copied.

Type Parameters:

T -

Parameters:

source -

target -

Throws:

Exception

fillCopy

public static <T> void fillCopy(@Nonnull
                                T source,
                                @Nonnull
                                T target,
                                String... ignoredColumns)

Fill target instance with same values as found in source instance. PK, TCN and transient properties would not be copied.

Type Parameters:

T -

Parameters:

source -

target -

ignoredColumns - Specified optional columns that would not be filled with data from source

Throws:

Exception

fillCopy

public static <T> void fillCopy(@Nonnull
                                T source,
                                @Nonnull
                                T target,
                                boolean copyPK,
                                boolean copyTCN,
                                boolean copyTransient,
                                String... ignoredColumns)

Fill target instance with same values as found in source instance.

Type Parameters:

T -

Parameters:

source -

target -

copyPK - If T, it also copies PK value(s)

copyTCN - If T, it also copies TCN value(s)

copyTransient - If T, it also copies transient values

ignoredColumns - Specified optional columns that would not be filled with data from source

Throws:

Exception

findClassByTable

@Nullable
public static ClassMetaModel findClassByTable(@Nonnull
                                                        String tableName)

EXPENSIVE - Use with care - try to find a ClassMetaModel that represents the specified table name.

Parameters:

tableName -

Returns:

hasChildRecords

@Nullable
public static <K,T extends IIdentifyable<K>> String hasChildRecords(QDataContext dc,
                                                                              @Nonnull
                                                                              String schemaName,
                                                                              @Nonnull
                                                                              T instance)
                                                                       throws Exception

If the persistent class specified has dependent child records this returns the first table name or table entity name (if found) for which children are found. It returns null if no children are found, in which case it should be safe to delete the record.

Parameters:

dc -

schemaName -

instance -

Returns:

Throws:

Exception

filter

@Nonnull
public static <X,T extends Collection<X>> List<X> filter(@Nonnull
                                                                  T in,
                                                                  @Nonnull
                                                                  QCriteria<X> query)
                                                           throws Exception

Return a new list which contains only the items in the input list that are obeying the specified criteria.

Parameters:

in -

query -

Returns:

Throws:

Exception