computed

boolean

Forces a property to be considered as a computed property by the framework. A computed property will be completely ignored by the persistence layer and its management is left to the developer.

Properties declared with a delegate computing class are considered computed by default so there is no need to explicitely set them computed=true. However, there is sometimes a need to declare a property at some level (e.g. in an interface descriptor) and let lower level implementation decide how to handle this common property concretely (either computing it or handling it as a real persistent property). In that case, you can declare this property computed=true in the super type and refine the actual implementation (computed or not) in the sub-types.

Default value is false.

delegateClassName

String

Instructs the framework that this property is computed by a delegate attached to the owning component. The delegateClassName property must be set with the fully qualified class name of the delegate instance to use.

Delegate instances are stateful. This allows for some caching of computing intensive properties. There is exactly one delegate of a certain class per owning component instance. Delegate instances are lazily created when needed, i.e. whe the computed property is accessed either programmatically or by the binding layer.

The delegate class must implement the IComponentExtension<T> interface (where <T> is assignable from the owning component class) and provide a public constructor taking exactly 1 parameter : the component instance. Jspresso provides an adapter class to inherit from : AbstractComponentExtension<T>. This helper class provides the methods to access the enclosing component from the delegate implementation as well as the Spring context it comes from, when needed.

A delegate-computed property is most of the time read-only but it can be made writable by setting the property descriptor delegateWritable=true. In that case the delegate class must also provide a setter for the computed property.

delegateWritable

boolean

Instructs the framework that a delegate-computed property is writable. Most of the time, a computed property is read-only. Whenever a computed property is made writable through the use of delegateWritable=true, the delegate class must also provide a setter for the computed property.

Defult value is false.

grantedRoles

Collection​<​String​>​

Assigns the roles that are authorized to manipulate the property backed by this descriptor. It supports "!" prefix to negate the role(s). This will directly influence the UI behaviour and even composition (e.g. show/hide columns or fields). Setting the collection of granted roles to null (default value) disables role based authorization on this property level. Note that this authorization enforcement does not prevent programmatic access that is of the developer responsbility.

integrityProcessorBeanNames

List​<​String​>​

Registers a list of property processor instances that will be triggered on the different phases of the property modification, i.e. :

This property must be set with Spring bean names (i.e. Spring ids). When needed, Jspresso will query the Spring application context to retrieve the processor instances. This property is equivalent to setting integrityProcessorClassNames except that it allows to register processor instances that are configured externally in the Spring context.

Property processor instances must implement the IPropertyProcessor<E, F> interface where <E, F> represent respectively the type of the owning component and the type of the property. Since there are 3 methods to implement in the interface (1 for each of the phase described above), Jspresso provides an adapter class with empty implementations to override : EmptyPropertyProcessor<E, F>.

Whenever the underlying property is a collection property, the interface to implement is ICollectionPropertyProcessor<E, F> (or extend EmptyCollectionPropertyProcessor<E, F>) with 4 new phases introduced :

integrityProcessorClassNames

List​<​String​>​

Much the same as integrityProcessorBeanNames except that instead of providing a list of Spring bean names, you provide a list of fully qualified class names. These classes must :

When needed, Jspresso will create lifecycle interceptor instances.

mandatory

boolean

Declare a property as mandatory. This will enforce mandatory checks when the owning component is persisted as well as when the property is updated individually. Moreover, this information allows the views bound to the property to be configured accordingly, e.g. display the property with a slightly modified label indicating it is mandatory. This constraint is also enforced programmatically.

Default value is false.

name

String

Enforces its name to start with a lower case letter, following the JavaBean convention. So even if you name it "MyProperty", it will actually end up to "myProperty".

{@inheritDoc}

permId

String

A property permanent id is forced to be its name. Trying to set it to another value will raise an exception.

{@inheritDoc}

preferredWidth

Integer

This property allows for setting an indication of width for representing this property in a view.

Default value is null, so that the view factory will make its decision based on the type and/or other characteristics of the property (e.g. max length).

readOnly

boolean

Enforces a property to be read-only. This is only enforced at the UI level, i.e. the property can still be updated programmatically. The UI may take decisions like changing textfields into labels if it knows the underlying property is read-only.

sortable

boolean

Enforces a property sortability. This is only enforced at the UI level, i.e. the property can still be used for sorting programmatically.

sqlName

String

Instructs Jspresso to use this name when translating this property name to the data store namespace. This includes , but is not limited to, database column names.

Default value is null so that Jspresso uses its default naming policy.

unicityScope

String

Makes this property part of a unicity scope. All tuples of properties belonging to the same unicity scope are enforced to be unique in the component type scope. This concretely translates to unique constraints in the datastore spanning the properties composing the unicity scope.

Note that, for performance reasons, unicity scopes are only enforced by the persistence layer.

versionControl

boolean

