org.jminor.framework.domain.property

Class Properties

java.lang.Object

org.jminor.framework.domain.property.Properties

public final class Properties
extends java.lang.Object

A Property factory class.

Method Summary

Modifier and Type	Method and Description
static ColumnProperty.Builder	auditInsertTimeProperty(java.lang.String propertyId)
static ColumnProperty.Builder	auditInsertTimeProperty(java.lang.String propertyId, java.lang.String caption)
static ColumnProperty.Builder	auditInsertUserProperty(java.lang.String propertyId)
static ColumnProperty.Builder	auditInsertUserProperty(java.lang.String propertyId, java.lang.String caption)
static ColumnProperty.Builder	auditUpdateTimeProperty(java.lang.String propertyId)
static ColumnProperty.Builder	auditUpdateTimeProperty(java.lang.String propertyId, java.lang.String caption)
static ColumnProperty.Builder	auditUpdateUserProperty(java.lang.String propertyId)
static ColumnProperty.Builder	auditUpdateUserProperty(java.lang.String propertyId, java.lang.String caption)
static ColumnProperty.Builder	booleanProperty(java.lang.String propertyId, int columnType, java.lang.Object trueValue, java.lang.Object falseValue)
static ColumnProperty.Builder	booleanProperty(java.lang.String propertyId, int columnType, java.lang.String caption, java.lang.Object trueValue, java.lang.Object falseValue)
static <T> ValueConverter<java.lang.Boolean,T>	booleanValueConverter(T trueValue, T falseValue)
static ColumnProperty.Builder	columnProperty(java.lang.String propertyId)
static ColumnProperty.Builder	columnProperty(java.lang.String propertyId, int type)
static ColumnProperty.Builder	columnProperty(java.lang.String propertyId, int type, java.lang.String caption)
static Property.Builder	denormalizedProperty(java.lang.String propertyId, java.lang.String foreignKeyPropertyId, Property denormalizedProperty)
static Property.Builder	denormalizedProperty(java.lang.String propertyId, java.lang.String foreignKeyPropertyId, Property denormalizedProperty, java.lang.String caption)
static TransientProperty.Builder	denormalizedViewProperty(java.lang.String propertyId, java.lang.String foreignKeyPropertyId, Property property, java.lang.String caption)
static TransientProperty.Builder	derivedProperty(java.lang.String propertyId, int type, java.lang.String caption, DerivedProperty.Provider valueProvider, java.lang.String... linkedPropertyIds)
static ForeignKeyProperty.Builder	foreignKeyProperty(java.lang.String propertyId, java.lang.String caption, java.lang.String foreignEntityId, ColumnProperty.Builder columnPropertyBuilder) Instantiates a ForeignKeyProperty
static ForeignKeyProperty.Builder	foreignKeyProperty(java.lang.String propertyId, java.lang.String caption, java.lang.String foreignEntityId, java.util.List<ColumnProperty.Builder> columnPropertyBuilders) Instantiates a ForeignKeyProperty
static ColumnProperty.Builder	mirrorProperty(java.lang.String propertyId)
static ColumnProperty.Builder	primaryKeyProperty(java.lang.String propertyId)
static ColumnProperty.Builder	primaryKeyProperty(java.lang.String propertyId, int type)
static ColumnProperty.Builder	primaryKeyProperty(java.lang.String propertyId, int type, java.lang.String caption)
static java.util.List<Property>	sort(java.util.List<Property> properties) Sorts the given properties by caption, or if that is not available, property id, ignoring case
static ColumnProperty.Builder	subqueryProperty(java.lang.String propertyId, int type, java.lang.String caption, java.lang.String subquery)
static ColumnProperty.Builder	subqueryProperty(java.lang.String propertyId, int type, java.lang.String caption, java.lang.String subquery, int columnType)
static TransientProperty.Builder	transientProperty(java.lang.String propertyId, int type)
static TransientProperty.Builder	transientProperty(java.lang.String propertyId, int type, java.lang.String caption)
static ColumnProperty.Builder	valueListProperty(java.lang.String propertyId, int type, java.lang.String caption, java.util.List<Item> validItems)

Methods inherited from class java.lang.Object

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

Method Detail

columnProperty

public static ColumnProperty.Builder columnProperty(java.lang.String propertyId)

Parameters:

propertyId - the property ID

Returns:

a new column property

columnProperty

public static ColumnProperty.Builder columnProperty(java.lang.String propertyId,
                                                    int type)

Parameters:

propertyId - the property ID

type - the property type

Returns:

a new column property

columnProperty

public static ColumnProperty.Builder columnProperty(java.lang.String propertyId,
                                                    int type,
                                                    java.lang.String caption)

Parameters:

