appjam 0.1.0.pre4

data/lib/appjam/generators/Classes/org/puremvc/objectivec/interfaces/IMediator.h

@@ -0,0 +1,84 @@
+#import "INotification.h"
+/**
+ * The interface definition for a PureMVC Mediator.
+ *
+ * <P>
+ * In PureMVC, <code>IMediator</code> implementors assume these responsibilities:</P>
+ * <UL>
+ * <LI>Implement a common method which returns a list of all <code>INotification</code>s 
+ * the <code>IMediator</code> has interest in.</LI>
+ * <LI>Implement a notification callback method.</LI>
+ * <LI>Implement methods that are called when the IMediator is registered or removed from the View.</LI>
+ * </UL>
+ * <P>
+ * Additionally, <code>IMediator</code>s typically:
+ * <UL>
+ * <LI>Act as an intermediary between one or more view components such as text boxes or 
+ * list controls, maintaining references and coordinating their behavior.</LI>
+ * <LI>Respond to and generate <code>INotifications</code>, interacting with of 
+ * the rest of the PureMVC app.
+ * </UL></P>
+ * <P>
+ * When an <code>IMediator</code> is registered with the <code>IView</code>, 
+ * the <code>IView</code> will call the <code>IMediator</code>'s 
+ * <code>listNotificationInterests</code> method. The <code>IMediator</code> will 
+ * return an <code>Array</code> of <code>INotification</code> names which 
+ * it wishes to be notified about.</P>
+ * 
+ * <P>
+ * The <code>IView</code> will then create an <code>Observer</code> object 
+ * encapsulating that <code>IMediator</code>'s (<code>handleNotification</code>) method
+ * and register it as an Observer for each <code>INotification</code> name returned by 
+ * <code>listNotificationInterests</code>.</P>
+ * 
+ * @see INotification
+ */
+@protocol IMediator
+
+/**
+ * Get the <code>IMediator</code> instance name
+ * 
+ * @return the <code>IMediator</code> instance name
+ */
+-(NSString *)mediatorName;
+
+/**
+ * Get the <code>IMediator</code>'s view component.
+ * 
+ * @return id the view component
+ */
+-(id)viewComponent;
+
+/**
+ * Handle an <code>INotification</code>.
+ * 
+ * @param notification the <code>INotification</code> to be handled
+ */
+-(void)handleNotification:(id<INotification>)notification;
+
+/**
+ * List <code>INotification</code> interests.
+ * 
+ * @return an <code>Array</code> of the <code>INotification</code> names this <code>IMediator</code> has an interest in.
+ */
+-(NSArray *)listNotificationInterests;
+
+/**
+ * Called by the View when the Mediator is registered
+ */ 
+-(void)onRegister;
+
+/**
+ * Called by the View when the Mediator is removed
+ */ 
+-(void)onRemove;
+
+/**
+ * Set the <code>IMediator</code>'s view component.
+ * 
+ * @param viewComponent the view component
+ */
+-(void)setViewComponent:(id)viewComponent;
+
+@end
+

data/lib/appjam/generators/Classes/org/puremvc/objectivec/interfaces/IModel.h

@@ -0,0 +1,50 @@
+#import "IProxy.h"
+/**
+ * The interface definition for a PureMVC Model.
+ * 
+ * <P>
+ * In PureMVC, <code>IModel</code> implementors provide
+ * access to <code>IProxy</code> objects by named lookup. </P>
+ * 
+ * <P>
+ * An <code>IModel</code> assumes these responsibilities:</P>
+ * 
+ * <UL>
+ * <LI>Maintain a cache of <code>IProxy</code> instances</LI>
+ * <LI>Provide methods for registering, retrieving, and removing <code>IProxy</code> instances</LI>
+ * </UL>
+ */
+@protocol IModel
+
+/**
+ * Check if a Proxy is registered
+ * 
+ * @param proxyName
+ * @return whether a Proxy is currently registered with the given <code>proxyName</code>.
+ */
+-(BOOL)hasProxy:(NSString *)proxyName;
+
+/**
+ * Register an <code>IProxy</code> instance with the <code>Model</code>.
+ * 
+ * @param proxy an object reference to be held by the <code>Model</code>.
+ */
+-(void)registerProxy:(id<IProxy>)proxy;
+
+/**
+ * Remove an <code>IProxy</code> instance from the Model.
+ * 
+ * @param proxyName name of the <code>IProxy</code> instance to be removed.
+ * @return the <code>IProxy</code> that was removed from the <code>Model</code>
+ */
+-(id<IProxy>)removeProxy:(NSString *)proxyName;
+
+/**
+ * Retrieve an <code>IProxy</code> instance from the Model.
+ * 
+ * @param proxyName
+ * @return the <code>IProxy</code> instance previously registered with the given <code>proxyName</code>.
+ */
+-(id<IProxy>)retrieveProxy:(NSString *)proxyName;
+
+@end