This property allows to fine tune wether this component property participates in optimistic versioning. It mainly allows to declare some properties that should be ignored regarding optimistic versioning thus lowering the risk of version conflicts between concurrent users. Of course, this feature has to be used with care since it may generate phantom updates to the data store.

Default value is true so that any change in the described property increases the owning component version.

writabilityGates

Collection​<​IGate​>​

Assigns a collection of gates to determine property writability. A property will be considered writable if and only if all gates are open. This mecanism is mainly used for dynamic UI authorization based on model state, e.g. a validated invoice should not be editable anymore.

Descriptor assigned gates will be cloned for each property instance created and backed by this descriptor. So basically, each property instance will have its own, unshared collection of writability gates.

Jspresso provides a useful set of gate types, like the binary property gate that open/close based on the value of a boolean property of owning component.

By default, property descriptors are not assigned any gates collection, i.e. there is no writability restriction. Note that gates do not enforce programatic writability of a property; only UI is impacted.

composition

boolean

Instructs the framework that this property has to be treated as a composition, in the UML terminology. This implies that reachable entities that are referenced by this property follow the owning entity lifecycle. For instance, when the owning entity is deleted, the referenced entities in composition properties are also deleted.

Whenever this property is not explicitely set by the developer, Jspresso uses sensible defaults :

This property is strictly behavioural and does not impact the domain state itself.

fkName

String

Gives the developer the oportunity to customize the geneated foreign key (if any) name.

name

String

Assign reverse temp relation end if set.

{@inheritDoc}

reverseRelationEnd

IRelationship​End​Property​Descriptor

Allows to make a relationship bi-directional. By default, when a relationdhip end is defined, it is only navigable from the owning component to the described end (default value is null). Assigning a reverse relationship ends instructs the framework that the relationship is bi-derectional. This implies several complementary features :

Setting the reverse relation end operation is commmutative so that it automatically assigns bot ends as reverse, i.e. you only have to set the property on one side of the relationship.

manyToMany

boolean

Forces the collection property to be considered as a many to many ("N-N") end. When a relationship is bi-directional, setting both ends as being collection properties turns manyToMany=true automatically. But when the relationship is not bi-directional, Jspresso has no mean to determine if the collection property is "1-N" or "N-N". Setting this property allows to inform Jspresso about it.

Default value is false.

orderingProperties

Map​<​String​,?​>​

Ordering properties are used to sort this collection property if and only if it is un-indexed (not a List). The sort order set on the collection property can refine the default one that might have been set on the referenced collection level. This property consist of a Map whose entries are composed with :

Ordering properties are considered following their order in the map iterator. A null value (default) will not give any indication for the collection property sort order and thus, will delegate to higher specification levels (i.e. the referenced collection sort order).

referencedDescriptor

ICollection​Descriptor​<​E​>​

Qualifies the type of collection this property refers to. As of now, Jspresso supports :

fetchType

EFetch​Type

This property allows to finely tune fetching strategy of the ORM on this relationship end. This is either a value of the EFetchType enum or its equivalent string representation :

Default value is EFetchType.JOIN, i.e. 2nd select strategy.

initializationMapping

Map​<​String​,Object​>​

This property allows to pre-initialize UI filters that are based on this reference property. This includes :

The initialization mapping property is a Map keyed by referenced type property names (the properties to be initialized).

Values in this map can be either :

oneToOne

boolean

Forces the reference property to be considered as a one to one ("1-1") end. When a relationship is bi-directional, setting both ends as being reference properties turns oneToOne=true automatically. But when the relationship is not bi-directional, Jspresso has no mean to determine if the reference property is "N-1" or "1-1". Setting this property allows to inform Jspresso about it.

Default value is false.

pageSize

Integer

This property allows for defining the page size of "lists of values" that are built by the UI for this reference property. Whenever the pageSize property is set to null on the reference property level, Jspresso falls back to the element type default page size or turns off paging if the former is also not set.

queryableProperties

List​<​String​>​

This property allows to define which of the component properties are to be used in the list of value filter that are based on this component family. Since this is a List queriable properties are rendered in the same order.

Whenever this this property is null (default value), Jspresso chooses the default set of queryable properties based on the referenced component descriptor.

referencedDescriptor

IComponent​Descriptor​<​?​>​

Qualifies the type of element this property refers to. It may point to any type of component descriptor, i.e. entity, interface or component descriptor.

renderedProperties

List​<​String​>​

This property allows to define which of the component properties are to be rendered by default when displaying a list of value on this component family. For instance, a table will render 1 column per rendered property of the component. Any type of property can be used except collection properties. Since this is a List queriable properties are rendered in the same order.

Whenever this property is null (default value) Jspresso determines the default set of properties to render based on the referenced component descriptor.

collectionInterface

Class​<​?​>​

Allows to choose between the supported collection semantics. The incoming class property value must be one of :