propertyId - the property ID

type - the property type

caption - the caption

Returns:

a new column property

primaryKeyProperty

public static ColumnProperty.Builder primaryKeyProperty(java.lang.String propertyId)

Parameters:

propertyId - the property ID

Returns:

a new primary key property with index 0

primaryKeyProperty

public static ColumnProperty.Builder primaryKeyProperty(java.lang.String propertyId,
                                                        int type)

Parameters:

propertyId - the property ID

type - the property type

Returns:

a new primary key property with index 0

primaryKeyProperty

public static ColumnProperty.Builder primaryKeyProperty(java.lang.String propertyId,
                                                        int type,
                                                        java.lang.String caption)

Parameters:

propertyId - the property ID

type - the property type

caption - the caption

Returns:

a new primary key property with index 0

foreignKeyProperty

public static ForeignKeyProperty.Builder foreignKeyProperty(java.lang.String propertyId,
                                                            java.lang.String caption,
                                                            java.lang.String foreignEntityId,
                                                            ColumnProperty.Builder columnPropertyBuilder)

Instantiates a ForeignKeyProperty

Parameters:

propertyId - the property ID

caption - the caption

foreignEntityId - the ID of the entity referenced by this foreign key

columnPropertyBuilder - the underlying column property comprising this foreign key

Returns:

a new foreign key property

foreignKeyProperty

public static ForeignKeyProperty.Builder foreignKeyProperty(java.lang.String propertyId,
                                                            java.lang.String caption,
                                                            java.lang.String foreignEntityId,
                                                            java.util.List<ColumnProperty.Builder> columnPropertyBuilders)

Instantiates a ForeignKeyProperty

Parameters:

propertyId - the property ID, note that this is not a column name

caption - the property caption

foreignEntityId - the ID of the entity referenced by this foreign key

columnPropertyBuilders - the underlying column properties comprising this foreign key

Returns:

a new foreign key property

denormalizedViewProperty

public static TransientProperty.Builder denormalizedViewProperty(java.lang.String propertyId,
                                                                 java.lang.String foreignKeyPropertyId,
                                                                 Property property,
                                                                 java.lang.String caption)

Parameters:

propertyId - the ID of the property, this should not be a column name since this property does not map to a table column

foreignKeyPropertyId - the ID of the foreign key property from which entity value this property gets its value

property - the property from which this property gets its value

caption - the caption of this property

Returns:

a new denormalized view property

derivedProperty

public static TransientProperty.Builder derivedProperty(java.lang.String propertyId,
                                                        int type,
                                                        java.lang.String caption,
                                                        DerivedProperty.Provider valueProvider,
                                                        java.lang.String... linkedPropertyIds)

Parameters:

propertyId - the property ID

type - the property type

caption - the caption

valueProvider - the object responsible for providing the derived value

linkedPropertyIds - the IDs of the properties on whose value this property derives its value

Returns:

a new derived property

Throws:

java.lang.IllegalArgumentException - in case no linked property IDs are provided

denormalizedProperty

public static Property.Builder denormalizedProperty(java.lang.String propertyId,
                                                    java.lang.String foreignKeyPropertyId,
                                                    Property denormalizedProperty)

Parameters:

propertyId - the property ID, in case of database properties this should be the underlying column name

foreignKeyPropertyId - the ID of the foreign key property which references the entity which owns the denormalized property

denormalizedProperty - the property from which this property should get its value

Returns:

a new denormalized property

denormalizedProperty

public static Property.Builder denormalizedProperty(java.lang.String propertyId,
                                                    java.lang.String foreignKeyPropertyId,
                                                    Property denormalizedProperty,
                                                    java.lang.String caption)

Parameters:

propertyId - the property ID, in case of database properties this should be the underlying column name

foreignKeyPropertyId - the ID of the foreign key property which references the entity which owns the denormalized property

denormalizedProperty - the property from which this property should get its value

caption - the caption if this property

Returns:

a new denormalized property

subqueryProperty

public static ColumnProperty.Builder subqueryProperty(java.lang.String propertyId,
                                                      int type,
                                                      java.lang.String caption,
                                                      java.lang.String subquery)

Parameters:

propertyId - the property ID, since SubqueryProperties do not map to underlying table columns, the property ID should not be column name, only be unique for this entity

type - the data type of this property

caption - the caption of this property

subquery - the sql query

Returns:

a new subquery property

subqueryProperty

public static ColumnProperty.Builder subqueryProperty(java.lang.String propertyId,
                                                      int type,
                                                      java.lang.String caption,
                                                      java.lang.String subquery,
                                                      int columnType)

Parameters:

propertyId - the property ID, since SubqueryProperties do not map to underlying table columns, the property ID should not be column name, only be unique for this entity

