ConstrainedBean (RIFE API 1.6.1)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.uwyn.rife.site
Class ConstrainedBean<T extends ConstrainedBean>

java.lang.Object
  com.uwyn.rife.site.ConstrainedBean<T>

public class ConstrainedBean<T extends ConstrainedBean>
extends Object
extends Object

A ConstrainedBean object makes it possible to define all constraints for a bean instance that are not related to a single property. The constraints here are global for the entire bean and either involve several properties or are even totally unrelated to properties.

It's possible to add constraints to a ConstrainedProperty instance through regular setters, but chainable setters are also available to make it possible to easily define a series of constraints, for example:

ConstrainedBean constrained = new ConstrainedBean()
    .unique("firstName", "lastName")
    .defaultOrder("city")
    .defaultOrder("lastName")
    .defaultOrder("firstName");

A constrained bean is typically added to a Constrained bean in its constructor. These are the static constraints that will be set for each and every instance of the bean. You'll however most of the time use the Validation abstract class that provides the activateValidation method which initializes the constraints on a need-to-have basis. This dramatically reduces memory usage since otherwise all constraints will be initialized for every bean instance, even though you don't use them.

Since:: 1.0
Version:: $Revision: 3669 $
Author:: Geert Bevin (gbevin[remove] at uwyn dot com)
See Also:: Constrained, ConstrainedProperty

Nested Class Summary
`static class`	`ConstrainedBean.Direction`
`static class`	`ConstrainedBean.Order`

Field Summary
`static ConstrainedBean.Direction`	`ASC`
`static String`	`ASSOCIATIONS`
`static String`	`DEFAULT_ORDERING`
`static ConstrainedBean.Direction`	`DESC`
`protected HashMap<String,Object>`	`mConstraints`
`static String`	`TEXTUAL_IDENTIFIER`
`static String`	`UNIQUE`

Constructor Summary
`ConstrainedBean()` Creates a new `ConstrainedBean`.

Method Summary
`T`	`associations(Class... associations)`
`T`	`defaultOrder(ConstrainedBean.Order order)`
`T`	`defaultOrder(String propertyName)`
`T`	`defaultOrder(String propertyName, ConstrainedBean.Direction direction)`
`T`	`defaultOrdering(List<ConstrainedBean.Order> ordering)`
`Class[]`	`getAssociations()`
`List<ConstrainedBean.Order>`	`getDefaultOrdering()`
`TextualIdentifierGenerator`	`getTextualIdentifier()`
`List<String[]>`	`getUniques()`
`boolean`	`hasAssociations()`
`boolean`	`hasDefaultOrdering()`
`boolean`	`hasTextualIdentifier()`
`boolean`	`hasUniques()`
`void`	`setAssociations(Class... associations)`
`void`	`setDefaultOrdering(List<ConstrainedBean.Order> ordering)`
`void`	`setTextualIdentifier(TextualIdentifierGenerator identifier)`
`void`	`setUniques(List<String[]> unique)`
`T`	`textualIdentifier(TextualIdentifierGenerator identifier)`
`T`	`unique(String... unique)`
`T`	`uniques(List<String[]> unique)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

ASC

public static final ConstrainedBean.Direction ASC

DESC

public static final ConstrainedBean.Direction DESC

ASSOCIATIONS

public static final String ASSOCIATIONS

See Also:: Constant Field Values

UNIQUE

public static final String UNIQUE

See Also:: Constant Field Values

TEXTUAL_IDENTIFIER

public static final String TEXTUAL_IDENTIFIER

See Also:: Constant Field Values

DEFAULT_ORDERING

public static final String DEFAULT_ORDERING

See Also:: Constant Field Values

mConstraints

protected HashMap<String,Object> mConstraints

Constructor Detail