Model Class / puremvc Library / Dart Documentation

Model Class

A PureMVC MultiCore IModel implementation.

In PureMVC, IModel implementors provide access to IProxy objects by named lookup.

An IModel assumes these responsibilities:

Maintain a cache of IProxy instances.
Provide methods for registering, retrieving, and removing IProxy instances.

Your application must register IProxy instances with the IModel. Typically, you use an ICommand to create and register IProxy instances once the IFacade has initialized the core actors.

See IProxy, IFacade

Implements

IModel

Constructors

Code new Model(String key) #

Constructor.

This IModel implementation is a Multiton, so you should not call the constructor directly, but instead call the static getInstance method.

Throws MultitonErrorModelExists if instance for this Multiton key instance has already been constructed.

Model( String key )
{      
  if ( instanceMap[ key ] != null ) throw new MultitonErrorModelExists();
  multitonKey = key;
  instanceMap[ multitonKey ] = this;
  proxyMap = new Map<String,IProxy>();    
  initializeModel();    
}

Static Methods

Code IModel getInstance(String key) #

IModel Multiton Factory method.

Returns the IModel Multiton instance for the specified key.

static IModel getInstance( String key ) 
{
  if ( key == null || key == "" ) return null;
  if ( instanceMap == null ) instanceMap = new Map<String,IModel>();
  if ( instanceMap[ key ] == null ) instanceMap[ key ] = new Model( key );
  return instanceMap[ key ];
}

Code void removeModel(String key) #

Remove an IModel instance.

Param key - the multitonKey of IModel instance to remove

static void removeModel( String key )
{
  instanceMap[ key ] = null;
}

Static Fields

Code Map<String, IModel> instanceMap #

static Map<String,IModel> instanceMap;

Methods

Code bool hasProxy(String proxyName) #

Check if an IProxy is registered with the IModel.

Param proxyName - the name of the IProxy instance you're looking for.
Returns bool - whether an IProxy is currently registered with the given proxyName.

bool hasProxy( String proxyName )
{
  return proxyMap[ proxyName ] != null;
}

Code void initializeModel() #

Initialize the IModel instance.

Called automatically by the constructor, this is your opportunity to initialize the Singleton instance in your subclass without overriding the constructor.

void initializeModel(  ){ }

Code void registerProxy(IProxy proxy) #

Param proxy - an object reference to be held by the IModel.

void registerProxy( IProxy proxy )
{
  proxy.initializeNotifier( multitonKey );
  proxyMap[ proxy.getName() ] = proxy;
  proxy.onRegister();
}

Code IProxy removeProxy(String proxyName) #

Remove an IProxy instance from the IModel.

Param proxyName - name of the IProxy instance to be removed.
Returns IProxy - the IProxy that was removed from the IModel.

IProxy removeProxy( String proxyName )
{
  IProxy proxy = proxyMap[ proxyName ];
  if ( proxy != null ) 
  {
    proxyMap[ proxyName ] = null;
    proxy.onRemove();
  }
  return proxy;
}

Code IProxy retrieveProxy(String proxyName) #

Retrieve an IProxy instance from the IModel.

Param proxyName - the name of the IProxy instance to retrieve.
Returns the IProxy instance previously registered with the given proxyName.

IProxy retrieveProxy( String proxyName )
{
  return proxyMap[ proxyName ];
}

Fields

Code String multitonKey #

String multitonKey;

Code Map<String, IProxy> proxyMap #

Map<String,IProxy> proxyMap;