Any other value is not supported and make the descriptor fall back to its default. A null value (default) is equivalent to setting java.util.Set. Alternatively, you can use descriptor sub-types, i.e. BasicSetDescriptor and BasicListDescriptor that make this property usage useless since they enforce their collection interface.

elementDescriptor

IComponent​Descriptor​<​?​>​

Describes the elements contained in this collection. It can be any of entity, interface or component descriptor.

orderingProperties

Map​<​String​,?​>​

Ordering properties are used to sort this collection if and only if it is un-indexed (not a List). The sort order set on the collection can refine the default one that might have been set on the element type level. This property consist of a Map whose entries are composed with :

Ordering properties are considered following their order in the map iterator. A null value (default) will not give any indication for the collection sort order and thus, will delegate to higher specification levels (e.g. the element type sort order).

defaultValue

Object

Sets the property default value. When a component owning this property is instanciated, its properties are initialized using their default values. By default, a property default value is null.

This incoming value can be either the actual property default value (as an Object) or its string representation whose parsing will be delegated to the property descriptor.

enumerationName

String

This property allows to customize the i18n keys used to translate the enumeration values, thus keeping the actual values shorter. For instance consider the gender enumeration, composed of the M (for "Male") and F (for "Female") values. Setting an enumeration name to "GENDER" will instruct Jspresso to look for translations named "GENDER_M" and "GENDER_F". This would allow for using M and F in other enumeration domains with different semantics and translations.

maxLength

Integer

Sets the maxLength.

values

List​<​String​>​

Defines the list of values this enumeration contains.

Enumeration values are translated in the UI using the following scheme : [enumerationName]_[value].

valuesAndIconImageUrls

Map​<​String​,String​>​

Defines the list of values as well as an icon image URL per value this enumeration contains. The incoming Map is keyed by the actual enumeration values and valued by the icon image URLs.

Enumeration values are translated in the UI using the following scheme : [enumerationName]_[value].

componentDescriptors

List​<​IComponent​Descriptor​>​

Registers the list of component descriptors to build the enumeration values/icons from their names and icons.

maxValue

Integer

The enumeration maximum bound. Default value is 10.

minValue

Integer

The enumeration minimum bound. Default value is 0.

rangeStep

Integer

The step to use for constructing the enumeration values, starting from minValue up to maxValue. Default value is 1.

contentType

String

Configures the default content type to use when downloading the property content as a file.

fileFilter

Map​<​String​,List​>​

This property allows to configure the file filter that has to be displayed whenever a file system operation is initiated from the UI to operate on this property. This includes :

Jspresso provides built-in actions that do the above and configure their UI automatically based on the fileFilter property.

The incoming Map must be structured like following :

fileName

String

Configures the default file name to use when downloading the property content as a file.

maxLength

Integer

Sets the max size (in bytes) of the property value.

secondsAware

boolean

Should this time information include seconds.

timeZoneAware

boolean

Sets wether this date property should have its string representation vary depending on the client timezone.

Default value is false, meaning that the date is considered as a string. It is in fact expressed in the server timezone.

type

EDate​Type

Sets wether this property should contain time information or not. The incoming value must be part of the EDateType enum, i.e. :

Default value is EDateType.DATE.

maxMillis

Long

Configures the maximum duration value this property accepts in milliseconds. Default value is null, meaning unbound.

maxValue

Big​Decimal

Configures the upper bound of the allowed values. Default value is null, meaning unbound.

minValue

Big​Decimal

Configures the lower bound of the allowed values. Default value is null, meaning unbound.

maxFractionDigit

Integer

Configures the precision of the decimal property. Default value is null which means unlimited.

usingBigDecimal

boolean

Configures the property to be managed using java.math.BigDecimal. Default value is false which means java.lang.Double will be used.

usingLong

boolean

Configures the property to be managed using java.lang.Long. Default value is false which means java.lang.Integer will be used.

maxLength

Integer

Configures the maximum string length this property allows. Default value is null which means unlimited.

regexpPattern

String

Configures the regular expression pattern this string property allows. Default is null which means constraint free.

regexpPatternSample

String

Allows for providing a conforming sample for the regular expression pattern. This human-readable example is used when the end-user has to be notified that the incoming property value does not match the pattern constraint.

upperCase

boolean

This is a shortcut to implement the common use-case of handling upper-case only properties. all incoming values will be transformed to uppercase as if a property processor was registered to perform the transformation.

contentType

String

Configures the default content type to use when downloading the property content as a file.

fileFilter

Map​<​String​,List​>​

This property allows to configure the file filter that has to be displayed whenever a file system operation is initiated from the UI to operate on this property. This includes :

Jspresso provides built-in actions that do the above and configure their UI automatically based on the fileFilter property.

The incoming Map must be structured like following :

fileName

String

Configures the default file name to use when downloading the property content as a file.

language

String

Explicitely sets the language this sourcecode property should contain. This is only a hint fo Jspresso to configure the UI components accordingly to interact with this property.

secondsAware

boolean

Should this time information include seconds.