org.codehaus.griffon.runtime.core.mvc

Class AbstractMVCGroupManager

java.lang.Object

org.codehaus.griffon.runtime.core.mvc.AbstractMVCGroupManager

All Implemented Interfaces:

MVCGroupManager, MVCHandler

Direct Known Subclasses:

DefaultMVCGroupManager

public abstract class AbstractMVCGroupManager
extends Object
implements MVCGroupManager

Base implementation of the MVCGroupManager interface.

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ERROR_ARGS_NULL
protected static String	ERROR_CONFIG_NULL
protected static String	ERROR_CONFIGURATION_NULL
protected static String	ERROR_GROUP_NULL
protected static String	ERROR_MVCID_BLANK
protected static String	ERROR_MVCTYPE_BLANK

Constructor Summary

Constructors

Constructor and Description
AbstractMVCGroupManager(GriffonApplication application)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfiguration(MVCGroupConfiguration configuration)
protected void	addGroup(MVCGroup group)
MVCGroup	buildMVCGroup(Map<String,Object> args, String mvcType) Instantiates an MVC group of the specified type with additional variables.
MVCGroup	buildMVCGroup(Map<String,Object> args, String mvcType, String mvcId) Instantiates an MVC group of the specified type with a particular name.
protected abstract MVCGroup	buildMVCGroup(MVCGroupConfiguration configuration, String mvcId, Map<String,Object> args)
MVCGroup	buildMVCGroup(String mvcType) Instantiates an MVC group of the specified type.
MVCGroup	buildMVCGroup(String mvcType, Map<String,Object> args) Instantiates an MVC group of the specified type with additional variables.
MVCGroup	buildMVCGroup(String mvcType, String mvcId) Instantiates an MVC group of the specified type with a particular name.
MVCGroup	buildMVCGroup(String mvcType, String mvcId, Map<String,Object> args) Instantiates an MVC group of the specified type with a particular name.
MVCGroupConfiguration	cloneMVCGroupConfiguration(String mvcType, Map<String,Object> config) Clones an existing MVCGroupConfiguration, optionally overriding additional config values.
List<? extends GriffonMvcArtifact>	createMVCGroup(Map<String,Object> args, String mvcType) Instantiates an MVC group of the specified type with additional variables.
List<? extends GriffonMvcArtifact>	createMVCGroup(Map<String,Object> args, String mvcType, String mvcId) Instantiates an MVC group of the specified type with a particular name.
protected List<? extends GriffonMvcArtifact>	createMVCGroup(MVCGroupConfiguration configuration, String mvcId, Map<String,Object> args)
List<? extends GriffonMvcArtifact>	createMVCGroup(String mvcType) Instantiates an MVC group of the specified type returning only the MVC parts.
List<? extends GriffonMvcArtifact>	createMVCGroup(String mvcType, Map<String,Object> args) Instantiates an MVC group of the specified type with additional variables.
List<? extends GriffonMvcArtifact>	createMVCGroup(String mvcType, String mvcId) Instantiates an MVC group of the specified type with a particular name.
List<? extends GriffonMvcArtifact>	createMVCGroup(String mvcType, String mvcId, Map<String,Object> args) Instantiates an MVC group of the specified type with a particular name.
protected abstract void	doInitialize(Map<String,MVCGroupConfiguration> configurations)
MVCGroupConfiguration	findConfiguration(String mvcType)
MVCGroup	findGroup(String mvcId)
GriffonApplication	getApplication()
MVCGroup	getAt(String mvcId)
Map<String,MVCGroupConfiguration>	getConfigurations()
Map<String,? extends GriffonController>	getControllers() Returns all currently available controller instances, keyed by group name.
Map<String,MVCGroup>	getGroups()
Map<String,? extends GriffonModel>	getModels() Returns all currently available model instances, keyed by group name.
Map<String,? extends GriffonView>	getViews() Returns all currently available view instances, keyed by group name.
void	initialize(Map<String,MVCGroupConfiguration> configurations) Initializes this manager with the group configurations provided by the application and addons.
void	removeConfiguration(MVCGroupConfiguration configuration)
void	removeConfiguration(String name)
protected void	removeGroup(MVCGroup group)
<M extends GriffonModel,V extends GriffonView,C extends GriffonController> void	withMVCGroup(Map<String,Object> args, String mvcType, MVCCallable<M,V,C> handler) Instantiates an MVC group of the specified type then destroys it after it has been handled.
<M extends GriffonModel,V extends GriffonView,C extends GriffonController> void	withMVCGroup(Map<String,Object> args, String mvcType, String mvcId, MVCCallable<M,V,C> handler) Instantiates an MVC group of the specified type then destroys it after it has been handled.
protected <M extends GriffonModel,V extends GriffonView,C extends GriffonController> void	withMVCGroup(MVCGroupConfiguration configuration, String mvcId, Map<String,Object> args, MVCCallable<M,V,C> handler)
<M extends GriffonModel,V extends GriffonView,C extends GriffonController> void	withMVCGroup(String mvcType, Map<String,Object> args, MVCCallable<M,V,C> handler) Instantiates an MVC group of the specified type then destroys it after it has been handled.
<M extends GriffonModel,V extends GriffonView,C extends GriffonController> void	withMVCGroup(String mvcType, MVCCallable<M,V,C> handler) Instantiates an MVC group of the specified type then destroys it after it has been handled.
<M extends GriffonModel,V extends GriffonView,C extends GriffonController> void	withMVCGroup(String mvcType, String mvcId, Map<String,Object> args, MVCCallable<M,V,C> handler) Instantiates an MVC group of the specified type then destroys it after it has been handled.
<M extends GriffonModel,V extends GriffonView,C extends GriffonController> void	withMVCGroup(String mvcType, String mvcId, MVCCallable<M,V,C> handler) Instantiates an MVC group of the specified type then destroys it after it has been handled.