data/lib/appjam/generators/Classes/org/puremvc/objectivec/interfaces/INotification.h

@@ -0,0 +1,57 @@
+/**
+ * The interface definition for a PureMVC Notification.
+ *
+ * <P>
+ * PureMVC does not rely upon underlying event models such 
+ * as the one provided with in AppKit or UIKit</P>
+ * 
+ * <P>
+ * The Observer Pattern as implemented within PureMVC exists 
+ * to support event-driven communication between the 
+ * application and the actors of the MVC triad.</P>
+ * 
+ * <P>
+ * Notifications are not meant to be a replacement for Events
+ * in AppKit or UIKit. Generally, <code>IMediator</code> implementors
+ * place event listeners on their view components, which they
+ * then handle in the usual way. This may lead to the broadcast of <code>Notification</code>s to 
+ * trigger <code>ICommand</code>s or to communicate with other <code>IMediators</code>. <code>IProxy</code> and <code>ICommand</code>
+ * instances communicate with each other and <code>IMediator</code>s 
+ * by broadcasting <code>INotification</code>s.</P>
+ * 
+ * @see IView, IObserver
+ */
+@protocol INotification
+
+/**
+ * Get the body of the <code>INotification</code> instance
+ */
+-(id)body;
+
+/**
+ * Get the name of the <code>INotification</code> instance. 
+ * No setter, should be set by constructor only
+ */
+-(NSString *)name;
+
+/**
+ * Get the type of the <code>INotification</code> instance
+ */
+-(NSString *)type;
+
+/**
+ * Set the body of the <code>INotification</code> instance
+ */
+-(void)setBody:(id)body;
+
+/**
+ * Set the type of the <code>INotification</code> instance
+ */
+-(void)setType:(NSString *)type;
+
+/**
+ * Get the string representation of the <code>INotification</code> instance
+ */
+-(NSString *)description;
+
+@end

data/lib/appjam/generators/Classes/org/puremvc/objectivec/interfaces/INotifier.h

@@ -0,0 +1,41 @@
+/**
+ * The interface definition for a PureMVC Notifier.
+ * 
+ * <P>
+ * <code>MacroCommand, Command, Mediator</code> and <code>Proxy</code>
+ * all have a need to send <code>Notifications</code>. </P>
+ * 
+ * <P>
+ * The <code>INotifier</code> interface provides a common method called
+ * <code>sendNotification</code> that relieves implementation code of 
+ * the necessity to actually construct <code>Notifications</code>.</P>
+ * 
+ * <P>
+ * The <code>Notifier</code> class, which all of the above mentioned classes
+ * extend, also provides an initialized reference to the <code>Facade</code>
+ * Singleton, which is required for the convienience method
+ * for sending <code>Notifications</code>, but also eases implementation as these
+ * classes have frequent <code>Facade</code> interactions and usually require
+ * access to the facade anyway.</P>
+ * 
+ * @see IFacade, INotification
+ */
+@protocol INotifier
+
+/**
+ * Send a <code>INotification</code>.
+ * 
+ * <P>
+ * Convenience method to prevent having to construct new 
+ * notification instances in our implementation code.</P>
+ * 
+ * @param notificationName the name of the notification to send
+ * @param body the body of the notification
+ * @param type the type of the notification
+ */ 
+-(void)sendNotification:(NSString *)notificationName body:(id)body type:(NSString *)type;
+-(void)sendNotification:(NSString *)notificationName;
+-(void)sendNotification:(NSString *)notificationName body:(id)body;
+-(void)sendNotification:(NSString *)notificationName type:(NSString *)type;
+
+@end