type - the data type of this property

caption - the caption of this property

subquery - the sql query

columnType - the actual column type

Returns:

a new subquery property

valueListProperty

public static ColumnProperty.Builder valueListProperty(java.lang.String propertyId,
                                                       int type,
                                                       java.lang.String caption,
                                                       java.util.List<Item> validItems)

Parameters:

propertyId - the property ID

type - the data type of this property

caption - the property caption

validItems - all allowed values for this property

Returns:

a new value list property

transientProperty

public static TransientProperty.Builder transientProperty(java.lang.String propertyId,
                                                          int type)

Parameters:

propertyId - the property ID, since TransientProperties do not map to underlying table columns, the property ID should not be column name, only be unique for this entity

type - the data type of this property

Returns:

a new transient property

transientProperty

public static TransientProperty.Builder transientProperty(java.lang.String propertyId,
                                                          int type,
                                                          java.lang.String caption)

Parameters:

propertyId - the property ID, since TransientProperties do not map to underlying table columns, the property ID should not be column name, only be unique for this entity

type - the data type of this property

caption - the caption of this property

Returns:

a new transient property

booleanProperty

public static ColumnProperty.Builder booleanProperty(java.lang.String propertyId,
                                                     int columnType,
                                                     java.lang.Object trueValue,
                                                     java.lang.Object falseValue)

Parameters:

propertyId - the property ID

columnType - the data type of the underlying column

trueValue - the value representing 'true' in the underlying column

falseValue - the value representing 'false' in the underlying column

Returns:

a new boolean property

booleanProperty

public static ColumnProperty.Builder booleanProperty(java.lang.String propertyId,
                                                     int columnType,
                                                     java.lang.String caption,
                                                     java.lang.Object trueValue,
                                                     java.lang.Object falseValue)

Parameters:

propertyId - the property ID

columnType - the data type of the underlying column

caption - the caption of this property

trueValue - the value representing 'true' in the underlying column

falseValue - the value representing 'false' in the underlying column

Returns:

a new boolean property

auditInsertTimeProperty

public static ColumnProperty.Builder auditInsertTimeProperty(java.lang.String propertyId)

Parameters:

propertyId - the property ID

Returns:

a new audit insert time property

auditInsertTimeProperty

public static ColumnProperty.Builder auditInsertTimeProperty(java.lang.String propertyId,
                                                             java.lang.String caption)

Parameters:

propertyId - the property ID

caption - the caption

Returns:

a new audit insert time property

auditUpdateTimeProperty

public static ColumnProperty.Builder auditUpdateTimeProperty(java.lang.String propertyId)

Parameters:

propertyId - the property ID

Returns:

a new audit update time property

auditUpdateTimeProperty

public static ColumnProperty.Builder auditUpdateTimeProperty(java.lang.String propertyId,
                                                             java.lang.String caption)

Parameters:

propertyId - the property ID

caption - the caption

Returns:

a new audit update time property

auditInsertUserProperty

public static ColumnProperty.Builder auditInsertUserProperty(java.lang.String propertyId)

Parameters:

propertyId - the property ID

Returns:

a new audit insert user property

auditInsertUserProperty

public static ColumnProperty.Builder auditInsertUserProperty(java.lang.String propertyId,
                                                             java.lang.String caption)

Parameters:

propertyId - the property ID

caption - the caption

Returns:

a new audit insert user property

auditUpdateUserProperty

public static ColumnProperty.Builder auditUpdateUserProperty(java.lang.String propertyId)

Parameters:

propertyId - the property ID

Returns:

a new audit update user property

auditUpdateUserProperty

public static ColumnProperty.Builder auditUpdateUserProperty(java.lang.String propertyId,
                                                             java.lang.String caption)

Parameters:

propertyId - the property ID

caption - the caption

Returns:

a new audit update user property

mirrorProperty

public static ColumnProperty.Builder mirrorProperty(java.lang.String propertyId)

Parameters:

propertyId - the property ID

Returns:

a new mirror property

booleanValueConverter

public static <T> ValueConverter<java.lang.Boolean,T> booleanValueConverter(T trueValue,
                                                                            T falseValue)

Type Parameters:

T - the type of the value used to represent a boolean

Parameters:

trueValue - the value used to represent 'true' in the underlying database, can be null

falseValue - the value used to represent 'false' in the underlying database, can be null

Returns:

a value converter which converts an underlying database representation of a boolean value into an actual Boolean

sort

public static java.util.List<Property> sort(java.util.List<Property> properties)

Sorts the given properties by caption, or if that is not available, property id, ignoring case

Parameters:

properties - the properties to sort

Returns:

the sorted list