Methods inherited from class java.lang.Object

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

Methods inherited from interface griffon.core.mvc.MVCGroupManager

newMVCGroup, newMVCGroupConfiguration

Methods inherited from interface griffon.core.mvc.MVCHandler

destroyMVCGroup

Field Detail

ERROR_MVCTYPE_BLANK

protected static final String ERROR_MVCTYPE_BLANK

See Also:

Constant Field Values

ERROR_MVCID_BLANK

protected static final String ERROR_MVCID_BLANK

See Also:

Constant Field Values

ERROR_CONFIGURATION_NULL

protected static final String ERROR_CONFIGURATION_NULL

See Also:

Constant Field Values

ERROR_GROUP_NULL

protected static final String ERROR_GROUP_NULL

See Also:

Constant Field Values

ERROR_CONFIG_NULL

protected static final String ERROR_CONFIG_NULL

See Also:

Constant Field Values

ERROR_ARGS_NULL

protected static final String ERROR_ARGS_NULL

See Also:

Constant Field Values

Constructor Detail

AbstractMVCGroupManager

@Inject
public AbstractMVCGroupManager(@Nonnull
                              GriffonApplication application)

Method Detail

getApplication

public GriffonApplication getApplication()

Specified by:

getApplication in interface MVCGroupManager

getConfigurations

@Nonnull
public Map<String,MVCGroupConfiguration> getConfigurations()

Specified by:

getConfigurations in interface MVCGroupManager

getGroups

@Nonnull
public Map<String,MVCGroup> getGroups()

Specified by:

getGroups in interface MVCGroupManager

findConfiguration

@Nonnull
public MVCGroupConfiguration findConfiguration(@Nonnull
                                              String mvcType)

Specified by:

findConfiguration in interface MVCGroupManager

findGroup

@Nullable
public MVCGroup findGroup(@Nonnull
                          String mvcId)

Specified by:

findGroup in interface MVCGroupManager

getAt

@Nullable
public MVCGroup getAt(@Nonnull
                      String mvcId)

Specified by:

getAt in interface MVCGroupManager

initialize

public final void initialize(@Nonnull
              Map<String,MVCGroupConfiguration> configurations)

Description copied from interface: MVCGroupManager

Initializes this manager with the group configurations provided by the application and addons.

Specified by:

initialize in interface MVCGroupManager

Parameters:

configurations - available group configurations

addConfiguration

public void addConfiguration(@Nonnull
                    MVCGroupConfiguration configuration)

Specified by:

addConfiguration in interface MVCGroupManager

removeConfiguration

public void removeConfiguration(@Nonnull
                       MVCGroupConfiguration configuration)

Specified by:

removeConfiguration in interface MVCGroupManager

removeConfiguration

public void removeConfiguration(@Nonnull
                       String name)

Specified by:

removeConfiguration in interface MVCGroupManager

addGroup

protected void addGroup(@Nonnull
            MVCGroup group)

removeGroup

protected void removeGroup(@Nonnull
               MVCGroup group)

getModels

@Nonnull
public final Map<String,? extends GriffonModel> getModels()

Description copied from interface: MVCGroupManager

Returns all currently available model instances, keyed by group name.

Specified by:

getModels in interface MVCGroupManager

Returns:

a Map of all currently instantiated models.

getViews

@Nonnull
public final Map<String,? extends GriffonView> getViews()

Description copied from interface: MVCGroupManager

Returns all currently available view instances, keyed by group name.

Specified by:

getViews in interface MVCGroupManager

Returns:

a Map of all currently instantiated views.

getControllers

@Nonnull
public final Map<String,? extends GriffonController> getControllers()

Description copied from interface: MVCGroupManager

Returns all currently available controller instances, keyed by group name.

Specified by:

getControllers in interface MVCGroupManager

Returns:

a Map of all currently instantiated controllers.

cloneMVCGroupConfiguration

@Nonnull
public MVCGroupConfiguration cloneMVCGroupConfiguration(@Nonnull
                                                       String mvcType,
                                                       @Nonnull
                                                       Map<String,Object> config)

Description copied from interface: MVCGroupManager

Clones an existing MVCGroupConfiguration, optionally overriding additional config values.

Specified by:

cloneMVCGroupConfiguration in interface MVCGroupManager

Parameters:

mvcType - the name of the configuration to clone

config - additional config parameters to be set on the configuration

Returns:

a ready-to-use MVCGroupConfiguration instance

createMVCGroup

@Nonnull
protected List<? extends GriffonMvcArtifact> createMVCGroup(@Nonnull
                                                        MVCGroupConfiguration configuration,
                                                        @Nullable
                                                        String mvcId,
                                                        @Nonnull
                                                        Map<String,Object> args)

withMVCGroup

protected <M extends GriffonModel,V extends GriffonView,C extends GriffonController> void withMVCGroup(@Nonnull
                                                                                           MVCGroupConfiguration configuration,
                                                                                           @Nullable
                                                                                           String mvcId,
                                                                                           @Nonnull
                                                                                           Map<String,Object> args,
                                                                                           @Nonnull
                                                                                           MVCCallable<M,V,C> handler)

buildMVCGroup

@Nonnull
protected abstract MVCGroup buildMVCGroup(@Nonnull
                             MVCGroupConfiguration configuration,
                             @Nullable
                             String mvcId,
                             @Nonnull
                             Map<String,Object> args)

doInitialize

protected abstract void doInitialize(@Nonnull
                Map<String,MVCGroupConfiguration> configurations)

buildMVCGroup

@Nonnull
public MVCGroup buildMVCGroup(@Nonnull
                             String mvcType)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
 }
 

An instance of the "foo" group can be created as follows

 Map fooGroup = buildMVCGroup('foo')
 assert (fooGroup.controller instanceof FooController)
 

Specified by:

buildMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

Returns:

an MVCGroup instance of the desired type

buildMVCGroup

@Nonnull
public MVCGroup buildMVCGroup(@Nonnull
                             String mvcType,
                             @Nonnull
                             String mvcId)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type with a particular name.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
 }
 

An instance of the "foo" group can be created as follows

 Map fooGroup = buildMVCGroup('foo', 'foo' + System.currentTimeMillis())
 assert (fooGroup.controller instanceof FooController)
 

MVC groups must have an unique name.

Specified by:

buildMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

mvcId - the name to assign to the built group.

Returns:

an MVCGroup instance of the desired type

buildMVCGroup

@Nonnull
public MVCGroup buildMVCGroup(@Nonnull
                             Map<String,Object> args,
                             @Nonnull
                             String mvcType)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type with additional variables.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
     'bar' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.BarView'
         controller = 'com.acme.BarController'
     }
 }
 

Notice that groups "foo" and "bar share the same model type, We can make them share the same model instance by creating the groups in the following way:

 Map fooGroup = buildMVCGroup('foo')
 Map barGroup = buildMVCGroup('bar', model: fooGroup.model)
 assert fooGroup.model == barGroup.model
 