data/lib/appjam/generators/Classes/org/puremvc/objectivec/interfaces/IObserver.h

@@ -0,0 +1,67 @@
+#import "INotification.h"
+/**
+ * The interface definition for a PureMVC Observer.
+ *
+ * <P>
+ * In PureMVC, <code>IObserver</code> implementors assume these responsibilities:
+ * <UL>
+ * <LI>Encapsulate the notification (callback) method of the interested object.</LI>
+ * <LI>Encapsulate the notification context (this) of the interested object.</LI>
+ * <LI>Provide methods for setting the interested object' notification method and context.</LI>
+ * <LI>Provide a method for notifying the interested object.</LI>
+ * </UL>
+ * 
+ * <P>
+ * The Observer Pattern as implemented within
+ * PureMVC exists to support event driven communication
+ * between the application and the actors of the
+ * MVC triad.</P>
+ * 
+ * <P> 
+ * An Observer is an object that encapsulates information
+ * about an interested object with a notification method that
+ * should be called when an </code>INotification</code> is broadcast. The Observer then
+ * acts as a proxy for notifying the interested object.
+ * 
+ * <P>
+ * Observers can receive <code>Notification</code>s by having their
+ * <code>notifyObserver</code> method invoked, passing
+ * in an object implementing the <code>INotification</code> interface, such
+ * as a subclass of <code>Notification</code>.</P>
+ * 
+ * @see IView, INotification
+ */
+@protocol IObserver
+
+/**
+ * Compare the given object to the notificaiton context object.
+ * 
+ * @param object the object to compare.
+ * @return boolean indicating if the notification context and the object are the same.
+ */
+-(BOOL)compareNotifyContext:(id)object;
+
+/**
+ * Notify the interested object.
+ * 
+ * @param notification the <code>INotification</code> to pass to the interested object's notification method
+ */
+-(void)notifyObserver:(id<INotification>)notification;
+
+/**
+ * Set the notification context.
+ * 
+ * @param notifyContext the notification context (self) of the interested object
+ */
+-(void)setNotifyContext:(id)notifyContext;
+
+/**
+ * Set the notification method.
+ * 
+ * <P>
+ * The notification method should take one parameter of type <code>INotification</code></P>
+ * 
+ * @param notifyMethod the notification (callback) selector of the interested object
+ */
+-(void)setNotifyMethod:(SEL)notifyMethod;
+@end

data/lib/appjam/generators/Classes/org/puremvc/objectivec/interfaces/IProxy.h

@@ -0,0 +1,53 @@
+/**
+ * The interface definition for a PureMVC Proxy.
+ *
+ * <P>
+ * In PureMVC, <code>IProxy</code> implementors assume these responsibilities:</P>
+ * <UL>
+ * <LI>Implement a common method which returns the name of the Proxy.</LI>
+ * <LI>Provide methods for setting and getting the data object.</LI>
+ * </UL>
+ * <P>
+ * Additionally, <code>IProxy</code>s typically:</P>
+ * <UL>
+ * <LI>Maintain references to one or more pieces of model data.</LI>
+ * <LI>Provide methods for manipulating that data.</LI>
+ * <LI>Generate <code>INotifications</code> when their model data changes.</LI>
+ * <LI>Expose their name as a <code>static method</code> called <code>NAME</code>, if they are not instantiated multiple times.</LI>
+ * <LI>Encapsulate interaction with local or remote services used to fetch and persist model data.</LI>
+ * </UL>
+ */
+@protocol IProxy
+
+/**
+ * Get the data object
+ * 
+ * @return the data as type id
+ */
+-(id)data;
+
+/**
+ * Get the Proxy name
+ * 
+ * @return the Proxy instance name
+ */
+-(NSString *)proxyName;
+
+/**
+ * Called by the Model when the Proxy is registered
+ */
+-(void)onRegister;
+
+/**
+ * Called by the Model when the Proxy is removed
+ */ 
+-(void)onRemove;
+
+/**
+ * Set the data object
+ * 
+ * @param data the data object
+ */
+-(void)setData:(id)data;
+
+@end

