oracle.adfdt.view.common.binding.registration

Class DatabindingPatternRegistration

java.lang.Object

oracle.adfdt.view.common.binding.registration.DatabindingPatternRegistration

public final class DatabindingPatternRegistration
extends java.lang.Object

Main entry point for registration of patterns configuration files, model providers, and other related entities of the ADF databinding pattern framework. This registration also allows for some customization in the way the entities are registered. For instance, to restrict the type of patterns are to be registered via their properties, the caller can do the following: DatabindingPatternRegistration.create(<source>) .withoutPatternProperties("foo", "bar") .register(); This is a convenience class used primarily to register many patterns and model providers using the same restrictions. Some convenience functions pass through information to the RegistrationConfiguration although this object can be retrieved directly and manipulated prior to the register() call. If the same RegistrationConfiguration is to be used for all patterns, then using: DatabindingFrameworkRegistration.setDefaultRegistrationConfiguration(...) is an option.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabindingPatternRegistration.Source The registration source for a set of patterns and related model providers.

Method Summary

Modifier and Type	Method and Description
static DatabindingPatternRegistration	create(DatabindingPatternRegistration.Source source) Creates a new regisration for the databinding pattern framework.
void	deregister() Deregisters the source.
RegistrationConfiguration	getRegistrationConfiguration() Returns the RegistrationConfiguration to be used in the register call if a more fine grained approach is required.
void	register() Registers all entities as determined by the source.
DatabindingPatternRegistration	withClassLoader(java.lang.ClassLoader classLoader) Tells the registration to use the given classloader.
DatabindingPatternRegistration	withoutPatternProperties(java.lang.String... properties) Tells the registration to only register patterns not containing the properties listed.
DatabindingPatternRegistration	withPatternProperties(java.lang.String... properties) Tells the registration to only register patterns containing the properties listed.
DatabindingPatternRegistration	withRegistrationConfiguration(RegistrationConfiguration config) Replaces the registration configuration with the given one.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DatabindingPatternRegistration create(DatabindingPatternRegistration.Source source)

Creates a new regisration for the databinding pattern framework. The registration will not occur until register() is called.

Parameters:

source - databindng pattern registration source

Returns:

databindin pattern registration

withClassLoader

public DatabindingPatternRegistration withClassLoader(java.lang.ClassLoader classLoader)

Tells the registration to use the given classloader.

Parameters:

classLoader - class loader to use for databinding pattern registration

Returns:

databinding pattern registration

withPatternProperties

public DatabindingPatternRegistration withPatternProperties(java.lang.String... properties)

Tells the registration to only register patterns containing the properties listed.

Parameters:

properties - property strings

Returns:

databinding pattern registration

withoutPatternProperties

public DatabindingPatternRegistration withoutPatternProperties(java.lang.String... properties)

Tells the registration to only register patterns not containing the properties listed.

Parameters:

properties - property strings

Returns:

databinding pattern registration

withRegistrationConfiguration

public DatabindingPatternRegistration withRegistrationConfiguration(RegistrationConfiguration config)

Replaces the registration configuration with the given one. This will completely erase all prior configuration options.

Parameters:

config - registration configuration

Returns:

databinding pattern registration

getRegistrationConfiguration

public RegistrationConfiguration getRegistrationConfiguration()

Returns the RegistrationConfiguration to be used in the register call if a more fine grained approach is required.

Returns:

registration configuration

register

public void register()

Registers all entities as determined by the source. A source must only be registered once, subsequent tries will lead to an exception. All configurations must occur before register() is called.

deregister

public void deregister()

Deregisters the source. This call is idempotent.