Specified by:

buildMVCGroup in interface MVCHandler

Parameters:

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

mvcType - the type of group to build.

Returns:

an MVCGroup instance of the desired type

buildMVCGroup

@Nonnull
public MVCGroup buildMVCGroup(@Nonnull
                             String mvcType,
                             @Nonnull
                             Map<String,Object> args)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type with additional variables.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
     'bar' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.BarView'
         controller = 'com.acme.BarController'
     }
 }
 

Notice that groups "foo" and "bar share the same model type, We can make them share the same model instance by creating the groups in the following way:

 Map fooGroup = buildMVCGroup('foo')
 Map barGroup = buildMVCGroup('bar', model: fooGroup.model)
 assert fooGroup.model == barGroup.model
 

Specified by:

buildMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

Returns:

an MVCGroup instance of the desired type

buildMVCGroup

@Nonnull
public MVCGroup buildMVCGroup(@Nonnull
                             Map<String,Object> args,
                             @Nonnull
                             String mvcType,
                             @Nonnull
                             String mvcId)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type with a particular name.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
 }
 

We can create two instances of the same group that share the same model instance in the following way:

 Map fooGroup1 = buildMVCGroup('foo', 'foo1')
 Map fooGroup2 = buildMVCGroup('bar', 'foo2', model: fooGroup1.model)
 assert fooGroup1.model == fooGroup2.model
 

MVC groups must have an unique name.

Specified by:

buildMVCGroup in interface MVCHandler

Parameters:

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

mvcType - the type of group to build.

mvcId - the name to assign to the built group.

Returns:

an MVCGroup instance of the desired type

buildMVCGroup

@Nonnull
public MVCGroup buildMVCGroup(@Nonnull
                             String mvcType,
                             @Nonnull
                             String mvcId,
                             @Nonnull
                             Map<String,Object> args)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type with a particular name.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
 }
 

We can create two instances of the same group that share the same model instance in the following way:

 Map fooGroup1 = buildMVCGroup('foo', 'foo1')
 Map fooGroup2 = buildMVCGroup('bar', 'foo2', model: fooGroup1.model)
 assert fooGroup1.model == fooGroup2.model
 

MVC groups must have an unique name.

Specified by:

buildMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

mvcId - the name to assign to the built group.

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

Returns:

an MVCGroup instance of the desired type

createMVCGroup

@Nonnull
public List<? extends GriffonMvcArtifact> createMVCGroup(@Nonnull
                                                        String mvcType)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type returning only the MVC parts.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
 }
 

An instance of the "foo" group can be created as follows

 def (m, v, c) = createMVCGroup('foo')
 assert (c instanceof FooController)
 

Specified by:

createMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

Returns:

a List with the canonical MVC members of the group

createMVCGroup

@Nonnull
public List<? extends GriffonMvcArtifact> createMVCGroup(@Nonnull
                                                        Map<String,Object> args,
                                                        @Nonnull
                                                        String mvcType)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type with additional variables.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
     'bar' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.BarView'
         controller = 'com.acme.BarController'
     }
 }
 

Notice that groups "foo" and "bar share the same model type, We can make them share the same model instance by creating the groups in the following way:

 def (m1, v1, c1) = createMVCGroup('foo')
 def (m2, v2, c2) = createMVCGroup('bar', model: m1)
 assert fm1 == m2
 

Specified by:

createMVCGroup in interface MVCHandler

Parameters:

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

mvcType - the type of group to build.

Returns:

a List with the canonical MVC members of the group

createMVCGroup

@Nonnull
public List<? extends GriffonMvcArtifact> createMVCGroup(@Nonnull
                                                        String mvcType,
                                                        @Nonnull
                                                        Map<String,Object> args)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type with additional variables.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
     'bar' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.BarView'
         controller = 'com.acme.BarController'
     }
 }
 

Notice that groups "foo" and "bar share the same model type, We can make them share the same model instance by creating the groups in the following way:

 def (m1, v1, c1) = createMVCGroup('foo')
 def (m2, v2, c2) = createMVCGroup('bar', model: m1)
 assert fm1 == m2
 

Specified by:

createMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

Returns:

a List with the canonical MVC members of the group

createMVCGroup