data/lib/appjam/generators/Classes/org/puremvc/objectivec/interfaces/IView.h

@@ -0,0 +1,96 @@
+#import "INotification.h"
+#import "IMediator.h"
+#import "IObserver.h"
+/**
+ * The interface definition for a PureMVC View.
+ * 
+ * <P>
+ * In PureMVC, <code>IView</code> implementors assume these responsibilities:</P>
+ * 
+ * <P>
+ * In PureMVC, the <code>View</code> class assumes these responsibilities:
+ * <UL>
+ * <LI>Maintain a cache of <code>IMediator</code> instances.</LI>
+ * <LI>Provide methods for registering, retrieving, and removing <code>IMediators</code>.</LI>
+ * <LI>Managing the observer lists for each <code>INotification</code> in the application.</LI>
+ * <LI>Providing a method for attaching <code>IObservers</code> to an <code>INotification</code>'s observer list.</LI>
+ * <LI>Providing a method for broadcasting an <code>INotification</code>.</LI>
+ * <LI>Notifying the <code>IObservers</code> of a given <code>INotification</code> when it broadcast.</LI>
+ * </UL>
+ * 
+ * @see IMediator, IObserver, INotification
+ */
+@protocol IView
+
+/**
+ * Check if a Mediator is registered or not
+ * 
+ * @param mediatorName
+ * @return whether a Mediator is registered with the given <code>mediatorName</code>.
+ */
+-(BOOL)hasMediator:(NSString *)mediatorName;
+
+/**
+ * Notify the <code>IObservers</code> for a particular <code>INotification</code>.
+ * 
+ * <P>
+ * All previously attached <code>IObservers</code> for this <code>INotification</code>'s
+ * list are notified and are passed a reference to the <code>INotification</code> in 
+ * the order in which they were registered.</P>
+ * 
+ * @param notification the <code>INotification</code> to notify <code>IObservers</code> of.
+ */
+-(void)notifyObservers:(id<INotification>)notification;
+
+/**
+ * Register an <code>IMediator</code> instance with the <code>View</code>.
+ * 
+ * <P>
+ * Registers the <code>IMediator</code> so that it can be retrieved by name,
+ * and further interrogates the <code>IMediator</code> for its 
+ * <code>INotification</code> interests.</P>
+ * <P>
+ * If the <code>IMediator</code> returns any <code>INotification</code> 
+ * names to be notified about, an <code>Observer</code> is created encapsulating 
+ * the <code>IMediator</code> instance's <code>handleNotification</code> method 
+ * and registering it as an <code>Observer</code> for all <code>INotifications</code> the 
+ * <code>IMediator</code> is interested in.</p>
+ *
+ * @param mediator a reference to the <code>IMediator</code> instance
+ */
+-(void)registerMediator:(id<IMediator>)mediator;
+
+/**
+ * Register an <code>IObserver</code> to be notified
+ * of <code>INotifications</code> with a given name.
+ * 
+ * @param notificationName the name of the <code>INotifications</code> to notify this <code>IObserver</code> of
+ * @param observer the <code>IObserver</code> to register
+ */
+-(void)registerObserver:(NSString *)notificationName observer:(id<IObserver>)observer;
+
+/**
+ * Remove an <code>IMediator</code> from the <code>View</code>.
+ * 
+ * @param mediatorName name of the <code>IMediator</code> instance to be removed.
+ * @return the <code>IMediator</code> that was removed from the <code>View</code>
+ */
+-(id<IMediator>)removeMediator:(NSString *)mediatorName;
+
+/**
+ * Remove a group of observers from the observer list for a given Notification name.
+ * <P>
+ * @param notificationName which observer list to remove from 
+ * @param notifyContext removed the observers with this object as their notifyContext
+ */
+-(void)removeObserver:(NSString *)notificationName notifyContext:(id)notifyContext;
+
+/**
+ * Retrieve an <code>IMediator</code> from the <code>View</code>.
+ * 
+ * @param mediatorName the name of the <code>IMediator</code> instance to retrieve.
+ * @return the <code>IMediator</code> instance previously registered with the given <code>mediatorName</code>.
+ */
+-(id<IMediator>)retrieveMediator:(NSString *)mediatorName;
+
+@end