PhoneBook Manager App
CodeName: PB-Man ,pbman,PB-App etc (For reference in the document only)
Proposed App name: People’s Book = xPB
Features and Functionality
The main features of the app are divided into following category:
- Phonebook Database/Storage : CRUD
- Interfaces:Import/Export Database Various Formats
- Settings for App,database backup and sync options
First of all ,defining database / needs of a contact information
Database
Database Usage
- NumberType and InfoType
These two tables contains fixed values to be used to identify number type (I.e Mobile,Work etc) and contact info (i.e. Email,Facebook ID,website etc). - Contact
Contact is a main entry to the app . A contact have Name and LastName(optional) field with a optional Photo. Photo is stored in the database.Using BytesArray(Blob) or Base64 code(Text). Then Contact is added with multiple Number and Info - Number and Info
The number and Info entries are created when adding new to the contact. - Group
Group is created and then contacts ID are added to the GroupContact table.
Interfaces
The import and export of contacts are required for multiple formats. These formats include the essential interfaces of PB-App specific format which is used to backup and restore the application specific contacts data.
Also for Nokia contacts files VCF and Android vcf file which contains multiple contacts vcf in a single file.
Optionally , future implementation of Android native Contacts import/export using ANE (Air Native Extension).
So all these interface should have a common interface and separate implementations.
Like NokiaImport,will implement “IImportInterface “ and will do the logic for handling Nokia VCF file
Possible Interfaces
IImport
selectSource(done:Function):void
read(done:Function):void
result():Vector<VO>
IExport
inputList(Vector<VO>):void
read(done:Function):void
export(done:Function):void
Settings
The app settings include following features:
Selecting DataBase type (SQLite or XML)
Selecting Database source file
Exporting Database File (Save As)
Export Phonebook Options
Merging Database(XML and SQLite) *Optional
Presentation Layer
In this section , I will be trying to generally define every view required for the app features just discussed. These views are provided with the data to be displayed/presented. Robotlegs v2.1.0 will be powering the application , so all views will be mediated. But the mediation should be same for different Views layer (Starling or Flex Components).
Application’s Main Views In General
Main View
Contacts View
Import Export View
Settings View
About View
Main View
Provides Navigation to Contacts,Import Export,settings and About View . Also it will provide methods to load other main views I.e. to show Contact,Settings views etc. All the screen size events etc are handled in View layer and is managed in Main View
Contacts Views
Have ContactList as root view and then sub views as following
Contacts List
Single Contact View
Single Contact Edit
Add Photo
Add Number
Add Info
Adding to Groups
Import/Export View
Provides available Import/export options. The Sub views are as following , (first being the root(starting) view)
Select import or Export
Select Interface from available list (e.g Noki,Android and PB-APP )
Interface View
Done View
Settings View
Settings provide views for app settings as discussed in features. The starting view gives navigation to sub views.
The Data base type and database source settings are dependent hence on same view
Settings Main
DataBase Settings
Backup Restore
Export Phonebook Options
Is Photo exported
Export All Numbers under Same Name or not (e.g Jake Phill 1,Jack Phil 2 etc)
Merge Options
Select Source Type
Select Source File
About View
Single view to represent the app info,logo and author info.
Common Events
There will be a Application Framework (RL2) events and there will be a separate event package only for Views and their Mediators.These events will be mainly triggered on Views and mediators will handle them. Mediator should be using Views API to hook data into views. So a seprate package of AppViews Event will be defined. These Events will be flash.events.* and as Starling has its own Event package, there may be need to [Inject] IEventDispatcher within starling with , but it will not be the case with flex views.
AVEvent
AVEvent (App Views Event) class will be used for View to Mediator communication. It will contain meaning full names for Event Type and should be used in flex views. From now on I will define AVEvent.SOME_TYPE as will be discussing Views API.
Views Api
To be able to implement different presentation layer for the app , with all the same core functionality , these views needs to implement some common interface. There will be a common Events and Event Names to bridge Views and Logic layers ie AVEvent.
All views have constant names to be referenced. These will be stored as constant strings in AppViews class.
Contacts Views Api
The main or root ContactsView will be responsible to switch between contacts sub views. The name property refer to AppViews.SOME_VIEW property.
Name= AppViews.CONTACTS_ROOT
gotoView(name:String):void
Main List
Name
AppViews.MAIN_LIST
Events
AVEvents.MAIN_CONTACTS_SELECTED
AVEvents.MAIN_IMPORT_EXPORT_SELECTED
AVEvents.MAIN_SETTINGS_SELECTED
AVEvents.MAIN_ABOUT_SELECTED
Contact List View
Name:
AppViews.CONTACT_LIST
Methods
setDataprovider(list:Vector<VO>):void
setSearchTypes(list:Vector.<String>):void;
Events
AVEvent.CLIST_SELECTED (data:selectedContactVO)
AVEvent.CLIST_SEARCHED (data:{type,query,options});
AVEvent.CLIST_DELETE_SINGLE (data:selectefContactVO)
AVEvent.CLIST_DELETE_MULTIPLE (data:Vector<ContactVO>)
AVEvent.CLIST_ADD_NEW
This will load the Contact Single View with initial dummy data
Contact Single View
Name
AppViews.CONTACT_SINGLE
Methods
setDataprovider(obj:ContactVO):void
gotoView(name:String):void
dispose():void
Events
AVEvent.CSINGLE_EDIT (data=selected:ContactVO)
AVEvent.CSINGLE_DELETE
Contact Single Edit
Name
AppViews.CONTACT_EDIT
Methods
setDataprovider(obj:ContactVO):voi
gotoView(name:String):void
dispose():void
Events
AVEvent.CSEDIT_SAVE