@Nonnull
public List<? extends GriffonMvcArtifact> createMVCGroup(@Nonnull
                                                        String mvcType,
                                                        @Nonnull
                                                        String mvcId)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type with a particular name.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
      }
 }
 

An instance of the "foo" group can be created as follows

 def (m, v, c) = createMVCGroup('foo', 'foo' + System.currenttimeMillis())
 assert (c instanceof FooController)
 

MVC groups must have an unique name.

Specified by:

createMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

mvcId - the name to assign to the built group.

Returns:

a List with the canonical MVC members of the group

createMVCGroup

@Nonnull
public List<? extends GriffonMvcArtifact> createMVCGroup(@Nonnull
                                                        Map<String,Object> args,
                                                        @Nonnull
                                                        String mvcType,
                                                        @Nonnull
                                                        String mvcId)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type with a particular name.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
 }
 

We can create two instances of the same group that share the same model instance in the following way:

 def (m1, v1, c1) = createMVCGroup('foo', 'foo1')
 def (m2, v2, c2) = createMVCGroup('foo', 'foo2', model: m1)
 assert fm1 == m2
 

MVC groups must have an unique name.

Specified by:

createMVCGroup in interface MVCHandler

Parameters:

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

mvcType - the type of group to build.

mvcId - the name to assign to the built group.

Returns:

a List with the canonical MVC members of the group

createMVCGroup

@Nonnull
public List<? extends GriffonMvcArtifact> createMVCGroup(@Nonnull
                                                        String mvcType,
                                                        @Nonnull
                                                        String mvcId,
                                                        @Nonnull
                                                        Map<String,Object> args)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type with a particular name.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
 }
 

We can create two instances of the same group that share the same model instance in the following way:

 def (m1, v1, c1) = createMVCGroup('foo', 'foo1')
 def (m2, v2, c2) = createMVCGroup('foo', 'foo2', model: m1)
 assert fm1 == m2
 

MVC groups must have an unique name.

Specified by:

createMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

mvcId - the name to assign to the built group.

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

Returns:

a List with the canonical MVC members of the group

withMVCGroup

public <M extends GriffonModel,V extends GriffonView,C extends GriffonController> void withMVCGroup(@Nonnull
                                                                                           String mvcType,
                                                                                           @Nonnull
                                                                                           MVCCallable<M,V,C> handler)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type then destroys it after it has been handled.

This method is of particular interest when working with short lived MVC groups such as those used to build dialogs.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
    }
 }
 

An instance of the "foo" group can be used as follows

 withMVCGroup("foo", new MVCCallable<FooModel, FooView, FooController>() {
     public void call(FooModel m, FooView v, FooController c) {
         m.setSomeProperty(someValue);
         c.invokeAnAction();
     }
 });
 

Specified by:

withMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

handler - a code block used to configure and manage the instantiated group

withMVCGroup

public <M extends GriffonModel,V extends GriffonView,C extends GriffonController> void withMVCGroup(@Nonnull
                                                                                           String mvcType,
                                                                                           @Nonnull
                                                                                           String mvcId,
                                                                                           @Nonnull
                                                                                           MVCCallable<M,V,C> handler)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type then destroys it after it has been handled.

This method is of particular interest when working with short lived MVC groups such as those used to build dialogs.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
 }
 

An instance of the "foo" group can be used as follows

 withMVCGroup("foo", "foo1", new MVCCallable<FooModel, FooView, FooController>() {
     public void call(FooModel m, FooView v, FooController c) {
         m.setSomeProperty(someValue);
         c.invokeAnAction();
     }
 });
 

MVC groups must have an unique name.

Specified by:

withMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

mvcId - the name to assign to the built group.

handler - a code block used to configure and manage the instantiated group

withMVCGroup

public <M extends GriffonModel,V extends GriffonView,C extends GriffonController> void withMVCGroup(@Nonnull
                                                                                           String mvcType,
                                                                                           @Nonnull
                                                                                           String mvcId,
                                                                                           @Nonnull
                                                                                           Map<String,Object> args,
                                                                                           @Nonnull
                                                                                           MVCCallable<M,V,C> handler)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type then destroys it after it has been handled.

This method is of particular interest when working with short lived MVC groups such as those used to build dialogs.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.
For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
 }
 

An instance of the "foo" group can be used as follows

 Map map = ... // initialized elsewhere
 withMVCGroup("foo", "foo1", map, new MVCCallable<FooModel, FooView, FooController>() {
    public void call(FooModel m, FooView v, FooController c) {
        m.setSomeProperty(someValue);
        c.invokeAnAction();
    }
 });
 

MVC groups must have an unique name.

Specified by:

withMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

mvcId - the name to assign to the built group.

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

handler - a code block used to configure and manage the instantiated group

withMVCGroup

public <M extends GriffonModel,V extends GriffonView,C extends GriffonController> void withMVCGroup(@Nonnull
                                                                                           Map<String,Object> args,
                                                                                           @Nonnull
                                                                                           String mvcType,
                                                                                           @Nonnull
                                                                                           String mvcId,
                                                                                           @Nonnull
                                                                                           MVCCallable<M,V,C> handler)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type then destroys it after it has been handled.

This method is of particular interest when working with short lived MVC groups such as those used to build dialogs.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.
For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
     }
 }
 

An instance of the "foo" group can be used as follows

 Map map = ... // initialized elsewhere
 withMVCGroup("foo", "foo1", map, new MVCCallable<FooModel, FooView, FooController>() {
    public void call(FooModel m, FooView v, FooController c) {
        m.setSomeProperty(someValue);
        c.invokeAnAction();
    }
 });
 

MVC groups must have an unique name.

Specified by:

withMVCGroup in interface MVCHandler

Parameters:

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

mvcType - the type of group to build.

mvcId - the name to assign to the built group.

handler - a code block used to configure and manage the instantiated group

withMVCGroup

public <M extends GriffonModel,V extends GriffonView,C extends GriffonController> void withMVCGroup(@Nonnull
                                                                                           String mvcType,
                                                                                           @Nonnull
                                                                                           Map<String,Object> args,
                                                                                           @Nonnull
                                                                                           MVCCallable<M,V,C> handler)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type then destroys it after it has been handled.

This method is of particular interest when working with short lived MVC groups such as those used to build dialogs.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.
For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
    }
 }
 

An instance of the "foo" group can be used as follows

 Map map = ... // initialized elsewhere
 withMVCGroup("foo", map, new MVCCallable<FooModel, FooView, FooController>() {
    public void call(FooModel m, FooView v, FooController c) {
        m.setSomeProperty(someValue);
        c.invokeAnAction();
    }
 });
 

Specified by:

withMVCGroup in interface MVCHandler

Parameters:

mvcType - the type of group to build.

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

handler - a code block used to configure and manage the instantiated group

withMVCGroup

public <M extends GriffonModel,V extends GriffonView,C extends GriffonController> void withMVCGroup(@Nonnull
                                                                                           Map<String,Object> args,
                                                                                           @Nonnull
                                                                                           String mvcType,
                                                                                           @Nonnull
                                                                                           MVCCallable<M,V,C> handler)

Description copied from interface: MVCHandler

Instantiates an MVC group of the specified type then destroys it after it has been handled.

This method is of particular interest when working with short lived MVC groups such as those used to build dialogs.

MVC Groups must be previously configured with the application's metadata before they can be used. This registration process usually takes place automatically at boot time. The type of the group can be normally found in the application's configuration file.

The args Map can contain any value that will be used in one of the following scenarios

• The key matches a member definition; the value will be used as the instance of such member.
• The key does not match a member definition, the value is assumed to be a property that can be set on any MVC member of the group.
For example, with the following entry available in Application.groovy

 mvcGroups {
     'foo' {
         model      = 'com.acme.FooModel'
         view       = 'com.acme.FooView'
         controller = 'com.acme.FooController'
    }
 }
 

An instance of the "foo" group can be used as follows

 Map map = ... // initialized elsewhere
 withMVCGroup("foo", map, new MVCCallable<FooModel, FooView, FooController>() {
    public void call(FooModel m, FooView v, FooController c) {
        m.setSomeProperty(someValue);
        c.invokeAnAction();
    }
 });
 

Specified by:

withMVCGroup in interface MVCHandler

Parameters:

args - any useful values that can be set as properties on each MVC member or that identify a member that can be shared with other groups.

mvcType - the type of group to build.

handler - a code block used to configure and manage the instantiated group